Added in API level 1

Summary: Inherited Fields | Ctors | Methods | Inherited Methods

PipedWriter

public class PipedWriter
extends Writer

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

Piped character-output streams.

Summary

Inherited fields

From class java.io.Writer


    protected
    
    
    Object

lock

The object used to synchronize operations on this stream.

Public constructors
`PipedWriter()` Creates a piped writer that is not yet connected to a piped reader.
`PipedWriter(PipedReader snk)` Creates a piped writer connected to the specified piped reader.

Public methods
`void`	`close()` Closes this piped output stream and releases any system resources associated with this stream.
`void`	`connect(PipedReader snk)` Connects this piped writer to a receiver.
`void`	`flush()` Flushes this output stream and forces any buffered output characters to be written out.
`void`	`write(int c)` Writes the specified `char` to the piped output stream.
`void`	`write(char[] cbuf, int off, int len)` Writes `len` characters from the specified character array starting at offset `off` to this piped output stream.

Inherited methods

From class


        
          java.io.Writer

`Writer`	`append(char c)` Appends the specified character to this writer.
`Writer`	`append(CharSequence csq, int start, int end)` Appends a subsequence of the specified character sequence to this writer.
`Writer`	`append(CharSequence csq)` Appends the specified character sequence to this writer.
`abstract void`	`close()` Closes the stream, flushing it first.
`abstract void`	`flush()` Flushes the stream.
`static Writer`	`nullWriter()` Returns a new `Writer` which discards all characters.
`void`	`write(String str)` Writes a string.
`void`	`write(int c)` Writes a single character.
`void`	`write(String str, int off, int len)` Writes a portion of a string.
`abstract void`	`write(char[] cbuf, int off, int len)` Writes a portion of an array of characters.
`void`	`write(char[] cbuf)` Writes an array of characters.

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

From interface


        
          java.lang.Appendable

`abstract Appendable`	`append(char c)` Appends the specified character to this `Appendable`.
`abstract Appendable`	`append(CharSequence csq, int start, int end)` Appends a subsequence of the specified character sequence to this `Appendable`.
`abstract Appendable`	`append(CharSequence csq)` Appends the specified character sequence to this `Appendable`.

From interface


        
          java.io.Closeable


      close()

Closes this stream and releases any system resources associated with it.

From interface


        
          java.io.Flushable


      flush()

Flushes this stream by writing any buffered output to the underlying stream.

From interface


        
          java.lang.AutoCloseable


      close()

Closes this resource, relinquishing any underlying resources.

Public constructors

PipedWriter

Added in API level 1

public PipedWriter ()

Creates a piped writer that is not yet connected to a piped reader. It must be connected to a piped reader, either by the receiver or the sender, before being used.

See also:

PipedWriter

Added in API level 1

public PipedWriter (PipedReader snk)

Creates a piped writer connected to the specified piped reader. Data characters written to this stream will then be available as input from snk.

Parameters
`snk`	`PipedReader`: The piped reader to connect to.

Throws
`IOException`	if an I/O error occurs.

Public methods

close

Added in API level 1

public void close ()

Closes this piped output stream and releases any system resources associated with this stream. This stream may no longer be used for writing characters.

Throws
`IOException`	if an I/O error occurs.

connect

Added in API level 1

public void connect (PipedReader snk)

Connects this piped writer to a receiver. If this object is already connected to some other piped reader, an IOException is thrown.

If snk is an unconnected piped reader and src is an unconnected piped writer, they may be connected by either the call:

 src.connect(snk)

or the call:

 snk.connect(src)

The two calls have the same effect.

Parameters
`snk`	`PipedReader`: the piped reader to connect to.

Throws
`IOException`	if an I/O error occurs.

flush

Added in API level 1

public void flush ()

Flushes this output stream and forces any buffered output characters to be written out. This will notify any readers that characters are waiting in the pipe.

Throws
`IOException`	if the pipe is closed, or an I/O error occurs.

write

Added in API level 1

public void write (int c)

Writes the specified char to the piped output stream. If a thread was reading data characters from the connected piped input stream, but the thread is no longer alive, then an IOException is thrown.

Implements the write method of Writer.

Parameters
`c`	`int`: the `char` to be written.

Throws
`IOException`	if the pipe is `broken`, `unconnected`, closed or an I/O error occurs.

write

Added in API level 1

public void write (char[] cbuf, 
                int off, 
                int len)

Writes len characters from the specified character array starting at offset off to this piped output stream. This method blocks until all the characters are written to the output stream. If a thread was reading data characters from the connected piped input stream, but the thread is no longer alive, then an IOException is thrown.

Parameters
`cbuf`	`char`: the data.
`off`	`int`: the start offset in the data.
`len`	`int`: the number of characters to write.

Throws
`IndexOutOfBoundsException`	If `off` is negative, or `len` is negative, or `off + len` is negative or greater than the length of the given array
`IOException`	if the pipe is `broken`, `unconnected`, closed or an I/O error occurs.