IO-94 - MockInputStream/MockReader

git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/io/trunk@462847 13f79535-47bb-0310-9956-ffa450edef68

Author: Stephen Colebourne

src/java/org/apache/commons/io/input/MockInputStream.java

@@ -38,7 +38,6 @@
  * <code>processBytes()</code> methods can be implemented to generate
  * test data.
  *
- *
  * @since Commons IO 1.3
  * @version $Revision$
  */
@@ -53,7 +52,8 @@ public class MockInputStream extends InputStream {
     private boolean markSupported;
 
     /**
-     * Create a mock {@link InputStream} of the specified size.
+     * Create a mock {@link InputStream} of the specified size
+     * which supports marking and does not throw EOFException.
      *
      * @param size The size of the mock input stream.
      */
@@ -113,7 +113,7 @@ public int available() {
     }
 
     /**
-     * Close this inputstream - resets the internal state to
+     * Close this input stream - resets the internal state to
      * the initial values.
      *
      * @throws IOException If an error occurs.
@@ -268,27 +268,27 @@ public long skip(long numberOfBytes) throws IOException {
     /**
      * Return a byte value for the  <code>read()</code> method.
      * <p>
-     * <strong>N.B.</strong> This implementation returns
-     * zero.
+     * This implementation returns zero.
      *
      * @return This implementation always returns zero.
      */
     protected int processByte() {
+        // do nothing - overridable by subclass
         return 0;
     }
 
     /**
      * Process the bytes for the <code>read(byte[], offset, length)</code>
      * method.
      * <p>
-     * <strong>N.B.</strong> This implementation leaves the byte
-     * array unchanged.
+     * This implementation leaves the byte array unchanged.
      *
      * @param bytes The byte array
      * @param offset The offset to start at.
      * @param length The number of bytes.
      */
     protected void processBytes(byte[] bytes, int offset, int length) {
+        // do nothing - overridable by subclass
     }
 
     /**
@@ -306,4 +306,5 @@ private int doEndOfFile() throws EOFException {
         }
         return -1;
     }
+
 }

src/java/org/apache/commons/io/input/MockReader.java

@@ -38,7 +38,6 @@
  * <code>processChars()</code> methods can be implemented to generate
  * test data.
  *
- *
  * @since Commons IO 1.3
  * @version $Revision$
  */
@@ -53,7 +52,8 @@ public class MockReader extends Reader {
     private boolean markSupported;
 
     /**
-     * Create a mock {@link Reader} of the specified size.
+     * Create a mock {@link Reader} of the specified size
+     * which supports marking and does not throw EOFException.
      *
      * @param size The size of the mock Reader.
      */
@@ -252,27 +252,27 @@ public long skip(long numberOfChars) throws IOException {
     /**
      * Return a character value for the  <code>read()</code> method.
      * <p>
-     * <strong>N.B.</strong> This implementation returns
-     * zero.
+     * This implementation returns zero.
      *
      * @return This implementation always returns zero.
      */
     protected int processChar() {
+        // do nothing - overridable by subclass
         return 0;
     }
 
     /**
      * Process the characters for the <code>read(char[], offset, length)</code>
      * method.
      * <p>
-     * <strong>N.B.</strong> This implementation leaves the character
-     * array unchanged.
+     * This implementation leaves the character array unchanged.
      *
      * @param chars The character array
      * @param offset The offset to start at.
      * @param length The number of characters.
      */
     protected void processChars(char[] chars, int offset, int length) {
+        // do nothing - overridable by subclass
     }
 
     /**
@@ -290,4 +290,5 @@ private int doEndOfFile() throws EOFException {
         }
         return -1;
     }
+
 }

src/test/org/apache/commons/io/input/MockInputStreamTestCase.java

@@ -214,7 +214,6 @@ public void testMarkNotSupported() throws Exception {
      * Test <code>skip()</code> method.
      */
    public void testSkip() throws Exception {
-        int skip = 20;
         InputStream input = new TestMockInputStream(10, true, false);
         assertEquals("Read 1", 0, input.read());
         assertEquals("Read 2", 1, input.read());

src/test/org/apache/commons/io/input/MockReaderTestCase.java

@@ -211,7 +211,6 @@ public void testMarkNotSupported() throws Exception {
      * Test <code>skip()</code> method.
      */
    public void testSkip() throws Exception {
-        int skip = 20;
         Reader reader = new TestMockReader(10, true, false);
         assertEquals("Read 1", 0, reader.read());
         assertEquals("Read 2", 1, reader.read());

src/test/org/apache/commons/io/input/PackageTestSuite.java

@@ -35,6 +35,8 @@ public static Test suite() {
         TestSuite suite = new TestSuite("IO Utilities - input");
         suite.addTest(new TestSuite(ClassLoaderObjectInputStreamTest.class));
         suite.addTest(new TestSuite(CountingInputStreamTest.class));
+        suite.addTest(new TestSuite(MockInputStreamTestCase.class));
+        suite.addTest(new TestSuite(MockReaderTestCase.class));
         suite.addTest(new TestSuite(SwappedDataInputStreamTest.class));
         return suite;
     }