Docs4dev
Docs
openjdk / 21 / java.base / java / io / pipedreader.html

Class PipedReader

java.lang.Object
java.io.Reader
java.io.PipedReader
All Implemented Interfaces:
Closeable, AutoCloseable, Readable 
public class PipedReader extends Reader
Piped character-input streams.
Since:
1.1

Field Summary

Fields declared in class java.io.Reader

lock

Constructor Summary

Constructor 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.

Method Summary

Modifier and Type Method 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 characters into a portion of an array.
boolean ready()
Tell whether this stream is ready to be read.

Methods declared in class java.io.Reader

mark, markSupported, nullReader, read, read, reset, skip, transferTo

Methods declared in class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PipedReader

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.
Parameters:
src - the stream to connect to.
Throws:
IOException - if an I/O error occurs.

PipedReader

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.
Parameters:
src - the stream to connect to.
pipeSize - the size of the pipe's buffer.
Throws:
IOException - if an I/O error occurs.
IllegalArgumentException - if pipeSize <= 0.
Since:
1.6

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 - the size of the pipe's buffer.
Throws:
IllegalArgumentException - if pipeSize <= 0.
Since:
1.6

Method Details

connect

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: