java.io
Class PipedOutputStream

java.lang.Object
  extended by java.io.OutputStream
      extended by java.io.PipedOutputStream
All Implemented Interfaces:
Closeable, Flushable

public class PipedOutputStream
extends OutputStream

This class writes its bytes to a PipedInputStream to which it is connected.

It is highly recommended that a PipedOutputStream and its connected PipedInputStream be in different threads. If they are in the same thread, read and write operations could deadlock the thread.


Constructor Summary
PipedOutputStream()
          Create an unconnected PipedOutputStream.
PipedOutputStream(PipedInputStream sink)
          Create a new PipedOutputStream instance to write to the specified PipedInputStream.
 
Method Summary
 void close()
          This method closes this stream so that no more data can be written to it.
 void connect(PipedInputStream sink)
          Connects this object to the specified PipedInputStream object.
 void flush()
          This method does nothing.
 void write(byte[] buffer, int offset, int len)
          This method writes len bytes of data from the byte array buf starting at index offset in the array to the stream.
 void write(int b)
          Write a single byte of date to the stream.
 
Methods inherited from class java.io.OutputStream
write
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PipedOutputStream

public PipedOutputStream()
Create an unconnected PipedOutputStream. It must be connected to a PipedInputStream using the connect method prior to writing any data or an exception will be thrown.


PipedOutputStream

public PipedOutputStream(PipedInputStream sink)
                  throws IOException
Create a new PipedOutputStream instance to write to the specified PipedInputStream. This stream is then ready for writing.

Parameters:
sink - The PipedInputStream to connect this stream to.
Throws:
IOException - If sink has already been connected to a different PipedOutputStream.
Method Detail

connect

public void connect(PipedInputStream sink)
             throws IOException
Connects this object to the specified PipedInputStream object. This stream will then be ready for writing.

Parameters:
sink - The PipedInputStream to connect this stream to
Throws:
IOException - If the stream has not been connected or has been closed.

write

public void write(int b)
           throws IOException
Write a single byte of date to the stream. Note that this method will block if the PipedInputStream to which this object is connected has a full buffer.

Specified by:
write in class OutputStream
Parameters:
b - The byte of data to be written, passed as an int.
Throws:
IOException - If the stream has not been connected or has been closed.

write

public void write(byte[] buffer,
                  int offset,
                  int len)
           throws IOException
This method writes len bytes of data from the byte array buf starting at index offset in the array to the stream. Note that this method will block if the PipedInputStream to which this object is connected has a buffer that cannot hold all of the bytes to be written.

Overrides:
write in class OutputStream
Parameters:
buffer - The array containing bytes to write to the stream.
offset - The index into the array to start writing bytes from.
len - The number of bytes to write.
Throws:
IOException - If the stream has not been connected or has been closed.

flush

public void flush()
           throws IOException
This method does nothing.

Specified by:
flush in interface Flushable
Overrides:
flush in class OutputStream
Throws:
IOException - If the stream is closed.

close

public void close()
           throws IOException
This method closes this stream so that no more data can be written to it. Any further attempts to write to this stream may throw an exception

Specified by:
close in interface Closeable
Overrides:
close in class OutputStream
Throws:
IOException - If an error occurs