java.lang.Object | +--java.io.Reader | +--java.io.PipedReader
PipedReader() Creates a new |
PipedReader(java.io.PipedWriter source) This constructor creates a new |
void | close() This methods closes the stream so that no more data can be read from it. |
void | connect(java.io.PipedWriter source) This method connects this stream to the passed in |
int | read() This method reads chars from the stream into a caller supplied buffer. |
int | read(char[] buf, int offset, int len) This method reads characters from the stream into a caller supplied buffer. |
boolean | ready() |
public PipedReader()
PipedReader
that is not connected to a
PipedWriter
. It must be connected before chars can
be read from this stream.
public PipedReader(java.io.PipedWriter source)
PipedReader
and connects
it to the passed in PipedWriter
. The stream is then
ready for reading.
source
- The PipedWriter
to connect this stream toIOException
- If source
is already connected.public void close()
IOException
- If an error occurspublic void connect(java.io.PipedWriter source)
PipedWriter
.
This stream is then ready for reading. If this stream is already
connected or has been previously closed, then an exception is thrown
source
- The PipedWriter
to connect this stream toIOException
- If this PipedReader or source
has been connected already.public int read()
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 chars are available to be read.
public int read(char[] buf, int offset, int len)
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.
buf
- The buffer into which chars will be storedoffset
- The index into the buffer at which to start writing.len
- The maximum number of chars to read.IOException
- If close()/code> was called on this Piped
Reader.
public boolean ready()
Data is read and written to an internal buffer. It is highly recommended that the
PipedReader
and connectedPipedWriter
be part of different threads. If they are not, there is a possibility that the read and write operations could deadlock their thread.