java.io.PipedReader Maven / Gradle / Ivy

/*
This is not an official specification document, and usage is restricted.


NOTICE





(c) 2005-2007 Sun Microsystems, Inc. All Rights Reserved.

Neither this file nor any files generated from it describe a complete
specification, and they may only be used as described below. For
example, no permission is given for you to incorporate this file, in
whole or in part, in an implementation of a Java specification.

Sun Microsystems Inc. owns the copyright in this file and it is provided
to you for informative, as opposed to normative, use. The file and any
files generated from it may be used to generate other informative
documentation, such as a unified set of documents of API signatures for
a platform that includes technologies expressed as Java APIs. The file
may also be used to produce "compilation stubs," which allow
applications to be compiled and validated for such platforms.

Any work generated from this file, such as unified javadocs or compiled
stub files, must be accompanied by this notice in its entirety.

This work corresponds to the API signatures of JSR 219: Foundation
Profile 1.1. In the event of a discrepency between this work and the
JSR 219 specification, which is available at
http://www.jcp.org/en/jsr/detail?id=219, the latter takes precedence.
*/


  


package java.io;

/** 
 * Piped character-input streams.
 *
 * @version 	1.12, 00/02/02
 * @author	Mark Reinhold
 * @since	JDK1.1
 */
public class PipedReader extends Reader
{

    /** 
     * 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.
     *
     * @param      src   the stream to connect to.
     * @exception  IOException  if an I/O error occurs.
     */
    public PipedReader(PipedWriter src) throws IOException { }

    /** 
     * Creates a PipedReader so
     * that it is not  yet connected. It must be
     * connected to a PipedWriter
     * before being used.
     *
     * @see     java.io.PipedReader#connect(java.io.PipedWriter)
     * @see     java.io.PipedWriter#connect(java.io.PipedReader)
     */
    public PipedReader() { }

    /** 
     * 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.
     *
     * @param      src   The piped writer to connect to.
     * @exception  IOException  if an I/O error occurs.
     */
    public void connect(PipedWriter src) 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     the next character of data, or -1 if the end of the
     *             stream is reached.
     * @exception  IOException  if the pipe is broken.
     */
    public synchronized int read() throws IOException {
        return 0;
    }

    /** 
     * 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.
     *
     * @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     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.
     * @exception  IOException  if an I/O error occurs.
     */
    public synchronized int read(char[] cbuf, int off, int len)
        throws IOException
    {
        return 0;
    }

    /** 
     * Tell whether this stream is ready to be read.  A piped character
     * stream is ready if the circular buffer is not empty.
     *
     * @exception  IOException  If an I/O error occurs
     */
    public synchronized boolean ready() throws IOException {
        return false;
    }

    /** 
     * Closes this piped stream and releases any system resources 
     * associated with the stream. 
     *
     * @exception  IOException  if an I/O error occurs.
     */
    public void close() throws IOException { }
}