| |
|
| java.lang.Object
 java.io.Reader
java.io.PipedReader
| PipedReader | | public class PipedReader extends Reader (Code) | | Piped character-input streams.
version:
1.25, 07/05/05
author:
Mark Reinhold
since:
JDK1.1 |
| Field Summary | |
| char | buffer
The circular buffer into which incoming data is placed. | | boolean | closedByReader
| | boolean | closedByWriter
| | boolean | connected
| | int | in
The index of the position in the circular buffer at which the
next character of data will be stored when received from the connected
piped writer. | | int | out
The index of the position in the circular buffer at which the next
character of data will be read by this piped reader. | | Thread | readSide
| | Thread | writeSide
|
| Constructor Summary | |
| public | PipedReader(PipedWriter src)
Creates a PipedReader so
that it is connected to the piped writer
src. | | public | PipedReader(PipedWriter src, int pipeSize)
Creates a PipedReader so that it is connected
to the piped writer src and uses the specified
pipe size for the pipe's buffer. | | public | PipedReader()
Creates a PipedReader so
that it is not yet
. | | public | PipedReader(int pipeSize)
Creates a PipedReader so that it is not yet
PipedReader.connect(java.io.PipedWriter) connected and uses
the specified pipe size for the pipe's buffer. |
| Method Summary | |
| public void | close()
Closes this piped stream and releases any system resources
associated with the stream. | | public void | connect(PipedWriter src)
Causes this piped reader to be connected
to the piped writer src. | | public synchronized int | read()
Reads the next character of data from this piped stream.
If no character is available because the end of the stream
has been reached, the value -1 is returned. | | public synchronized int | read(char cbuf, int off, int len)
Reads up to len characters of data from this piped
stream into an array of characters. | | public synchronized boolean | ready()
Tell whether this stream is ready to be read. | | synchronized void | receive(int c)
Receives a char of data. | | synchronized void | receive(char c, int off, int len)
Receives data into an array of characters. | | synchronized void | receivedLast()
Notifies all waiting threads that the last character of data has been
received. |
| buffer | | char buffer(Code) | | The circular buffer into which incoming data is placed.
|
| closedByReader | | boolean closedByReader(Code) | | |
| closedByWriter | | boolean closedByWriter(Code) | | |
| connected | | boolean connected(Code) | | |
| in | | int in(Code) | | The index of the position in the circular buffer at which the
next character of data will be stored when received from the connected
piped writer. in<0 implies the buffer is empty,
in==out implies the buffer is full
|
| out | | int out(Code) | | The index of the position in the circular buffer at which the next
character of data will be read by this piped reader.
|
| PipedReader | | public PipedReader(PipedWriter src) throws IOException(Code) | | Creates a PipedReader so
that it is connected to the piped writer
src. Data written to src
will then be available as input from this stream.
Parameters:
src - the stream to connect to.
exception:
IOException - if an I/O error occurs. |
| PipedReader | | public PipedReader(PipedWriter src, int pipeSize) throws IOException(Code) | | Creates a PipedReader so that it is connected
to the piped writer src and uses the specified
pipe size for the pipe's buffer. Data written to src
will then be available as input from this stream.
Parameters:
src - the stream to connect to.
Parameters:
pipeSize - the size of the pipe's buffer.
exception:
IOException - if an I/O error occurs.
exception:
IllegalArgumentException - if pipeSize <= 0.
since:
1.6 |
| PipedReader | | public PipedReader()(Code) | | Creates a PipedReader so
that it is not yet
. It must be
to a PipedWriter
before being used.
|
| PipedReader | | public PipedReader(int pipeSize)(Code) | | Creates a PipedReader so that it is not yet
PipedReader.connect(java.io.PipedWriter) connected and uses
the specified pipe size for the pipe's buffer.
It must be
to a PipedWriter
before being used.
Parameters:
pipeSize - the size of the pipe's buffer.
exception:
IllegalArgumentException - if pipeSize <= 0.
since:
1.6 |
| close | | public void close() throws IOException(Code) | | Closes this piped stream and releases any system resources
associated with the stream.
exception:
IOException - if an I/O error occurs. |
| connect | | public void connect(PipedWriter src) throws IOException(Code) | | Causes this piped reader to be connected
to the piped writer src.
If this object is already connected to some
other piped writer, an IOException
is thrown.
If src is an
unconnected piped writer and snk
is an unconnected piped reader, they
may be connected by either the call:
snk.connect(src)
or the call:
src.connect(snk)
The two
calls have the same effect.
Parameters:
src - The piped writer to connect to.
exception:
IOException - if an I/O error occurs. |
| read | | public synchronized int read() throws IOException(Code) | | Reads the next character of data from this piped stream.
If no character is available because the end of the stream
has been reached, the value -1 is returned.
This method blocks until input data is available, the end of
the stream is detected, or an exception is thrown.
the next character of data, or -1 if the end of thestream is reached.
exception:
IOException - if the pipe is broken,PipedReader.connect(java.io.PipedWriter) unconnected, closed,or an I/O error occurs. |
| read | | public synchronized int read(char cbuf, int off, int len) throws IOException(Code) | | Reads up to len characters of data from this piped
stream into an array of characters. Less than len characters
will be read if the end of the data stream is reached or if
len exceeds the pipe's buffer size. This method
blocks until at least one character of input is available.
Parameters:
cbuf - the buffer into which the data is read.
Parameters:
off - the start offset of the data.
Parameters:
len - the maximum number of characters read. the total number of characters read into the buffer, or-1 if there is no more data because the end ofthe stream has been reached.
exception:
IOException - if the pipe is broken,PipedReader.connect(java.io.PipedWriter) unconnected, closed,or an I/O error occurs. |
| receive | | synchronized void receive(int c) throws IOException(Code) | | Receives a char of data. This method will block if no input is
available.
|
| receive | | synchronized void receive(char c, int off, int len) throws IOException(Code) | | Receives data into an array of characters. This method will
block until some input is available.
|
| receivedLast | | synchronized void receivedLast()(Code) | | Notifies all waiting threads that the last character of data has been
received.
|
|
|
|