PipedOutputStream (Java Platform SE 7 ) (original) (raw)

• java.lang.Object

• • java.io.OutputStream
  • • java.io.PipedOutputStream

• All Implemented Interfaces:
  Closeable, Flushable, AutoCloseable

public class PipedOutputStream
extends OutputStream
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 aPipedOutputStream 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:
JDK1.0
See Also:
PipedInputStream

• • Constructor Summary

  Constructors

  Constructor and Description
  PipedOutputStream() Creates a piped output stream that is not yet connected to a piped input stream.
  PipedOutputStream(PipedInputStream snk) Creates a piped output stream connected to the specified piped input stream.

  • Method Summary

  Methods

  Modifier and Type	Method and Description
  void	close() Closes this piped output stream and releases any system resources associated with this stream.
  void	connect(PipedInputStream snk) Connects this piped output stream to a receiver.
  void	flush() 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	write(int b) Writes the specified byte to the piped output stream.

     * ### Methods inherited from class java.io.[OutputStream](../../java/io/OutputStream.html "class in java.io")  
     `[write](../../java/io/OutputStream.html#write%28byte[]%29)`  
     * ### Methods inherited from class java.lang.[Object](../../java/lang/Object.html "class in java.lang")  
     `[clone](../../java/lang/Object.html#clone%28%29), [equals](../../java/lang/Object.html#equals%28java.lang.Object%29), [finalize](../../java/lang/Object.html#finalize%28%29), [getClass](../../java/lang/Object.html#getClass%28%29), [hashCode](../../java/lang/Object.html#hashCode%28%29), [notify](../../java/lang/Object.html#notify%28%29), [notifyAll](../../java/lang/Object.html#notifyAll%28%29), [toString](../../java/lang/Object.html#toString%28%29), [wait](../../java/lang/Object.html#wait%28%29), [wait](../../java/lang/Object.html#wait%28long%29), [wait](../../java/lang/Object.html#wait%28long,%20int%29)`

• • Constructor Detail

     * #### PipedOutputStream  
     public PipedOutputStream([PipedInputStream](../../java/io/PipedInputStream.html "class in java.io") snk)  
                       throws [IOException](../../java/io/IOException.html "class in java.io")  
     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:  
     `[IOException](../../java/io/IOException.html "class in java.io")` \- if an I/O error occurs.  
     * #### PipedOutputStream  
     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:  
     [PipedInputStream.connect(java.io.PipedOutputStream)](../../java/io/PipedInputStream.html#connect%28java.io.PipedOutputStream%29), [connect(java.io.PipedInputStream)](../../java/io/PipedOutputStream.html#connect%28java.io.PipedInputStream%29)  

  • Method Detail

    * #### connect  
    public void connect([PipedInputStream](../../java/io/PipedInputStream.html "class in java.io") snk)  
                 throws [IOException](../../java/io/IOException.html "class in java.io")  
    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:  
    `[IOException](../../java/io/IOException.html "class in java.io")` \- if an I/O error occurs.  
    * #### write  
    public void write(int b)  
               throws [IOException](../../java/io/IOException.html "class in java.io")  
    Writes the specified `byte` to the piped output stream.  
     Implements the `write` method of `OutputStream`.  
    **Specified by:**  
    `[write](../../java/io/OutputStream.html#write%28int%29)` in class `[OutputStream](../../java/io/OutputStream.html "class in java.io")`  
    Parameters:  
    `b` \- the `byte` to be written.  
    Throws:  
    `[IOException](../../java/io/IOException.html "class in java.io")` \- if the pipe is [ broken](#BROKEN),[unconnected](../../java/io/PipedOutputStream.html#connect%28java.io.PipedInputStream%29), closed, or if an I/O error occurs.  
    * #### write  
    public void write(byte[] b,  
             int off,  
             int len)  
               throws [IOException](../../java/io/IOException.html "class in java.io")  
    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:**  
    `[write](../../java/io/OutputStream.html#write%28byte[],%20int,%20int%29)` in class `[OutputStream](../../java/io/OutputStream.html "class in java.io")`  
    Parameters:  
    `b` \- the data.  
    `off` \- the start offset in the data.  
    `len` \- the number of bytes to write.  
    Throws:  
    `[IOException](../../java/io/IOException.html "class in java.io")` \- if the pipe is [ broken](#BROKEN),[unconnected](../../java/io/PipedOutputStream.html#connect%28java.io.PipedInputStream%29), closed, or if an I/O error occurs.  
    * #### flush  
    public void flush()  
               throws [IOException](../../java/io/IOException.html "class in java.io")  
    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:**  
    `[flush](../../java/io/Flushable.html#flush%28%29)` in interface `[Flushable](../../java/io/Flushable.html "interface in java.io")`  
    **Overrides:**  
    `[flush](../../java/io/OutputStream.html#flush%28%29)` in class `[OutputStream](../../java/io/OutputStream.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](../../java/io/IOException.html "class in java.io")  
    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:**  
    `[close](../../java/io/Closeable.html#close%28%29)` in interface `[Closeable](../../java/io/Closeable.html "interface in java.io")`  
    **Specified by:**  
    `[close](../../java/lang/AutoCloseable.html#close%28%29)` in interface `[AutoCloseable](../../java/lang/AutoCloseable.html "interface in java.lang")`  
    **Overrides:**  
    `[close](../../java/io/OutputStream.html#close%28%29)` in class `[OutputStream](../../java/io/OutputStream.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 SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2020, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.