PipedWriter
open class PipedWriter : Writer
kotlin.Any | ||
↳ | java.io.Writer | |
↳ | java.io.PipedWriter |
Piped character-output streams.
Summary
Public constructors | |
---|---|
PipedWriter(snk: PipedReader!) Creates a piped writer connected to the specified piped reader. |
|
Creates a piped writer that is not yet connected to a piped reader. |
Public methods | |
---|---|
open Unit |
close() Closes this piped output stream and releases any system resources associated with this stream. |
open Unit |
connect(snk: PipedReader!) Connects this piped writer to a receiver. |
open Unit |
flush() Flushes this output stream and forces any buffered output characters to be written out. |
open Unit |
Writes the specified |
open Unit |
Writes |
Inherited functions | |
---|---|
Inherited properties | |
---|---|
Public constructors
PipedWriter
PipedWriter(snk: PipedReader!)
Creates a piped writer connected to the specified piped reader. Data characters written to this stream will then be available as input from snk
.
Parameters | |
---|---|
snk |
PipedReader!: The piped reader to connect to. |
Exceptions | |
---|---|
java.io.IOException |
if an I/O error occurs. |
PipedWriter
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.
Public methods
close
open fun close(): Unit
Closes this piped output stream and releases any system resources associated with this stream. This stream may no longer be used for writing characters.
Exceptions | |
---|---|
java.lang.Exception |
if this resource cannot be closed |
java.io.IOException |
If an I/O error occurs |
java.io.IOException |
if an I/O error occurs. |
connect
open fun connect(snk: PipedReader!): Unit
Connects this piped writer to a receiver. If this object is already connected to some other piped reader, an IOException
is thrown.
If snk
is an unconnected piped reader and src
is an unconnected piped writer, they may be connected by either the call:
src.connect(snk)
snk.connect(src)
Parameters | |
---|---|
snk |
PipedReader!: the piped reader to connect to. |
Exceptions | |
---|---|
java.io.IOException |
if an I/O error occurs. |
flush
open fun flush(): Unit
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.
Exceptions | |
---|---|
java.io.IOException |
If an I/O error occurs |
java.io.IOException |
if the pipe is closed, or an I/O error occurs. |
write
open fun write(c: Int): Unit
Writes the specified char
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 an IOException
is thrown.
Implements the write
method of Writer
.
Parameters | |
---|---|
c |
Int: the char to be written. |
Exceptions | |
---|---|
java.io.IOException |
If an I/O error occurs |
java.io.IOException |
if the pipe is broken , unconnected , closed or an I/O error occurs. |
write
open fun write(
cbuf: CharArray!,
off: Int,
len: Int
): Unit
Writes len
characters from the specified character array starting at offset off
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 an IOException
is thrown.
Parameters | |
---|---|
cbuf |
CharArray!: the data. |
off |
Int: the start offset in the data. |
len |
Int: the number of characters to write. |
Exceptions | |
---|---|
java.lang.IndexOutOfBoundsException |
If off is negative, or len is negative, or off + len is negative or greater than the length of the given array |
java.io.IOException |
if the pipe is broken , unconnected , closed or an I/O error occurs. |