java.io
Class PipedWriter

java.lang.Object
  |
  +--java.io.Writer
        |
        +--java.io.PipedWriter

public class PipedWriter

extends Writer

Untamed: Piped character-output streams.

Since:

JDK1.1

Version:

1.14, 01/12/03

Author:

Mark Reinhold

Field Summary

private boolean	closed
private PipedReader	sink

Fields inherited from class java.io.Writer

lock

Constructor Summary

PipedWriter()
Enabled: Creates a piped writer that is not yet connected to a piped reader.

PipedWriter(PipedReader snk)
Enabled: Creates a piped writer connected to the specified piped reader.

Method Summary

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

Methods inherited from class java.io.Writer

write, write, write

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

sink

private PipedReader sink

closed

private boolean closed

Constructor Detail

PipedWriter

public PipedWriter(PipedReader snk)
            throws IOException

Enabled: 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 - The piped reader to connect to.

PipedWriter

public PipedWriter()

Enabled: 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:

java.io.PipedReader#connect(java.io.PipedWriter), java.io.PipedWriter#connect(java.io.PipedReader)

Method Detail

connect

public void connect(PipedReader snk)
             throws IOException

Enabled: 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 - the piped reader to connect to.

IOException

write

public void write(int c)
           throws IOException

Enabled: 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.

Overrides:

write in class Writer

Parameters:

c - the char to be written.

IOException

write

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

Enabled: Writes len characters from the specified character array starting at offset off to this 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.

Specified by:

write in class Writer

Parameters:

cbuf - the data.

off - the start offset in the data.

len - the number of characters to write.

IOException

flush

public void flush()
           throws IOException

Enabled: 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.

Specified by:

flush in class Writer

IOException

close

public void close()
           throws IOException

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

Specified by:

close in class Writer

IOException