Class PipedReader

public PipedReader()

Creates a new PipedReader that is not connected to a PipedWriter. It must be connected before chars can be read from this stream.

public PipedReader(PipedWriter source)
            throws IOException

This constructor creates a new PipedReader and connects it to the passed in PipedWriter. The stream is then ready for reading.

Parameters:

source - The PipedWriter to connect this stream to

Throws:

IOException - If source is already connected.

public void close()
            throws IOException

This methods closes the stream so that no more data can be read from it.

Specified by:

close in interface Closeable

Overrides:

close in interface Reader

Throws:

IOException - If an error occurs

public void connect(PipedWriter source)
            throws IOException

This method connects this stream to the passed in PipedWriter. This stream is then ready for reading. If this stream is already connected or has been previously closed, then an exception is thrown

Parameters:

source - The PipedWriter to connect this stream to

Throws:

IOException - If this PipedReader or source has been connected already.

public int read()
            throws IOException

This method reads chars from the stream into a caller supplied buffer. It starts storing chars at position offset into the buffer and reads a maximum of len chars. Note that this method can actually read fewer than len chars. The actual number of chars read is returned. A -1 is returned to indicated that no chars can be read because the end of the stream was reached. If the stream is already closed, a -1 will again be returned to indicate the end of the stream.

This method will block if no char is available to be read.

Overrides:

read in interface Reader

public int read(char[] buf,
                int offset,
                int len)
            throws IOException

This method reads characters from the stream into a caller supplied buffer. It starts storing chars at position offset into the buffer and reads a maximum of len chars. Note that this method can actually read fewer than len chars. The actual number of chars read is returned. A -1 is returned to indicated that no chars can be read because the end of the stream was reached - ie close() was called on the connected PipedWriter.

This method will block if no chars are available to be read.

Parameters:

buf - The buffer into which chars will be stored

offset - The index into the buffer at which to start writing.

len - The maximum number of chars to read.

Throws:

IOException - If close() was called on this Piped Reader.

public boolean ready()
            throws IOException

Determines whether or not this stream is ready to be read. If it returns false the stream may block if a read is attempted, but it is not guaranteed to do so.

This method always returns false in this class

Overrides:

ready in interface Reader

Returns:

true if the stream is ready to be read, false otherwise.

Throws:

IOException - If an error occurs