Class PipedWriter
java.lang.Object
java.io.Writer
java.io.PipedWriter
- All Implemented Interfaces:
Closeable
,Flushable
,Appendable
,AutoCloseable
-
Field Summary
-
Constructor Summary
ConstructorDescriptionCreates a piped writer that is not yet connected to a piped reader.PipedWriter
(PipedReader snk) Creates a piped writer connected to the specified piped reader. -
Method Summary
Modifier and TypeMethodDescriptionvoid
close()
Closes this piped output stream and releases any system resources associated with this stream.void
connect
(PipedReader snk) Connects this piped writer to a receiver.void
flush()
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.
-
Constructor Details
-
PipedWriter
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
Connects this piped writer to a receiver. If this object is already connected to some other piped reader, anIOException
is thrown.If
snk
is an unconnected piped reader andsrc
is an unconnected piped writer, they may be connected by either the call:src.connect(snk)
snk.connect(src)
- Parameters:
snk
- the piped reader to connect to.- Throws:
IOException
- if an I/O error occurs.
-
write
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 the
write
method ofWriter
.- Overrides:
write
in classWriter
- Parameters:
c
- thechar
to be written.- Throws:
IOException
- if the pipe isbroken
,unconnected
, closed or an I/O error occurs.
-
write
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 classWriter
- 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 arrayIOException
- if the pipe isbroken
,unconnected
, closed or an I/O error occurs.
-
flush
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 interfaceFlushable
- Specified by:
flush
in classWriter
- Throws:
IOException
- if the pipe is closed, or an I/O error occurs.
-
close
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 interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Specified by:
close
in classWriter
- Throws:
IOException
- if an I/O error occurs.
-