|
FlexDoc/Javadoc 2.0 Demo Java Doc |
Class PipedWriter
java.io.PipedWriter
All Implemented Interfaces:
public class PipedWriter
Piped character-output streams.
Since:
1.1
Author:
Mark Reinhold
Fields inherited from class java.io. Writer |
|
Constructor Summary |
Creates a piped writer that is not yet connected to a
piped reader.
|
Creates a piped writer connected to the specified piped
reader.
|
Method Summary |
void |
Closes this piped output stream and releases any system resources
associated with this stream.
|
void |
Connects this piped writer to a receiver.
|
void |
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 |
Writes the specified char to the piped output stream.
|
Methods inherited from class java.io. Writer |
|
Methods inherited from class java.lang. Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
public PipedWriter |
|
throws |
|
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:
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:
public void connect |
|
throws |
|
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:
public void write |
(int c) |
throws |
|
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:
Parameters:
c - the char to be written.
Throws:
public void write |
(char[] cbuf, int off, int len) |
throws |
|
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.
Overrides:
Parameters:
cbuf - the data.
off - the start offset in the data.
len - 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
public void flush |
() |
throws |
|
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:
Overrides:
Throws:
IOException - if the pipe is closed, or an I/O error occurs.
public void close |
() |
throws |
|
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:
Overrides:
Throws:
|
FlexDoc/Javadoc 2.0 Demo Java Doc |
FlexDoc/Javadoc is a template-driven programming tool for rapid development of any Javadoc-based Java API documentation generators (i.e. doclets). If you need to customize your Javadoc without writing a full-blown doclet from scratch,
FlexDoc/Javadoc may be the only tool able to help you! Find out more at
www.flexdoc.xyz