Class PipedWriter

java.lang.Object
java.io.Writer
java.io.PipedWriter
All Implemented Interfaces:
Closeable,Flushable,Appendable,AutoCloseable
public classPipedWriterextendsWriter
Piped character-output streams.
Since:
1.1

  • Field Summary

    Fields declared in class java.io.Writer

    lock

  • Constructor Summary

    Constructors
    Constructor
    Description
    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

    Modifier and Type
    Method
    Description
    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)
    Writeslen characters from the specified character array starting at offsetoff to this piped output stream.
    void
    write(int c)
    Writes the specifiedchar to the piped output stream.

    Methods declared in class java.io.Writer

    append,append,append,nullWriter,write,write,write

  • Constructor Details

    • PipedWriter

      public PipedWriter(PipedReader snk) throwsIOException
      Creates a piped writer connected to the specified piped reader. Data characters written to this stream will then be available as input fromsnk.
      Parameters:
      snk - The piped reader to connect to.
      Throws:
      IOException - if an I/O error occurs.

    • PipedWriter

      public PipedWriter()
      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:

  • Method Details

    • connect

      public void connect(PipedReader snk) throwsIOException
      Connects this piped writer to a receiver. If this object is already connected to some other piped reader, anIOException is thrown.

      Ifsnk is an unconnected piped reader andsrc 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:
      IOException - if an I/O error occurs.

    • write

      public void write(int c) throwsIOException
      Writes the specifiedchar 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 anIOException is thrown.

      Implements thewrite method ofWriter.

      Overrides:
      write in class Writer
      Parameters:
      c - thechar to be written.
      Throws:
      IOException - if the pipe isbroken,unconnected, closed or an I/O error occurs.

    • write

      public void write(char[] cbuf, int off, int len) throwsIOException
      Writeslen characters from the specified character array starting at offsetoff 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 anIOException is thrown.
      Specified by:
      write in class Writer
      Parameters:
      cbuf - the data.
      off - the start offset in the data.
      len - the number of characters to write.
      Throws:
      IndexOutOfBoundsException - Ifoff is negative, orlen is negative, oroff + len is negative or greater than the length of the given array
      IOException - if the pipe isbroken,unconnected, closed or an I/O error occurs.

    • flush

      public void flush() throwsIOException
      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:
      flush in interface Flushable
      Specified by:
      flush in class Writer
      Throws:
      IOException - if the pipe is closed, or an I/O error occurs.

    • close

      public void close() throwsIOException
      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:
      close in interface AutoCloseable
      Specified by:
      close in interface Closeable
      Specified by:
      close in class Writer
      Throws:
      IOException - if an I/O error occurs.