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.InputStream

Closed input stream. This stream returns -1 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

Version:

$Id: ClosedInputStream.java 1307459 2012-03-30 15:11:44Z ggregory $

Field Summary

Fields

Modifier and Type	Field	Description
static ClosedInputStream	CLOSED_INPUT_STREAM	A singleton.

Constructor Summary

Constructors

Constructor	Description
ClosedInputStream()

Method Summary

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, read, read, readAllBytes, readNBytes, reset, skip, transferTo

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CLOSED_INPUT_STREAM

public static final ClosedInputStream CLOSED_INPUT_STREAM

A singleton.

Constructor Detail

ClosedInputStream

public ClosedInputStream()

Method Detail

read

public int read()

Returns -1 to indicate that the stream is closed.

Specified by:

read in class java.io.InputStream

Returns:

always -1