Package org.apache.commons.io.input
Class ClosedInputStream
- java.lang.Object
-
- java.io.InputStream
-
- org.apache.commons.io.input.ClosedInputStream
-
- All Implemented Interfaces:
Closeable
,AutoCloseable
public class ClosedInputStream extends InputStream
Closed input stream. This stream returns EOF to 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
null
input stream.- Since:
- 1.4
-
-
Field Summary
Fields Modifier and Type Field Description static ClosedInputStream
CLOSED_INPUT_STREAM
A singleton.
-
Constructor Summary
Constructors Constructor Description ClosedInputStream()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
read()
Returns -1 to indicate that the stream is closed.-
Methods inherited from class java.io.InputStream
available, close, mark, markSupported, nullInputStream, read, read, readAllBytes, readNBytes, readNBytes, reset, skip, transferTo
-
-
-
-
Field Detail
-
CLOSED_INPUT_STREAM
public static final ClosedInputStream CLOSED_INPUT_STREAM
A singleton.
-
-
Method Detail
-
read
public int read()
Returns -1 to indicate that the stream is closed.- Specified by:
read
in classInputStream
- Returns:
- always -1
-
-