PipedReader - JRE Emulation | JRE Emulation
public class

PipedReader

extends Reader
java.lang.Object
   ↳ java.io.Reader
     ↳ java.io.PipedReader

Class Overview

Piped character-input streams.

Summary

[Expand]
Inherited Fields
From class java.io.Reader
Public Constructors
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.
PipedReader()
Creates a PipedReader so that it is not yet {@linkplain #connect(java.io.PipedWriter) 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.
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.
synchronized int read()
Reads the next character of data from this piped stream.
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.
synchronized boolean ready()
Tell whether this stream is ready to be read.
Inherited Methods
[Expand]
From class java.io.Reader
From class java.lang.Object
From interface java.lang.Readable
From interface java.io.Closeable
From interface java.lang.AutoCloseable

Public Constructors

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

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

public PipedReader ()

Creates a PipedReader so that it is not yet {@linkplain #connect(java.io.PipedWriter) connected}. It must be {@linkplain java.io.PipedWriter#connect( java.io.PipedReader) 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 {@linkplain java.io.PipedWriter#connect( java.io.PipedReader) connected} to a PipedWriter before being used.

Parameters
pipeSize the size of the pipe's buffer.
Throws
IllegalArgumentException if pipeSize <= 0.

Public Methods

public void close ()

Closes this piped stream and releases any system resources associated with the stream.

Throws
IOException if an I/O error occurs.

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 The piped writer to connect to.
Throws
IOException if an I/O error occurs.

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. This method blocks until input data is available, the end of the stream is detected, or an exception is thrown.

Returns
  • the next character of data, or -1 if the end of the stream is reached.
Throws
IOException if the pipe is broken, unconnected, closed, or an I/O error occurs.

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. 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.
off the start offset of the data.
len the maximum number of characters read.
Returns
  • 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.
Throws
IOException if the pipe is broken, unconnected, closed, or an I/O error occurs.

public synchronized 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
  • 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.
Throws
IOException if the pipe is broken, unconnected, or closed.