Package org.apache.commons.io.input
Class ClosedInputStream
- java.lang.Object
-
- java.io.InputStream
-
- org.apache.commons.io.input.ClosedInputStream
-
- All Implemented Interfaces:
java.io.Closeable,java.lang.AutoCloseable
public class ClosedInputStream extends java.io.InputStreamAlways returnsIOUtils.EOFto all attempts to read something from the stream.Typically uses of this class include testing for corner cases in methods that accept input streams and acting as a sentinel value instead of a
nullinput stream.- Since:
- 1.4
-
-
Field Summary
Fields Modifier and Type Field Description static ClosedInputStreamCLOSED_INPUT_STREAMDeprecated.UseINSTANCE.static ClosedInputStreamINSTANCEThe singleton instance.
-
Constructor Summary
Constructors Constructor Description ClosedInputStream()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description intread()Returns -1 to indicate that the stream is closed.intread(byte[] b, int off, int len)Returns -1 to indicate that the stream is closed.
-
-
-
Field Detail
-
INSTANCE
public static final ClosedInputStream INSTANCE
The singleton instance.- Since:
- 2.12.0
-
CLOSED_INPUT_STREAM
@Deprecated public static final ClosedInputStream CLOSED_INPUT_STREAM
Deprecated.UseINSTANCE.The singleton instance.
-
-
Method Detail
-
read
public int read()
Returns -1 to indicate that the stream is closed.- Specified by:
readin classjava.io.InputStream- Returns:
- always -1
-
read
public int read(byte[] b, int off, int len) throws java.io.IOExceptionReturns -1 to indicate that the stream is closed.- Overrides:
readin classjava.io.InputStream- Parameters:
b- ignored.off- ignored.len- ignored.- Returns:
- always -1
- Throws:
java.io.IOException
-
-