public class PipedReader extends Reader
Piped character-input streams.
lock
public PipedReader(PipedWriter src) throws IOException
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.
src
- the stream to connect to.IOException
- if an I/O error occurs.public PipedReader(PipedWriter src, int pipeSize) throws IOException
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.
src
- the stream to connect to.pipeSize
- the size of the pipe's buffer.IOException
- if an I/O error occurs.IllegalArgumentException
- if pipeSize <= 0
.public PipedReader()
Creates a PipedReader
so that it is not yet connected. It must be connected to a PipedWriter
before being used.
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.
pipeSize
- the size of the pipe's buffer.IllegalArgumentException
- if pipeSize <= 0
.public void connect(PipedWriter src) throws IOException
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.
src
- The piped writer to connect to.IOException
- if an I/O error occurs.public int read() throws IOException
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.
read
in class Reader
-1
if the end of the stream is reached.IOException
- if the pipe is broken
, unconnected
, closed, or an I/O error occurs.public int read(char[] cbuf, int off, int len) throws IOException
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.
read
in class Reader
cbuf
- the buffer into which the data is read.off
- the start offset of the data.len
- the maximum number of characters read.-1
if there is no more data because the end of the stream has been reached.IOException
- if the pipe is broken
, unconnected
, closed, or an I/O error occurs.public boolean ready() throws IOException
Tell whether this stream is ready to be read. A piped character stream is ready if the circular buffer is not empty.
ready
in class Reader
IOException
- if the pipe is broken
, unconnected
, or closed.public void close() throws IOException
Closes this piped stream and releases any system resources associated with the stream.
close
in interface Closeable
close
in interface AutoCloseable
close
in class Reader
IOException
- if an I/O error occurs.
© 1993–2017, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.