Home How it Works Android APIMiner IDE Version More Info

to top

Summary: Inherited Fields | Ctors | Methods | Inherited Methods | [Expand All]

Added in API level 1

public class

PipedReader

extends Reader

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

Class Overview

Receives information on a communications pipe. When two threads want to pass data back and forth, one creates a piped writer and the other creates a piped reader.

Summary

[Expand]

Inherited Fields

From class java.io.Reader

Public Constructors
	PipedReader() Constructs a new unconnected `PipedReader`.
	PipedReader( PipedWriter out) Constructs a new `PipedReader` connected to the `PipedWriter` `out`.
	PipedReader(int pipeSize) Constructs a new unconnected `PipedReader` with the given buffer size.
	PipedReader( PipedWriter out, int pipeSize) Constructs a new `PipedReader` connected to the given `PipedWriter`, with the given buffer size.

Public Methods
synchronized void	close() Closes this reader.
void	connect( PipedWriter src) Connects this `PipedReader` to a `PipedWriter`.
int	read() Reads a single character from this reader and returns it as an integer with the two higher-order bytes set to 0.
synchronized int	read(char[] buffer, int offset, int count) Reads at most `count` characters from this reader and stores them in the character array `buffer` starting at `offset`.
synchronized boolean	ready() Indicates whether this reader is ready to be read without blocking.

[Expand]

Inherited Methods

From class java.io.Reader

abstract void	close() Closes this reader.
void	mark(int readLimit) Sets a mark position in this reader.
boolean	markSupported() Indicates whether this reader supports the `mark()` and `reset()` methods.
int	read() Reads a single character from this reader and returns it as an integer with the two higher-order bytes set to 0.
abstract int	read(char[] buf, int offset, int count) Reads at most `count` characters from this reader and stores them at `offset` in the character array `buf`.
int	read( CharBuffer target) Reads characters and puts them into the `target` character buffer.
int	read(char[] buf) Reads characters from this reader and stores them in the character array `buf` starting at offset 0.
boolean	ready() Indicates whether this reader is ready to be read without blocking.
void	reset() Resets this reader's position to the last `mark()` location.
long	skip(long charCount) Skips `charCount` characters in this reader.

From class java.lang.Object

Object	clone() Creates and returns a copy of this `Object`.
boolean	equals( Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of `Class` that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait(long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait(long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

From interface java.io.Closeable

From interface java.lang.Readable

Public Constructors

public PipedReader ()

Added in API level 1

Constructs a new unconnected PipedReader. The resulting reader must be connected to a PipedWriter before data may be read from it.

public PipedReader (PipedWriter out)

Added in API level 1

Constructs a new PipedReader connected to the PipedWriter out. Any data written to the writer can be read from the this reader.

Parameters

out	the `PipedWriter` to connect to.

Throws

IOException	if `out` is already connected.

public PipedReader (int pipeSize)

Added in API level 9

Constructs a new unconnected PipedReader with the given buffer size. The resulting reader must be connected to a PipedWriter before data may be read from it.

Parameters

pipeSize	the size of the buffer in chars.

Throws

IllegalArgumentException	if pipeSize is less than or equal to zero.

public PipedReader (PipedWriter out, int pipeSize)

Added in API level 9

Constructs a new PipedReader connected to the given PipedWriter, with the given buffer size. Any data written to the writer can be read from this reader.

Parameters

out	the `PipedWriter` to connect to.
pipeSize	the size of the buffer in chars.

Throws

IOException	if an I/O error occurs
IllegalArgumentException	if pipeSize is less than or equal to zero.

Public Methods

public synchronized void close ()

Added in API level 1

Closes this reader. This implementation releases the buffer used for the pipe and notifies all threads waiting to read or write.

Throws

IOException	if an error occurs while closing this reader.

public void connect (PipedWriter src)

Added in API level 1

Connects this PipedReader to a PipedWriter. Any data written to the writer becomes readable in this reader.

Parameters

src	the writer to connect to.

Throws

IOException	if this reader is closed or already connected, or if `src` is already connected.

public int read ()

Added in API level 1

Reads a single character from this reader and returns it as an integer with the two higher-order bytes set to 0. Returns -1 if the end of the reader has been reached. If there is no data in the pipe, this method blocks until data is available, the end of the reader is detected or an exception is thrown.

Separate threads should be used to read from a PipedReader and to write to the connected PipedWriter. If the same thread is used, a deadlock may occur.

Returns

the character read or -1 if the end of the reader has been reached.

Throws

IOException	if this reader is closed or some other I/O error occurs.

public synchronized int read (char[] buffer, int offset, int count)

Added in API level 1

Reads at most count characters from this reader and stores them in the character array buffer starting at offset. If there is no data in the pipe, this method blocks until at least one byte has been read, the end of the reader is detected or an exception is thrown.

Separate threads should be used to read from a PipedReader and to write to the connected PipedWriter. If the same thread is used, a deadlock may occur.

Parameters

buffer	the character array in which to store the characters read.
offset	the initial position in `bytes` to store the characters read from this reader.
count	the maximum number of characters to store in `buffer`.

Returns

the number of characters read or -1 if the end of the reader has been reached.

Throws

IndexOutOfBoundsException	if `offset < 0` or `count < 0`, or if `offset + count` is greater than the size of `buffer`.
InterruptedIOException	if the thread reading from this reader is interrupted.
IOException	if this reader is closed or not connected to a writer, or if the thread writing to the connected writer is no longer alive.

public synchronized boolean ready ()

Added in API level 1

Indicates whether this reader is ready to be read without blocking. Returns true if this reader will not block when read is called, false if unknown or blocking will occur. This implementation returns true if the internal buffer contains characters that can be read.

Returns

always false.

Throws

IOException	if this reader is closed or not connected, or if some other I/O error occurs.

Results

Interfaces

Classes

Exceptions

Errors

PipedReader

Class Overview

See Also

Summary

Public Constructors

public PipedReader ()

public PipedReader (PipedWriter out)

Parameters

Throws

public PipedReader (int pipeSize)

Parameters

Throws

public PipedReader (PipedWriter out, int pipeSize)

Parameters

Throws

Public Methods

public synchronized void close ()

Throws

public void connect (PipedWriter src)

Parameters

Throws

public int read ()

Returns

Throws

public synchronized int read (char[] buffer, int offset, int count)

Parameters

Returns

Throws

public synchronized boolean ready ()

Returns

Throws

See Also