PipedWriter

public class PipedWriter
extends Writer

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


Piped character-output streams.

Summary

Inherited fields

Public constructors

PipedWriter(PipedReader snk)

Creates a piped writer connected to the specified piped reader.

PipedWriter()

Creates a piped writer that is not yet connected to a 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

Public constructors

PipedWriter

added in API level 1
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.

PipedWriter

added in API level 1
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.

Public methods

close

added in API level 1
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
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
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
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
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
IOException if the pipe is broken, unconnected, closed or an I/O error occurs.