PipedWriter (Java 2 Platform SE 5.0) (original) (raw)

java.io

Class PipedWriter

java.lang.Object extended by java.io.Writer java.io.PipedWriter

All Implemented Interfaces:

Closeable, Flushable, Appendable

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](../../java/io/PipedWriter.html#write%28char[], int, int%29)(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
append, append, [append](../../java/io/Writer.html#append%28java.lang.CharSequence, int, int%29), write, write, [write](../../java/io/Writer.html#write%28java.lang.String, int, int%29)

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, [wait](../../java/lang/Object.html#wait%28long, int%29)

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](../../java/io/IOException.html "class in java.io") - 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.

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](../../java/io/IOException.html "class in java.io") - 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](../../java/io/Writer.html#write%28int%29) in class [Writer](../../java/io/Writer.html "class in java.io")

Parameters:

c - the char to be written.

Throws:

[IOException](../../java/io/IOException.html "class in java.io") - 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](../../java/io/Writer.html#write%28char[], int, int%29) in class [Writer](../../java/io/Writer.html "class in java.io")

Parameters:

cbuf - the data.

off - the start offset in the data.

len - the number of characters to write.

Throws:

[IOException](../../java/io/IOException.html "class in java.io") - 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](../../java/io/Flushable.html#flush%28%29) in interface [Flushable](../../java/io/Flushable.html "interface in java.io")

Specified by:

[flush](../../java/io/Writer.html#flush%28%29) in class [Writer](../../java/io/Writer.html "class in java.io")

Throws:

[IOException](../../java/io/IOException.html "class in java.io") - 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](../../java/io/Closeable.html#close%28%29) in interface [Closeable](../../java/io/Closeable.html "interface in java.io")

Specified by:

[close](../../java/io/Writer.html#close%28%29) in class [Writer](../../java/io/Writer.html "class in java.io")

Throws:

[IOException](../../java/io/IOException.html "class in java.io") - if an I/O error occurs.

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.