<action issue="IO-437" dev="ggregory" type="add">

garydgregory · garydgregory · commit 0986e7970561 · 2014-04-10T15:57:20.000Z
Make IOUtils.EOF public and reuse it in various classes. </action> git-svn-id: https://svn.apache.org/repos/asf/commons/proper/io/trunk@1586350 13f79535-47bb-0310-9956-ffa450edef68
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
@@ -188,6 +188,9 @@ The <action> type attribute can be add,update,fix,remove.
       <action issue="IO-436" dev="ggregory" type="fix" due-to="christoph.schneegans">
         Improper JavaDoc comment for FilenameUtils.indexOfExtension.
       </action>            
+      <action issue="IO-437" dev="ggregory" type="add">
+        Make IOUtils.EOF public and reuse it in various classes.
+      </action>            
     </release>
     <!-- The release date is the date RC is cut -->
     <release version="2.4" date="2012-06-12" description="New features and bug fixes.">
diff --git a/src/main/java/org/apache/commons/io/EndianUtils.java b/src/main/java/org/apache/commons/io/EndianUtils.java
@@ -16,6 +16,8 @@
  */
 package org.apache.commons.io;
 
+import static org.apache.commons.io.IOUtils.EOF;
+
 import java.io.EOFException;
 import java.io.IOException;
 import java.io.InputStream;
@@ -479,7 +481,7 @@ private static int read(final InputStream input)
     {
         final int value = input.read();
 
-        if( -1 == value ) {
+        if( EOF == value ) {
             throw new EOFException( "Unexpected EOF reached" );
         }
 
diff --git a/src/main/java/org/apache/commons/io/input/AutoCloseInputStream.java b/src/main/java/org/apache/commons/io/input/AutoCloseInputStream.java
@@ -16,6 +16,8 @@
  */
 package org.apache.commons.io.input;
 
+import static org.apache.commons.io.IOUtils.EOF;
+
 import java.io.IOException;
 import java.io.InputStream;
 
@@ -73,7 +75,7 @@ public void close() throws IOException {
      */
     @Override
     protected void afterRead(final int n) throws IOException {
-        if (n == -1) {
+        if (n == EOF) {
             close();
         }
     }
diff --git a/src/main/java/org/apache/commons/io/input/CharSequenceInputStream.java b/src/main/java/org/apache/commons/io/input/CharSequenceInputStream.java
@@ -17,6 +17,8 @@
 
 package org.apache.commons.io.input;
 
+import static org.apache.commons.io.IOUtils.EOF;
+
 import java.io.IOException;
 import java.io.InputStream;
 import java.nio.ByteBuffer;
@@ -39,8 +41,6 @@ public class CharSequenceInputStream extends InputStream {
 
     private static final int BUFFER_SIZE = 2048;
 
-    private static final int EOS = -1;
-
     private static final int NO_MARK = -1;
 
     private final CharsetEncoder encoder;
@@ -139,7 +139,7 @@ public int read(final byte[] b, int off, int len) throws IOException {
             return 0; // must return 0 for zero length read
         }
         if (!this.bbuf.hasRemaining() && !this.cbuf.hasRemaining()) {
-            return EOS;
+            return EOF;
         }
         int bytesRead = 0;
         while (len > 0) {
@@ -156,7 +156,7 @@ public int read(final byte[] b, int off, int len) throws IOException {
                 }
             }
         }
-        return bytesRead == 0 && !this.cbuf.hasRemaining() ? EOS : bytesRead;
+        return bytesRead == 0 && !this.cbuf.hasRemaining() ? EOF : bytesRead;
     }
 
     @Override
@@ -167,7 +167,7 @@ public int read() throws IOException {
             } else {
                 fillBuffer();
                 if (!this.bbuf.hasRemaining() && !this.cbuf.hasRemaining()) {
-                    return EOS;
+                    return EOF;
                 }
             }
         }
diff --git a/src/main/java/org/apache/commons/io/input/CharSequenceReader.java b/src/main/java/org/apache/commons/io/input/CharSequenceReader.java
@@ -16,6 +16,8 @@
  */
 package org.apache.commons.io.input;
 
+import static org.apache.commons.io.IOUtils.EOF;
+
 import java.io.Reader;
 import java.io.Serializable;
 
@@ -81,7 +83,7 @@ public boolean markSupported() {
     @Override
     public int read() {
         if (idx >= charSequence.length()) {
-            return -1;
+            return EOF;
         } else {
             return charSequence.charAt(idx++);
         }
@@ -99,7 +101,7 @@ public int read() {
     @Override
     public int read(final char[] array, final int offset, final int length) {
         if (idx >= charSequence.length()) {
-            return -1;
+            return EOF;
         }
         if (array == null) {
             throw new NullPointerException("Character array is missing");
@@ -111,7 +113,7 @@ public int read(final char[] array, final int offset, final int length) {
         int count = 0;
         for (int i = 0; i < length; i++) {
             final int c = read();
-            if (c == -1) {
+            if (c == EOF) {
                 return count;
             }
             array[offset + i] = (char)c;
@@ -142,7 +144,7 @@ public long skip(final long n) {
                     "Number of characters to skip is less than zero: " + n);
         }
         if (idx >= charSequence.length()) {
-            return -1;
+            return EOF;
         }
         final int dest = (int)Math.min(charSequence.length(), idx + n);
         final int count = dest - idx;
diff --git a/src/main/java/org/apache/commons/io/input/ClosedInputStream.java b/src/main/java/org/apache/commons/io/input/ClosedInputStream.java
@@ -16,10 +16,12 @@
  */
 package org.apache.commons.io.input;
 
+import static org.apache.commons.io.IOUtils.EOF;
+
 import java.io.InputStream;
 
 /**
- * Closed input stream. This stream returns -1 to all attempts to read
+ * Closed input stream. This stream returns EOF to all attempts to read
  * something from the stream.
  * <p>
  * Typically uses of this class include testing for corner cases in methods
@@ -43,7 +45,7 @@ public class ClosedInputStream extends InputStream {
      */
     @Override
     public int read() {
-        return -1;
+        return EOF;
     }
 
 }
diff --git a/src/main/java/org/apache/commons/io/input/CountingInputStream.java b/src/main/java/org/apache/commons/io/input/CountingInputStream.java
@@ -16,6 +16,8 @@
  */
 package org.apache.commons.io.input;
 
+import static org.apache.commons.io.IOUtils.EOF;
+
 import java.io.IOException;
 import java.io.InputStream;
 
@@ -68,7 +70,7 @@ public synchronized long skip(final long length) throws IOException {
      */
     @Override
     protected synchronized void afterRead(final int n) {
-        if (n != -1) {
+        if (n != EOF) {
             this.count += n;
         }
     }
diff --git a/src/main/java/org/apache/commons/io/input/DemuxInputStream.java b/src/main/java/org/apache/commons/io/input/DemuxInputStream.java
@@ -16,6 +16,8 @@
  */
 package org.apache.commons.io.input;
 
+import static org.apache.commons.io.IOUtils.EOF;
+
 import java.io.IOException;
 import java.io.InputStream;
 
@@ -76,7 +78,7 @@ public int read()
         }
         else
         {
-            return -1;
+            return EOF;
         }
     }
 }
diff --git a/src/main/java/org/apache/commons/io/input/NullInputStream.java b/src/main/java/org/apache/commons/io/input/NullInputStream.java
@@ -16,6 +16,8 @@
  */
 package org.apache.commons.io.input;
 
+import static org.apache.commons.io.IOUtils.EOF;
+
 import java.io.EOFException;
 import java.io.IOException;
 import java.io.InputStream;
@@ -332,7 +334,7 @@ private int doEndOfFile() throws EOFException {
         if (throwEofException) {
             throw new EOFException();
         }
-        return -1;
+        return EOF;
     }
 
 }
diff --git a/src/main/java/org/apache/commons/io/input/NullReader.java b/src/main/java/org/apache/commons/io/input/NullReader.java
@@ -16,6 +16,8 @@
  */
 package org.apache.commons.io.input;
 
+import static org.apache.commons.io.IOUtils.EOF;
+
 import java.io.EOFException;
 import java.io.IOException;
 import java.io.Reader;
@@ -315,7 +317,7 @@ private int doEndOfFile() throws EOFException {
         if (throwEofException) {
             throw new EOFException();
         }
-        return -1;
+        return EOF;
     }
 
 }
diff --git a/src/main/java/org/apache/commons/io/input/ProxyInputStream.java b/src/main/java/org/apache/commons/io/input/ProxyInputStream.java
@@ -16,6 +16,8 @@
  */
 package org.apache.commons.io.input;
 
+import static org.apache.commons.io.IOUtils.EOF;
+
 import java.io.FilterInputStream;
 import java.io.IOException;
 import java.io.InputStream;
@@ -56,18 +58,18 @@ public int read() throws IOException {
         try {
             beforeRead(1);
             final int b = in.read();
-            afterRead(b != -1 ? 1 : -1);
+            afterRead(b != EOF ? 1 : EOF);
             return b;
         } catch (final IOException e) {
             handleIOException(e);
-            return -1;
+            return EOF;
         }
     }
 
     /**
      * Invokes the delegate's <code>read(byte[])</code> method.
      * @param bts the buffer to read the bytes into
-     * @return the number of bytes read or -1 if the end of stream
+     * @return the number of bytes read or EOF if the end of stream
      * @throws IOException if an I/O error occurs
      */
     @Override
@@ -79,7 +81,7 @@ public int read(final byte[] bts) throws IOException {
             return n;
         } catch (final IOException e) {
             handleIOException(e);
-            return -1;
+            return EOF;
         }
     }
 
@@ -100,7 +102,7 @@ public int read(final byte[] bts, final int off, final int len) throws IOExcepti
             return n;
         } catch (final IOException e) {
             handleIOException(e);
-            return -1;
+            return EOF;
         }
     }
 
diff --git a/src/main/java/org/apache/commons/io/input/ProxyReader.java b/src/main/java/org/apache/commons/io/input/ProxyReader.java
@@ -16,6 +16,8 @@
  */
 package org.apache.commons.io.input;
 
+import static org.apache.commons.io.IOUtils.EOF;
+
 import java.io.FilterReader;
 import java.io.IOException;
 import java.io.Reader;
@@ -54,11 +56,11 @@ public int read() throws IOException {
         try {
             beforeRead(1);
             final int c = in.read();
-            afterRead(c != -1 ? 1 : -1);
+            afterRead(c != EOF ? 1 : EOF);
             return c;
         } catch (final IOException e) {
             handleIOException(e);
-            return -1;
+            return EOF;
         }
     }
 
@@ -77,7 +79,7 @@ public int read(final char[] chr) throws IOException {
             return n;
         } catch (final IOException e) {
             handleIOException(e);
-            return -1;
+            return EOF;
         }
     }
 
@@ -98,7 +100,7 @@ public int read(final char[] chr, final int st, final int len) throws IOExceptio
             return n;
         } catch (final IOException e) {
             handleIOException(e);
-            return -1;
+            return EOF;
         }
     }
 
@@ -118,14 +120,14 @@ public int read(final CharBuffer target) throws IOException {
             return n;
         } catch (final IOException e) {
             handleIOException(e);
-            return -1;
+            return EOF;
         }
     }
 
     /**
      * Invokes the delegate's <code>skip(long)</code> method.
      * @param ln the number of bytes to skip
-     * @return the number of bytes to skipped or -1 if the end of stream
+     * @return the number of bytes to skipped or EOF if the end of stream
      * @throws IOException if an I/O error occurs
      */
     @Override
diff --git a/src/main/java/org/apache/commons/io/input/ReaderInputStream.java b/src/main/java/org/apache/commons/io/input/ReaderInputStream.java
@@ -16,6 +16,8 @@
  */
 package org.apache.commons.io.input;
 
+import static org.apache.commons.io.IOUtils.EOF;
+
 import java.io.IOException;
 import java.io.InputStream;
 import java.io.Reader;
@@ -198,7 +200,7 @@ private void fillBuffer() throws IOException {
             // to write directly to the underlying char array (the default implementation
             // copies data to a temporary char array).
             final int c = reader.read(encoderIn.array(), position, encoderIn.remaining());
-            if (c == -1) {
+            if (c == EOF) {
                 endOfInput = true;
             } else {
                 encoderIn.position(position+c);
@@ -247,7 +249,7 @@ public int read(final byte[] b, int off, int len) throws IOException {
                 }
             }
         }
-        return read == 0 && endOfInput ? -1 : read;
+        return read == 0 && endOfInput ? EOF : read;
     }
 
     /**
@@ -278,7 +280,7 @@ public int read() throws IOException {
             } else {
                 fillBuffer();
                 if (endOfInput && !encoderOut.hasRemaining()) {
-                    return -1;
+                    return EOF;
                 }
             }
         }
diff --git a/src/main/java/org/apache/commons/io/input/SwappedDataInputStream.java b/src/main/java/org/apache/commons/io/input/SwappedDataInputStream.java
@@ -16,6 +16,8 @@
  */
 package org.apache.commons.io.input;
 
+import static org.apache.commons.io.IOUtils.EOF;
+
 import java.io.DataInput;
 import java.io.EOFException;
 import java.io.IOException;
@@ -139,7 +141,7 @@ public void readFully( final byte[] data, final int offset, final int length )
             final int location = offset + length - remaining;
             final int count = read( data, location, remaining );
 
-            if( -1 == count )
+            if (EOF == count)
             {
                 throw new EOFException();
             }
diff --git a/src/main/java/org/apache/commons/io/input/Tailer.java b/src/main/java/org/apache/commons/io/input/Tailer.java
diff --git a/src/main/java/org/apache/commons/io/input/TeeInputStream.java b/src/main/java/org/apache/commons/io/input/TeeInputStream.java
diff --git a/src/main/java/org/apache/commons/io/output/ByteArrayOutputStream.java b/src/main/java/org/apache/commons/io/output/ByteArrayOutputStream.java

Original file line number	Diff line number	Diff line change
`@@ -16,6 +16,8 @@`
`16`	`16`	`*/`
`17`	`17`	`package org.apache.commons.io;`
`18`	`18`
	`19`	`+import static org.apache.commons.io.IOUtils.EOF;`
	`20`	`+`
`19`	`21`	`import java.io.EOFException;`
`20`	`22`	`import java.io.IOException;`
`21`	`23`	`import java.io.InputStream;`
`@@ -479,7 +481,7 @@ private static int read(final InputStream input)`
`479`	`481`	`{`
`480`	`482`	`final int value = input.read();`
`481`	`483`
`482`		`- if( -1 == value ) {`
	`484`	`+ if( EOF == value ) {`
`483`	`485`	`throw new EOFException( "Unexpected EOF reached" );`
`484`	`486`	`}`
`485`	`487`
Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,8 @@`
`17`	`17`
`18`	`18`	`package org.apache.commons.io.input;`
`19`	`19`
	`20`	`+import static org.apache.commons.io.IOUtils.EOF;`
	`21`	`+`
`20`	`22`	`import java.io.IOException;`
`21`	`23`	`import java.io.InputStream;`
`22`	`24`	`import java.nio.ByteBuffer;`
`@@ -39,8 +41,6 @@ public class CharSequenceInputStream extends InputStream {`
`39`	`41`
`40`	`42`	`private static final int BUFFER_SIZE = 2048;`
`41`	`43`
`42`		`- private static final int EOS = -1;`
`43`		`-`
`44`	`44`	`private static final int NO_MARK = -1;`
`45`	`45`
`46`	`46`	`private final CharsetEncoder encoder;`
`@@ -139,7 +139,7 @@ public int read(final byte[] b, int off, int len) throws IOException {`
`139`	`139`	`return 0; // must return 0 for zero length read`
`140`	`140`	`}`
`141`	`141`	`if (!this.bbuf.hasRemaining() && !this.cbuf.hasRemaining()) {`
`142`		`- return EOS;`
	`142`	`+ return EOF;`
`143`	`143`	`}`
`144`	`144`	`int bytesRead = 0;`
`145`	`145`	`while (len > 0) {`
`@@ -156,7 +156,7 @@ public int read(final byte[] b, int off, int len) throws IOException {`
`156`	`156`	`}`
`157`	`157`	`}`
`158`	`158`	`}`
`159`		`- return bytesRead == 0 && !this.cbuf.hasRemaining() ? EOS : bytesRead;`
	`159`	`+ return bytesRead == 0 && !this.cbuf.hasRemaining() ? EOF : bytesRead;`
`160`	`160`	`}`
`161`	`161`
`162`	`162`	`@Override`
`@@ -167,7 +167,7 @@ public int read() throws IOException {`
`167`	`167`	`} else {`
`168`	`168`	`fillBuffer();`
`169`	`169`	`if (!this.bbuf.hasRemaining() && !this.cbuf.hasRemaining()) {`
`170`		`- return EOS;`
	`170`	`+ return EOF;`
`171`	`171`	`}`
`172`	`172`	`}`
`173`	`173`	`}`