1. Description
2. Constructor Summary
3. Method Summary
4. Constructor Details
   1. PipedOutputStream(PipedInputStream)
   2. PipedOutputStream()
5. Method Details
   1. connect(PipedInputStream)
   2. write(int)
   3. write(byte[], int, int)
   4. flush()
   5. close()

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

• Constructor Summary

  Constructors
  Constructor

  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

  All MethodsInstance MethodsConcrete Methods

  Modifier and Type

  Method

  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 declared in class java.io.OutputStream

  nullOutputStream, write

  Methods declared in class java.lang.Object

  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

• Constructor Details

  • PipedOutputStream

    public PipedOutputStream(PipedInputStream snk) throws IOException

    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 - 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)
    • connect(java.io.PipedInputStream)

• Method Details

  • connect

    public void connect(PipedInputStream snk) throws IOException

    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:

    Copy [Copy snippet]

        src.connect(snk)
    

    or the call:

    Copy [Copy snippet]

        snk.connect(src)
    

    The two calls have the same effect.

    Parameters:

    snk - the piped input stream to connect to.

    Throws:

    IOException - if an I/O error occurs.

  • write

    public void write(int b) throws IOException

    Writes the specified byte to the piped output stream.

    Implements the write method of OutputStream.

    Specified by:

    write in class OutputStream

    Parameters:

    b - the byte to be written.

    Throws:

    IOException - if the pipe is broken, unconnected, closed, or if an I/O error occurs.

  • write

    public void write(byte[] b, int off, int len) throws IOException

    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 in class OutputStream

    Parameters:

    b - the data.

    off - the start offset in the data.

    len - the number of bytes to write.

    Throws:

    IOException - if the pipe is broken, unconnected, closed, or if an I/O error occurs.

    IndexOutOfBoundsException - If off is negative, len is negative, or len is greater than b.length - off

  • flush

    public void flush() throws IOException

    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 in interface Flushable

    Overrides:

    flush in class OutputStream

    Throws:

    IOException - 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 bytes.

    Specified by:

    close in interface AutoCloseable

    Specified by:

    close in interface Closeable

    Overrides:

    close in class OutputStream

    Throws:

    IOException - if an I/O error occurs.

Report a bug or suggest an enhancement
For further API reference and developer documentation see the Java SE Documentation, which contains more detailed, developer-targeted descriptions with conceptual overviews, definitions of terms, workarounds, and working code examples. Other versions.
Java is a trademark or registered trademark of Oracle and/or its affiliates in the US and other countries.
Copyright © 1993, 2025, Oracle and/or its affiliates, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
All rights reserved. Use is subject to license terms and the documentation redistribution policy.