|
FlexDoc/Javadoc 2.0 Demo Java Doc |
Class PipedOutputStream
java.io.PipedOutputStream
All Implemented Interfaces:
public class PipedOutputStream
A piped output stream can be connected to a piped input stream
to create a communications pipe. The piped output stream is the
sending end of the pipe. Typically, data is written to a
PipedOutputStream object by one thread and data is
read from the connected
PipedInputStream by some
other thread. Attempting to use both objects from a single thread
is not recommended as it may deadlock the thread.
The pipe is said to be
broken if a
thread that was reading data bytes from the connected piped input
stream is no longer alive.
Since:
1.0
Author:
James Gosling
See Also:
Constructor Summary |
Creates a piped output stream that is not yet connected to a
piped input stream.
|
Creates a piped output stream connected to the specified piped
input stream.
|
Method Summary |
void |
Closes this piped output stream and releases any system resources
associated with this stream.
|
void |
Connects this piped output stream to a receiver.
|
void |
Flushes this output stream and forces any buffered output bytes
to be written out.
|
void |
write(byte[] b, int off, int len)
Writes len bytes from the specified byte array
starting at offset off to this piped output stream.
|
void |
Writes the specified byte to the piped output stream.
|
Methods inherited from class java.lang. Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
public PipedOutputStream |
|
throws |
|
Creates a piped output stream connected to the specified piped
input stream. Data bytes written to this stream will then be
available as input from
snk.
Parameters:
snk - The piped input stream to connect to.
Throws:
public PipedOutputStream |
() |
Creates a piped output stream that is not yet connected to a
piped input stream. It must be connected to a piped input stream,
either by the receiver or the sender, before being used.
See Also:
public void connect |
|
throws |
|
Connects this piped output stream to a receiver. If this object
is already connected to some other piped input stream, an
IOException is thrown.
If snk is an unconnected piped input stream and
src is an unconnected piped output stream, 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 input stream to connect to.
Throws:
public void write |
(int b) |
throws |
|
Writes the specified
byte to the piped output stream.
Implements the write method of OutputStream.
Overrides:
Parameters:
b - the byte to be written.
Throws:
public void write |
(byte[] b, int off, int len) |
throws |
|
Writes
len bytes from the specified byte array
starting at offset
off to this piped output stream.
This method blocks until all the bytes are written to the output
stream.
Overrides:
Parameters:
b - the data.
off - the start offset in the data.
len - the number of bytes to write.
Throws:
public void flush |
() |
throws |
|
Flushes this output stream and forces any buffered output bytes
to be written out.
This will notify any readers that bytes are waiting in the pipe.
Specified by:
Overrides:
Throws:
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 bytes.
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