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 Details

    • CLOSED_READER

      public static final ClosedReader CLOSED_READER
      A singleton.
  • Constructor Details

    • ClosedReader

      public ClosedReader()
  • Method Details

    • read

      public int read(char[] cbuf, int off, int len)
      Returns -1 to indicate that the stream is closed.
      Specified by:
      read in class Reader
      Parameters:
      cbuf - ignored
      off - ignored
      len - ignored
      Returns:
      always -1
    • close

      public void close() throws IOException
      Specified by:
      close in interface AutoCloseable
      Specified by:
      close in interface Closeable
      Specified by:
      close in class Reader
      Throws:
      IOException