PipedReader (Java Platform SE 7 ) (original) (raw)

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:
JDK1.1

Field Summary

 * ### Fields inherited from class java.io.[Reader](../../java/io/Reader.html "class in java.io")  
 `[lock](../../java/io/Reader.html#lock)`

Constructor Summary

Constructors

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

Methods

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.

   * ### Methods inherited from class java.io.[Reader](../../java/io/Reader.html "class in java.io")  
   `[mark](../../java/io/Reader.html#mark%28int%29), [markSupported](../../java/io/Reader.html#markSupported%28%29), [read](../../java/io/Reader.html#read%28char[]%29), [read](../../java/io/Reader.html#read%28java.nio.CharBuffer%29), [reset](../../java/io/Reader.html#reset%28%29), [skip](../../java/io/Reader.html#skip%28long%29)`  
   * ### Methods inherited from class java.lang.[Object](../../java/lang/Object.html "class in java.lang")  
   `[clone](../../java/lang/Object.html#clone%28%29), [equals](../../java/lang/Object.html#equals%28java.lang.Object%29), [finalize](../../java/lang/Object.html#finalize%28%29), [getClass](../../java/lang/Object.html#getClass%28%29), [hashCode](../../java/lang/Object.html#hashCode%28%29), [notify](../../java/lang/Object.html#notify%28%29), [notifyAll](../../java/lang/Object.html#notifyAll%28%29), [toString](../../java/lang/Object.html#toString%28%29), [wait](../../java/lang/Object.html#wait%28%29), [wait](../../java/lang/Object.html#wait%28long%29), [wait](../../java/lang/Object.html#wait%28long,%20int%29)`

Constructor Detail

 * #### PipedReader  
 public PipedReader([PipedWriter](../../java/io/PipedWriter.html "class in java.io") src)  
             throws [IOException](../../java/io/IOException.html "class in java.io")  
 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](../../java/io/IOException.html "class in java.io")` \- if an I/O error occurs.  
 * #### PipedReader  
 public PipedReader([PipedWriter](../../java/io/PipedWriter.html "class in java.io") src,  
            int pipeSize)  
             throws [IOException](../../java/io/IOException.html "class in java.io")  
 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](../../java/io/IOException.html "class in java.io")` \- if an I/O error occurs.  
 `[IllegalArgumentException](../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if `pipeSize <= 0`.  
 Since:  
 1.6  
 * #### PipedReader  
 public PipedReader()  
 Creates a `PipedReader` so that it is not yet [connected](../../java/io/PipedReader.html#connect%28java.io.PipedWriter%29). It must be [connected](../../java/io/PipedWriter.html#connect%28java.io.PipedReader%29) to a `PipedWriter` before being used.  
 * #### PipedReader  
 public PipedReader(int pipeSize)  
 Creates a `PipedReader` so that it is not yet[connected](../../java/io/PipedReader.html#connect%28java.io.PipedWriter%29) and uses the specified pipe size for the pipe's buffer. It must be [connected](../../java/io/PipedWriter.html#connect%28java.io.PipedReader%29) to a `PipedWriter` before being used.  
 Parameters:  
 `pipeSize` \- the size of the pipe's buffer.  
 Throws:  
 `[IllegalArgumentException](../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if `pipeSize <= 0`.  
 Since:  
 1.6

Method Detail

* #### connect  
public void connect([PipedWriter](../../java/io/PipedWriter.html "class in java.io") src)  
             throws [IOException](../../java/io/IOException.html "class in java.io")  
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](../../java/io/IOException.html "class in java.io")` \- if an I/O error occurs.  
* #### read  
public int read()  
         throws [IOException](../../java/io/IOException.html "class in java.io")  
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.  
**Overrides:**  
`[read](../../java/io/Reader.html#read%28%29)` in class `[Reader](../../java/io/Reader.html "class in java.io")`  
Returns:  
the next character of data, or `-1` if the end of the stream is reached.  
Throws:  
`[IOException](../../java/io/IOException.html "class in java.io")` \- if the pipe is[ broken](PipedInputStream.html#BROKEN),[unconnected](../../java/io/PipedReader.html#connect%28java.io.PipedWriter%29), closed, or an I/O error occurs.  
* #### read  
public int read(char[] cbuf,  
       int off,  
       int len)  
         throws [IOException](../../java/io/IOException.html "class in java.io")  
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.  
**Specified by:**  
`[read](../../java/io/Reader.html#read%28char[],%20int,%20int%29)` in class `[Reader](../../java/io/Reader.html "class in java.io")`  
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](../../java/io/IOException.html "class in java.io")` \- if the pipe is[ broken](PipedInputStream.html#BROKEN),[unconnected](../../java/io/PipedReader.html#connect%28java.io.PipedWriter%29), closed, or an I/O error occurs.  
* #### ready  
public boolean ready()  
              throws [IOException](../../java/io/IOException.html "class in java.io")  
Tell whether this stream is ready to be read. A piped character stream is ready if the circular buffer is not empty.  
**Overrides:**  
`[ready](../../java/io/Reader.html#ready%28%29)` in class `[Reader](../../java/io/Reader.html "class in java.io")`  
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](../../java/io/IOException.html "class in java.io")` \- if the pipe is[ broken](PipedInputStream.html#BROKEN),[unconnected](../../java/io/PipedReader.html#connect%28java.io.PipedWriter%29), or closed.  
* #### close  
public void close()  
           throws [IOException](../../java/io/IOException.html "class in java.io")  
Closes this piped stream and releases any system resources associated with the stream.  
**Specified by:**  
`[close](../../java/io/Closeable.html#close%28%29)` in interface `[Closeable](../../java/io/Closeable.html "interface in java.io")`  
**Specified by:**  
`[close](../../java/lang/AutoCloseable.html#close%28%29)` in interface `[AutoCloseable](../../java/lang/AutoCloseable.html "interface in java.lang")`  
**Specified by:**  
`[close](../../java/io/Reader.html#close%28%29)` in class `[Reader](../../java/io/Reader.html "class in java.io")`  
Throws:  
`[IOException](../../java/io/IOException.html "class in java.io")` \- 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.

PipedReader (Java Platform SE 7 ) (original) (raw)

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail