Class TeeInputStream

public TeeInputStream(InputStream in,
                      OutputStream out)

Constructs a tee input stream.

Parameters:

in - the underlying input stream

out - the output sink

public void close()
            throws IOException

This method closes the stream. Any futher attempts to read from the stream may generate an IOException

This method does nothing in this class, but subclasses may override this method in order to provide additional functionality.

Specified by:

close in interface Closeable

close in interface AutoCloseable

Overrides:

close in interface InputStream

Throws:

IOException - If an error occurs, which can only happen in a subclass

public final boolean markSupported()

This method returns a boolean that indicates whether the mark/reset methods are supported in this class. Those methods can be used to remember a specific point in the stream and reset the stream to that point.

This method always returns false in this class, but subclasses can override this method to return true if they support mark/reset functionality.

Overrides:

markSupported in interface InputStream

Returns:

true if mark/reset functionality is supported, false otherwise

public int read()
            throws IOException

This method reads an unsigned byte from the input stream and returns it as an int in the range of 0-255. This method also will return -1 if the end of the stream has been reached.

This method will block until the byte can be read.

Overrides:

read in interface InputStream

Returns:

The byte read or -1 if end of stream

Throws:

IOException - If an error occurs

public int read(byte[] b,
                int off,
                int len)
            throws IOException

This method read bytes from a stream and stores them into a caller supplied buffer. It starts storing the data at index off into the buffer and attempts to read len bytes. This method can return before reading the number of bytes requested. The actual number of bytes read is returned as an int. A -1 is returned to indicate the end of the stream.

This method will block until some data can be read.

This method operates by calling the single byte read() method in a loop until the desired number of bytes are read. The read loop stops short if the end of the stream is encountered or if an IOException is encountered on any read operation except the first. If the first attempt to read a bytes fails, the IOException is allowed to propagate upward. And subsequent IOException is caught and treated identically to an end of stream condition. Subclasses can (and should if possible) override this method to provide a more efficient implementation.

Overrides:

read in interface InputStream

Parameters:

b - The array into which the bytes read should be stored

off - The offset into the array to start storing bytes

len - The requested number of bytes to read

Returns:

The actual number of bytes read, or -1 if end of stream.

Throws:

IOException - If an error occurs.