panda.io.stream.ClosedInputStream Maven / Gradle / Ivy

Go to download
package panda.io.stream;

import 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 {@code null} input stream.
 */
public class ClosedInputStream extends InputStream {

	/**
	 * A singleton.
	 */
	public static final ClosedInputStream INSTANCE = new ClosedInputStream();

	/**
	 * Returns -1 to indicate that the stream is closed.
	 * 
	 * @return always -1
	 */
	@Override
	public int read() {
		return -1;
	}

}