Class: java.io.PipedReader

  • public class PipedReader
  • extends Reader
Piped character-input streams.
Authors:
@author Mark Reinhold
Version:
@version 1.15, 03/12/19
Since:
@since JDK1.1

Inheritance

Superclass tree: Implements:

Methods

  • PipedReadertop

    public PipedReader()
    Creates a PipedReader so that it is not yet connected. It must be connected to a PipedWriter before being used.
    See:
    @see java.io.PipedReader.connect(java.io.PipedWriter)
    @see java.io.PipedWriter.connect(java.io.PipedReader)
    Related Links:
    Google Code Search
    Stack Overflow

  • PipedReadertop

    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:
    @param src the stream to connect to.
    Exceptions:
    @exception IOException if an I/O error occurs.
    Related Links:
    Google Code Search
    Stack Overflow

  • closetop

    public void close() throws IOException
    Closes this piped stream and releases any system resources associated with the stream.
    Exceptions:
    @exception IOException if an I/O error occurs.
    Specified by:
    close from Closeable
    Override hierarchy:
    close from Reader
    Related Links:
    Google Code Search
    Stack Overflow

  • connecttop

    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.

    Parameters:
    @param src The piped writer to connect to.
    Exceptions:
    @exception IOException if an I/O error occurs.
    Related Links:
    Google Code Search
    Stack Overflow

  • readtop

    public synchronized 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. If a thread was providing data characters to the connected piped writer, but the thread is no longer alive, then an IOException is thrown.
    Return:
    @return the next character of data, or -1 if the end of the stream is reached.
    Exceptions:
    @exception IOException if the pipe is broken.
    Override hierarchy:
    read from Reader
    Related Links:
    Google Code Search
    Stack Overflow

  • readtop

    public synchronized 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. This method blocks until at least one character of input is available. If a thread was providing data characters to the connected piped output, but the thread is no longer alive, then an IOException is thrown.
    Parameters:
    @param cbuf the buffer into which the data is read.
    @param off the start offset of the data.
    @param len the maximum number of characters read.
    Return:
    @return 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.
    Exceptions:
    @exception IOException if an I/O error occurs.
    Override hierarchy:
    read from Reader
    Related Links:
    Google Code Search
    Stack Overflow

  • readytop

    public synchronized 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.
    Return:
    @return 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.
    Exceptions:
    @exception IOException If an I/O error occurs
    Override hierarchy:
    ready from Reader
    Related Links:
    Google Code Search
    Stack Overflow