java.lang.Object | ||
↳ | java.io.Reader | |
↳ | java.io.PipedReader |
Receives information on a communications pipe. When two threads want to pass data back and forth, one creates a piped writer and the other creates a piped reader.
[Expand]
Inherited Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.io.Reader
|
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Constructs a new unconnected
PipedReader . | |||||||||||
Constructs a new unconnected
PipedReader with the given buffer size. | |||||||||||
Constructs a new
PipedReader connected to the given PipedWriter ,
with the given buffer size. |
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Closes this reader.
| |||||||||||
Connects this
PipedReader to a PipedWriter . | |||||||||||
Reads a single character from this reader and returns it as an integer
with the two higher-order bytes set to 0.
| |||||||||||
Reads up to
count characters from this reader and stores them
in the character array buffer starting at offset . | |||||||||||
Indicates whether this reader is ready to be read without blocking.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.io.Reader
| |||||||||||
From class
java.lang.Object
| |||||||||||
From interface
java.io.Closeable
| |||||||||||
From interface
java.lang.AutoCloseable
| |||||||||||
From interface
java.lang.Readable
|
Constructs a new unconnected PipedReader
. The resulting reader
must be connected to a PipedWriter
before data may be read from
it.
Constructs a new PipedReader
connected to the PipedWriter
out
. Any data written to the writer can be read from the this
reader.
out | the PipedWriter to connect to. |
---|
IOException | if out is already connected.
|
---|
Constructs a new unconnected PipedReader
with the given buffer size.
The resulting reader must be connected to a PipedWriter
before
data may be read from it.
pipeSize | the size of the buffer in chars. |
---|
IllegalArgumentException | if pipeSize is less than or equal to zero. |
---|
Constructs a new PipedReader
connected to the given PipedWriter
,
with the given buffer size. Any data written to the writer can be read from
this reader.
out | the PipedWriter to connect to. |
---|---|
pipeSize | the size of the buffer in chars. |
IOException | if an I/O error occurs |
---|---|
IllegalArgumentException | if pipeSize is less than or equal to zero. |
Closes this reader. This implementation releases the buffer used for the pipe and notifies all threads waiting to read or write.
IOException | if an error occurs while closing this reader. |
---|
Connects this PipedReader
to a PipedWriter
. Any data
written to the writer becomes readable in this reader.
src | the writer to connect to. |
---|
IOException | if this reader is closed or already connected, or if src is already connected.
|
---|
Reads a single character from this reader and returns it as an integer with the two higher-order bytes set to 0. Returns -1 if the end of the reader has been reached. If there is no data in the pipe, this method blocks until data is available, the end of the reader is detected or an exception is thrown.
Separate threads should be used to read from a PipedReader
and to
write to the connected PipedWriter
. If the same thread is used,
a deadlock may occur.
IOException | if this reader is closed or some other I/O error occurs. |
---|
Reads up to count
characters from this reader and stores them
in the character array buffer
starting at offset
. If
there is no data in the pipe, this method blocks until at least one byte
has been read, the end of the reader is detected or an exception is
thrown.
Separate threads should be used to read from a PipedReader
and to
write to the connected PipedWriter
. If the same thread is used, a
deadlock may occur.
Returns the number of characters read or -1 if the end of the reader has been reached.
IndexOutOfBoundsException | if offset < 0 || count < 0 || offset + count > buffer.length . |
---|---|
InterruptedIOException | if the thread reading from this reader is interrupted. |
IOException | if this reader is closed or not connected to a writer, or if the thread writing to the connected writer is no longer alive. |
Indicates whether this reader is ready to be read without blocking.
Returns true
if this reader will not block when read
is
called, false
if unknown or blocking will occur. This
implementation returns true
if the internal buffer contains
characters that can be read.
false
.IOException | if this reader is closed or not connected, or if some other I/O error occurs. |
---|