public class PipedReader extends Reader
Constructor and Description |
---|
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. |
Modifier and Type | Method and Description |
---|---|
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.
|
public PipedReader(PipedWriter src) throws IOException
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
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()
public PipedReader(int pipeSize)
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
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
-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
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
ready
in class Reader
IOException
- if the pipe is
broken
,
unconnected
, or closed.public void close() throws IOException
close
in interface Closeable
close
in interface AutoCloseable
close
in class Reader
IOException
- if an I/O error occurs. Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2020, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
Scripting on this page tracks web page traffic, but does not change the content in any way.