org.ka2ddo.yaac.io

Class PipedWriter

java.lang.Object

java.io.Writer

org.ka2ddo.yaac.io.PipedWriter

All Implemented Interfaces:

java.io.Closeable, java.io.Flushable, java.lang.Appendable, java.lang.AutoCloseable

public class PipedWriter
extends java.io.Writer

This is a performance-optimized clone of the java.io.PipedWriter class.

Author:

Andrew Pavlin, KA2DDO

Field Summary

Fields inherited from class java.io.Writer

lock

Constructor Summary

Constructors

Constructor and Description
PipedWriter() Creates 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 Type	Method and Description
void	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	setWriterThread() Mark the thread that is writing to the pipe.
void	write(char[] cbuf, int off, int len) Writes len characters from the specified character array starting at offset off to this piped output stream.
void	write(int c) Writes the specified char to the piped output stream.

Methods inherited from class java.io.Writer

append, append, append, write, write, write

Methods inherited from class java.lang.Object

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

Constructor Detail

PipedWriter

public PipedWriter(PipedReader snk)
            throws java.io.IOException

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 - The piped reader to connect to.

Throws:

java.io.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:

PipedReader.connect(java.io.PipedWriter), PipedWriter.connect(java.io.PipedReader)

Method Detail

connect

public void connect(PipedReader snk)
             throws java.io.IOException

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 - the piped reader to connect to.

Throws:

java.io.IOException - if an I/O error occurs.

setWriterThread

public void setWriterThread()

Mark the thread that is writing to the pipe.

write

public void write(int c)
           throws java.io.IOException

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.

Overrides:

write in class java.io.Writer

Parameters:

c - the char to be written.

Throws:

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

write

public void write(char[] cbuf,
                  int off,
                  int len)
           throws java.io.IOException

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. This method requires that the single writer thread register itself with setWriterThread() prior to first calling this method.

Specified by:

write in class java.io.Writer

Parameters:

cbuf - the data.

off - the start offset in the data.

len - the number of characters to write.

Throws:

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

flush

public void flush()
           throws java.io.IOException

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 java.io.Flushable

Specified by:

flush in class java.io.Writer

Throws:

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

close

public void close()
           throws java.io.IOException

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 java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in class java.io.Writer

Throws:

java.io.IOException - if an I/O error occurs.