add Reader/CharIterator adapters and tests

git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/collections/trunk@131019 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Rodney Waldhoff 2003-04-16 19:45:13 +00:00
parent a17d133bb2
commit 6a5cf652be
5 changed files with 491 additions and 2 deletions

View File

@ -0,0 +1,98 @@
/*
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/primitives/adapters/io/Attic/CharIteratorReader.java,v 1.1 2003/04/16 19:45:13 rwaldhoff Exp $
* ====================================================================
* The Apache Software License, Version 1.1
*
* Copyright (c) 2003 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution, if
* any, must include the following acknowledgment:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
*
* 4. The names "The Jakarta Project", "Commons", and "Apache Software
* Foundation" must not be used to endorse or promote products derived
* from this software without prior written permission. For written
* permission, please contact apache@apache.org.
*
* 5. Products derived from this software may not be called "Apache"
* nor may "Apache" appear in their names without prior written
* permission of the Apache Software Foundation.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*
*/
package org.apache.commons.collections.primitives.adapters.io;
import java.io.Reader;
import org.apache.commons.collections.primitives.CharIterator;
/**
* Adapts a {@link CharIterator} to the {@link Reader} interface.
*
* @version $Revision: 1.1 $ $Date: 2003/04/16 19:45:13 $
* @author Rodney Waldhoff
*/
public class CharIteratorReader extends Reader {
public CharIteratorReader(CharIterator in) {
this.iterator= in;
}
public int read(char[] buf, int off, int len) {
if(iterator.hasNext()) {
int count = 0;
while(iterator.hasNext() && count < len) {
buf[off + count] = iterator.next();
count++;
}
return count;
} else {
return -1;
}
}
public void close() {
}
public static Reader adapt(CharIterator in) {
return null == in ? null : new CharIteratorReader(in);
}
private CharIterator iterator = null;
}

View File

@ -0,0 +1,126 @@
/*
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/primitives/adapters/io/Attic/ReaderCharIterator.java,v 1.1 2003/04/16 19:45:13 rwaldhoff Exp $
* ====================================================================
* The Apache Software License, Version 1.1
*
* Copyright (c) 2003 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution, if
* any, must include the following acknowledgment:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
*
* 4. The names "The Jakarta Project", "Commons", and "Apache Software
* Foundation" must not be used to endorse or promote products derived
* from this software without prior written permission. For written
* permission, please contact apache@apache.org.
*
* 5. Products derived from this software may not be called "Apache"
* nor may "Apache" appear in their names without prior written
* permission of the Apache Software Foundation.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*
*/
package org.apache.commons.collections.primitives.adapters.io;
import java.io.IOException;
import java.io.Reader;
import java.util.NoSuchElementException;
import org.apache.commons.collections.primitives.CharIterator;
/**
* Adapts a {@link Reader} to the {@link CharIterator} interface.
*
* @version $Revision: 1.1 $ $Date: 2003/04/16 19:45:13 $
* @author Rodney Waldhoff
*/
public class ReaderCharIterator implements CharIterator {
public ReaderCharIterator(Reader in) {
this.reader = in;
}
public static CharIterator adapt(Reader in) {
return null == in ? null : new ReaderCharIterator(in);
}
public boolean hasNext() {
ensureNextAvailable();
return (-1 != next);
}
public char next() {
if(!hasNext()) {
throw new NoSuchElementException("No next element");
} else {
nextAvailable = false;
return (char)next;
}
}
/**
* Not supported.
* @throws UnsupportedOperationException
*/
public void remove() throws UnsupportedOperationException {
throw new UnsupportedOperationException("remove() is not supported here");
}
private void ensureNextAvailable() {
if(!nextAvailable) {
readNext();
}
}
private void readNext() {
try {
next = reader.read();
nextAvailable = true;
} catch(IOException e) {
// TODO: Fix me using tunneled exception, see
// http://radio.weblogs.com/0122027/2003/04/01.html#a7
// for example
throw new RuntimeException(e.toString());
}
}
private Reader reader = null;
private boolean nextAvailable = false;
private int next;
}

View File

@ -1,5 +1,5 @@
/*
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/test/org/apache/commons/collections/primitives/adapters/io/Attic/TestAll.java,v 1.2 2003/04/15 17:09:14 rwaldhoff Exp $
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/test/org/apache/commons/collections/primitives/adapters/io/Attic/TestAll.java,v 1.3 2003/04/16 19:45:13 rwaldhoff Exp $
* ====================================================================
* The Apache Software License, Version 1.1
*
@ -62,7 +62,7 @@ import junit.framework.TestCase;
import junit.framework.TestSuite;
/**
* @version $Revision: 1.2 $ $Date: 2003/04/15 17:09:14 $
* @version $Revision: 1.3 $ $Date: 2003/04/16 19:45:13 $
* @author Rodney Waldhoff
*/
public class TestAll extends TestCase {
@ -76,6 +76,9 @@ public class TestAll extends TestCase {
suite.addTest(TestInputStreamByteIterator.suite());
suite.addTest(TestByteIteratorInputStream.suite());
suite.addTest(TestReaderCharIterator.suite());
suite.addTest(TestCharIteratorReader.suite());
return suite;
}
}

View File

@ -0,0 +1,122 @@
/*
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/test/org/apache/commons/collections/primitives/adapters/io/Attic/TestCharIteratorReader.java,v 1.1 2003/04/16 19:45:13 rwaldhoff Exp $
* ====================================================================
* The Apache Software License, Version 1.1
*
* Copyright (c) 2002-2003 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution, if
* any, must include the following acknowledgment:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
*
* 4. The names "The Jakarta Project", "Commons", and "Apache Software
* Foundation" must not be used to endorse or promote products derived
* from this software without prior written permission. For written
* permission, please contact apache@apache.org.
*
* 5. Products derived from this software may not be called "Apache"
* nor may "Apache" appear in their names without prior written
* permission of the Apache Software Foundation.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*
*/
package org.apache.commons.collections.primitives.adapters.io;
import java.io.Reader;
import junit.framework.Test;
import junit.framework.TestCase;
import junit.framework.TestSuite;
import org.apache.commons.collections.primitives.ArrayCharList;
import org.apache.commons.collections.primitives.CharList;
/**
* @version $Revision: 1.1 $ $Date: 2003/04/16 19:45:13 $
* @author Rodney Waldhoff
*/
public class TestCharIteratorReader extends TestCase {
// conventional
// ------------------------------------------------------------------------
public TestCharIteratorReader(String testName) {
super(testName);
}
public static Test suite() {
return new TestSuite(TestCharIteratorReader.class);
}
// ------------------------------------------------------------------------
// ------------------------------------------------------------------------
public void testReadNonEmpty() throws Exception {
String str = "The quick brown fox jumped over the lazy dogs.";
CharList list = new ArrayCharList();
for(int i = 0; i < str.length(); i++) {
list.add(str.charAt(i));
}
Reader in = new CharIteratorReader(list.iterator());
for(int i = 0; i < str.length(); i++) {
assertEquals(str.charAt(i),in.read());
}
assertEquals(-1,in.read());
assertEquals(-1,in.read());
}
public void testReadEmpty() throws Exception {
CharList list = new ArrayCharList();
Reader in = new CharIteratorReader(list.iterator());
assertEquals(-1,in.read());
assertEquals(-1,in.read());
}
public void testAdaptNull() {
assertNull(CharIteratorReader.adapt(null));
}
public void testAdaptNonNull() {
assertNotNull(CharIteratorReader.adapt(new ArrayCharList().iterator()));
}
}

View File

@ -0,0 +1,140 @@
/*
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/test/org/apache/commons/collections/primitives/adapters/io/Attic/TestReaderCharIterator.java,v 1.1 2003/04/16 19:45:13 rwaldhoff Exp $
* ====================================================================
* The Apache Software License, Version 1.1
*
* Copyright (c) 2002-2003 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution, if
* any, must include the following acknowledgment:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
*
* 4. The names "The Jakarta Project", "Commons", and "Apache Software
* Foundation" must not be used to endorse or promote products derived
* from this software without prior written permission. For written
* permission, please contact apache@apache.org.
*
* 5. Products derived from this software may not be called "Apache"
* nor may "Apache" appear in their names without prior written
* permission of the Apache Software Foundation.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*
*/
package org.apache.commons.collections.primitives.adapters.io;
import java.io.IOException;
import java.io.Reader;
import java.io.StringReader;
import junit.framework.Test;
import junit.framework.TestSuite;
import org.apache.commons.collections.primitives.CharIterator;
import org.apache.commons.collections.primitives.TestCharIterator;
/**
* @version $Revision: 1.1 $ $Date: 2003/04/16 19:45:13 $
* @author Rodney Waldhoff
*/
public class TestReaderCharIterator extends TestCharIterator {
// conventional
// ------------------------------------------------------------------------
public TestReaderCharIterator(String testName) {
super(testName);
}
public static Test suite() {
return new TestSuite(TestReaderCharIterator.class);
}
// ------------------------------------------------------------------------
public boolean supportsRemove() {
return false;
}
protected CharIterator makeEmptyCharIterator() {
return new ReaderCharIterator(new StringReader(""));
}
protected CharIterator makeFullCharIterator() {
return new ReaderCharIterator(new StringReader(new String(getFullElements())));
}
protected char[] getFullElements() {
return "The quick brown fox jumped over the lazy dogs.".toCharArray();
}
// ------------------------------------------------------------------------
public void testErrorThrowingReader() {
Reader errReader = new Reader() {
public int read(char[] buf, int off, int len) throws IOException {
throw new IOException();
}
public void close() throws IOException {
}
};
CharIterator iter = new ReaderCharIterator(errReader);
try {
iter.hasNext();
fail("Expected RuntimeException");
} catch(RuntimeException e) {
// expected
}
try {
iter.next();
fail("Expected RuntimeException");
} catch(RuntimeException e) {
// expected
}
}
public void testAdaptNull() {
assertNull(ReaderCharIterator.adapt(null));
}
public void testAdaptNonNull() {
assertNotNull(ReaderCharIterator.adapt(new StringReader("")));
}
}