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 Details

    • CLOSED_INPUT_STREAM

      public static final ClosedInputStream CLOSED_INPUT_STREAM
      A singleton.
  • Constructor Details

    • ClosedInputStream

      public ClosedInputStream()
  • Method Details

    • read

      public int read()
      Returns -1 to indicate that the stream is closed.
      Specified by:
      read in class InputStream
      Returns:
      always -1