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

PipedWriter

extends Writer

java.lang.Object
↳	java.io.Writer
	↳	java.io.PipedWriter

Class Overview

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

Public Constructors
	PipedWriter() Constructs a new unconnected `PipedWriter`.
	PipedWriter( PipedReader destination) Constructs a new `PipedWriter` connected to `destination`.

Public Methods
void	close() Closes this writer.
void	connect( PipedReader reader) Connects this `PipedWriter` to a `PipedReader`.
void	flush() Notifies the readers of this `PipedReader` that characters can be read.
void	write(char[] buffer, int offset, int count) Writes `count` characters from the character array `buffer` starting at offset `index` to this writer.
void	write(int c) Writes a single character `c` to this writer.

[Expand]

Inherited Methods

From class java.io.Writer

Writer	append( CharSequence csq) Appends the character sequence `csq` to the target.
Writer	append( CharSequence csq, int start, int end) Appends a subsequence of the character sequence `csq` to the target.
Writer	append(char c) Appends the character `c` to the target.
abstract void	close() Closes this writer.
abstract void	flush() Flushes this writer.
void	write(char[] buf) Writes the entire character buffer `buf` to the target.
void	write( String str) Writes the characters from the specified string to the target.
abstract void	write(char[] buf, int offset, int count) Writes `count` characters starting at `offset` in `buf` to the target.
void	write( String str, int offset, int count) Writes `count` characters from `str` starting at `offset` to the target.
void	write(int oneChar) Writes one character to the target.

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

From interface java.lang.Appendable

Public Constructors

public PipedWriter ()

Added in API level 1

Constructs a new unconnected PipedWriter. The resulting writer must be connected to a PipedReader before data may be written to it.

public PipedWriter (PipedReader destination)

Added in API level 1

Constructs a new PipedWriter connected to destination. Any data written to this writer can be read from destination.

Parameters

destination	the `PipedReader` to connect to.

Throws

IOException	if `destination` is already connected.

Public Methods

public void close ()

Added in API level 1

Closes this writer. If a PipedReader is connected to this writer, it is closed as well and the pipe is disconnected. Any data buffered in the reader can still be read.

Throws

IOException	if an error occurs while closing this writer.

public void connect (PipedReader reader)

Added in API level 1

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

Parameters

reader	the reader to connect to.

Throws

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

public void flush ()

Added in API level 1

Notifies the readers of this PipedReader that characters can be read. This method does nothing if this Writer is not connected.

Throws

IOException	if an I/O error occurs while flushing this writer.

public void write (char[] buffer, int offset, int count)

Added in API level 1

Writes count characters from the character array buffer starting at offset index to this writer. The written data can then be read from the connected PipedReader instance.

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

Parameters

buffer	the buffer to write.
offset	the index of the first character in `buffer` to write.
count	the number of characters from `buffer` to write to this writer.

Throws

IndexOutOfBoundsException	if `offset < 0` or `count < 0`, or if `offset + count` is bigger than the length of `buffer`.
InterruptedIOException	if the pipe is full and the current thread is interrupted waiting for space to write data. This case is not currently handled correctly.
IOException	if this writer is closed or not connected, if the target reader is closed or if the thread reading from the target reader is no longer alive. This case is currently not handled correctly.
NullPointerException	if `buffer` is `null`.

public void write (int c)

Added in API level 1

Writes a single character c to this writer. This character can then be read from the connected PipedReader instance.

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

Parameters

c	the character to write.

Throws

InterruptedIOException	if the pipe is full and the current thread is interrupted waiting for space to write data. This case is not currently handled correctly.
IOException	if this writer is closed or not connected, if the target reader is closed or if the thread reading from the target reader is no longer alive. This case is currently not handled correctly.

information

No examples for this method.

Frequently called with: [Clear]

This example was provided by APIMiner.

Portions of this page are reproduced from work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. The original page is available here.

Results

Interfaces

Classes

Exceptions

Errors

PipedWriter

Class Overview

See Also

Summary

Public Constructors

public PipedWriter ()

See Also

public PipedWriter (PipedReader destination)

Parameters

Throws

Public Methods

public void close ()

Throws

public void connect (PipedReader reader)

Parameters

Throws

public void flush ()

Throws

public void write (char[] buffer, int offset, int count)

Parameters

Throws

public void write (int c)

Parameters

Throws