JavaTM 2 Platform
Std. Ed. v1.4.0

java.io
Class PipedWriter

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

public class PipedWriter
extends Writer

Piped character-output streams.

Since:
JDK1.1

Field Summary
 
Fields inherited from class java.io.Writer
lock
 
Constructor Summary
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.
 
Method Summary
 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(char[] cbuf, int off, int len)
          Writes len characters from the specified character array starting at offset off to this piped output stream.
 void write(int c)
          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
 

Constructor Detail

PipedWriter

public PipedWriter(PipedReader snk)
            throws IOException
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.
Throws:
IOException - if an I/O error occurs.

PipedWriter

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:
PipedReader.connect(java.io.PipedWriter), connect(java.io.PipedReader)
Method Detail

connect

public void connect(PipedReader snk)
             throws IOException
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.
Throws:
IOException - if an I/O error occurs.

write

public void write(int c)
           throws IOException
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.
Throws:
IOException - if an I/O error occurs.

write

public void write(char[] cbuf,
                  int off,
                  int len)
           throws IOException
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.
Throws:
IOException - if an I/O error occurs.

flush

public void flush()
           throws IOException
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
Throws:
IOException - if an I/O error occurs.

close

public void close()
           throws IOException
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
Throws:
IOException - if an I/O error occurs.

JavaTM 2 Platform
Std. Ed. v1.4.0

Submit a bug or feature
For further API reference and developer documentation, see Java 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.

Java, Java 2D, and JDBC are trademarks or registered trademarks of Sun Microsystems, Inc. in the US and other countries.
Copyright 1993-2002 Sun Microsystems, Inc. 901 San Antonio Road
Palo Alto, California, 94303, U.S.A. All Rights Reserved.