Package org.apache.commons.io.input
Class ClosedReader
- java.lang.Object
-
- java.io.Reader
-
- org.apache.commons.io.input.ClosedReader
-
- All Implemented Interfaces:
Closeable
,AutoCloseable
,Readable
public class ClosedReader extends Reader
Closed reader. This reader returns EOF to all attempts to read something from it.Typically uses of this class include testing for corner cases in methods that accept readers and acting as a sentinel value instead of a
null
reader.- Since:
- 2.7
-
-
Field Summary
Fields Modifier and Type Field Description static ClosedReader
CLOSED_READER
A singleton.
-
Constructor Summary
Constructors Constructor Description ClosedReader()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
close()
int
read(char[] cbuf, int off, int len)
Returns -1 to indicate that the stream is closed.-
Methods inherited from class java.io.Reader
mark, markSupported, nullReader, read, read, read, ready, reset, skip, transferTo
-
-
-
-
Field Detail
-
CLOSED_READER
public static final ClosedReader CLOSED_READER
A singleton.
-
-
Method Detail
-
read
public int read(char[] cbuf, int off, int len)
Returns -1 to indicate that the stream is closed.
-
close
public void close() throws IOException
- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Specified by:
close
in classReader
- Throws:
IOException
-
-