PipedReader
public
class
PipedReader
extends Reader
Piped character-input streams.
Summary
Inherited fields |
From class
java.io.Reader
protected
Object |
lock
The object used to synchronize operations on this stream.
|
|
Public constructors |
PipedReader()
Creates a PipedReader so
that it is not yet connected.
|
PipedReader(int pipeSize)
Creates a PipedReader so that it is not yet
connected and uses
the specified pipe size for the pipe's buffer.
|
PipedReader(PipedWriter src)
Creates a PipedReader so
that it is connected to the piped writer
src .
|
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 methods |
void
|
close()
Closes this piped stream and releases any system resources
associated with the stream.
|
void
|
connect(PipedWriter src)
Causes this piped reader to be connected
to the piped writer src .
|
int
|
read()
Reads the next character of data from this piped stream.
|
int
|
read(char[] cbuf, int off, int len)
Reads up to len characters of data from this piped
stream into an array of characters.
|
boolean
|
ready()
Tell whether this stream is ready to be read.
|
Inherited methods |
From class
java.io.Reader
abstract
void
|
close()
Closes the stream and releases any system resources associated with
it.
|
void
|
mark(int readAheadLimit)
Marks the present position in the stream.
|
boolean
|
markSupported()
Tells whether this stream supports the mark() operation.
|
static
Reader
|
nullReader()
Returns a new Reader that reads no characters.
|
int
|
read()
Reads a single character.
|
abstract
int
|
read(char[] cbuf, int off, int len)
Reads characters into a portion of an array.
|
int
|
read(char[] cbuf)
Reads characters into an array.
|
int
|
read(CharBuffer target)
Attempts to read characters into the specified character buffer.
|
boolean
|
ready()
Tells whether this stream is ready to be read.
|
void
|
reset()
Resets the stream.
|
long
|
skip(long n)
Skips characters.
|
long
|
transferTo(Writer out)
Reads all characters from this reader and writes the characters to the
given writer in the order that they are read.
|
|
From class
java.lang.Object
Object
|
clone()
Creates and returns a copy of this object.
|
boolean
|
equals(Object obj)
Indicates whether some other object is "equal to" this one.
|
void
|
finalize()
Called by the garbage collector on an object when garbage collection
determines that there are no more references to the object.
|
final
Class<?>
|
getClass()
Returns the runtime class of this Object .
|
int
|
hashCode()
Returns a hash code value for the object.
|
final
void
|
notify()
Wakes up a single thread that is waiting on this object's
monitor.
|
final
void
|
notifyAll()
Wakes up all threads that are waiting on this object's monitor.
|
String
|
toString()
Returns a string representation of the object.
|
final
void
|
wait(long timeoutMillis, int nanos)
Causes the current thread to wait until it is awakened, typically
by being notified or interrupted, or until a
certain amount of real time has elapsed.
|
final
void
|
wait(long timeoutMillis)
Causes the current thread to wait until it is awakened, typically
by being notified or interrupted, or until a
certain amount of real time has elapsed.
|
final
void
|
wait()
Causes the current thread to wait until it is awakened, typically
by being notified or interrupted.
|
|
From interface
java.io.Closeable
abstract
void
|
close()
Closes this stream and releases any system resources associated
with it.
|
|
From interface
java.lang.Readable
abstract
int
|
read(CharBuffer cb)
Attempts to read characters into the specified character buffer.
|
|
From interface
java.lang.AutoCloseable
abstract
void
|
close()
Closes this resource, relinquishing any underlying resources.
|
|
Public constructors
PipedReader
public PipedReader ()
Creates a PipedReader
so
that it is not yet connected. It must be connected to a PipedWriter
before being used.
PipedReader
public PipedReader (int pipeSize)
Creates a PipedReader
so that it is not yet
connected
and uses
the specified pipe size for the pipe's buffer.
It must be connected to a PipedWriter
before being used.
Parameters |
pipeSize |
int : the size of the pipe's buffer. |
PipedReader
public PipedReader (PipedWriter src)
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 |
PipedWriter : the stream to connect to. |
PipedReader
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. Data written to src
will then be available as input from this stream.
Parameters |
src |
PipedWriter : the stream to connect to. |
pipeSize |
int : the size of the pipe's buffer. |
Public methods
close
public void close ()
Closes this piped stream and releases any system resources
associated with the stream.
connect
public void connect (PipedWriter src)
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 |
PipedWriter : The piped writer to connect to. |
read
public 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.
This method blocks until input data is available, the end of
the stream is detected, or an exception is thrown.
Returns |
int |
the next character of data, or -1 if the end of the
stream is reached. |
read
public int read (char[] cbuf,
int off,
int len)
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 |
char : the buffer into which the data is read. |
off |
int : the start offset of the data. |
len |
int : the maximum number of characters read. |
Returns |
int |
the total number of characters read into the buffer, or
-1 if there is no more data because the end of
the stream has been reached. |
ready
public boolean ready ()
Tell whether this stream is ready to be read. A piped character
stream is ready if the circular buffer is not empty.
Returns |
boolean |
True if the next read() is guaranteed not to block for input,
false otherwise. Note that returning false does not guarantee that the
next read will block. |