Added in API level 1

PipedWriter

open class PipedWriter : Writer

kotlin.Any
↳	java.io.Writer
	↳	java.io.PipedWriter

Piped character-output streams.

Summary

Public constructors
`PipedWriter()` Creates a piped writer that is not yet connected to a piped reader.
`PipedWriter(snk: PipedReader!)` Creates a piped writer connected to the specified 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	`write(cbuf: CharArray!, off: Int, len: Int)` Writes `len` characters from the specified character array starting at offset `off` to this piped output stream.
open Unit	`write(c: Int)` Writes the specified `char` to the piped output stream.

Inherited functions

From class Writer

`Writer`	`append(c: Char)` Appends the specified character to this writer. An invocation of this method of the form `out.append(c)` behaves in exactly the same way as the invocation out.write(c)
`Writer`	`append(csq: CharSequence?)` Appends the specified character sequence to this writer. An invocation of this method of the form `out.append(csq)` behaves in exactly the same way as the invocation out.write(csq.toString()) Depending on the specification of `toString` for the character sequence `csq`, the entire sequence may not be appended. For instance, invoking the `toString` method of a character buffer will return a subsequence whose content depends upon the buffer's position and limit.
`Writer`	`append(csq: CharSequence?, start: Int, end: Int)` Appends a subsequence of the specified character sequence to this writer. `Appendable`. An invocation of this method of the form `out.append(csq, start, end)` when `csq` is not `null` behaves in exactly the same way as the invocation <code>out.write(csq.subSequence(start, end).toString()) </code>
`Writer!`	`nullWriter()` Returns a new `Writer` which discards all characters. The returned stream is initially open. The stream is closed by calling the `close()` method. Subsequent calls to `close()` have no effect. While the stream is open, the `append(char)`, `append(CharSequence)`, `append(CharSequence, int, int)`, `flush()`, `write(int)`, `write(char[])`, and `write(char[], int, int)` methods do nothing. After the stream has been closed, these methods all throw `IOException`. The `object` used to synchronize operations on the returned `Writer` is not specified.
`Unit`	`write(cbuf: CharArray!)` Writes an array of characters.
`Unit`	`write(str: String!)` Writes a string.
`Unit`	`write(str: String!, off: Int, len: Int)` Writes a portion of a string.

Inherited properties

From class Writer

Any!

lock

The object used to synchronize operations on this stream. For efficiency, a character-stream object may use an object other than itself to protect critical sections. A subclass should therefore use the object in this field rather than this or a synchronized method.

Public constructors

PipedWriter

Added in API level 1

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

PipedWriter

Added in API level 1

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.

Public methods

close

Added in API level 1

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

Added in API level 1

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)

or the call:

snk.connect(src)

The two calls have the same effect.

Parameters
`snk`	PipedReader!: the piped reader to connect to.

Exceptions
`java.io.IOException`	if an I/O error occurs.

flush

Added in API level 1

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

Added in API level 1

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.

write

Added in API level 1

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.