Package org.jgrapes.io.util

Class CharBufferWriter

java.lang.Object

java.io.Writer

org.jgrapes.io.util.CharBufferWriter

All Implemented Interfaces:

Closeable, Flushable, Appendable, AutoCloseable

public class CharBufferWriter
extends Writer

An Writer that is backed by CharBuffers obtained from a queue.

When a byte buffer is full, an Output event (default) is generated and a new buffer is fetched from the queue.

Field Summary

Fields inherited from class java.io.Writer

lock

Constructor Summary

Constructors

Constructor	Description
CharBufferWriter(IOSubchannel channel)	Creates a new instance that uses Output events to dispatch buffers on the given channel, using the channel’s response pipeline.
CharBufferWriter(IOSubchannel channel, EventPipeline eventPipeline)	Creates a new instance that uses Output events to dispatch buffers on the given channel, using the given event pipeline.

Method Summary

Modifier and Type	Method	Description
void	close()	Flushes any remaining data with the end of record flag set (unless suppressEndOfRecord() has been called) and fires a Close event (unless suppressClose() has been called).
void	flush()	Creates and fires a Output event with the buffer being filled if it contains any data.
CharBufferWriter	sendInputEvents()	Causes the data to be fired as Input events rather than the usual Output events.
CharBufferWriter	suppressClose()	Suppresses sending of a close event when the stream is closed.
CharBufferWriter	suppressEndOfRecord()	Suppresses setting the end of record flag when the stream is flushed or closed.
void	write(char[] data, int offset, int length)

Methods inherited from class java.io.Writer

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

Methods inherited from class java.lang.Object

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

Constructor Details

CharBufferWriter

public CharBufferWriter(IOSubchannel channel,
 EventPipeline eventPipeline)

Creates a new instance that uses Output events to dispatch buffers on the given channel, using the given event pipeline.

Parameters:

channel - the channel to fire events on

eventPipeline - the event pipeline used for firing events

CharBufferWriter

public CharBufferWriter(IOSubchannel channel)

Creates a new instance that uses Output events to dispatch buffers on the given channel, using the channel’s response pipeline.

Parameters:

channel - the channel to fire events on

Method Details

sendInputEvents

public CharBufferWriter sendInputEvents()

Causes the data to be fired as Input events rather than the usual Output events.

Returns:

the stream for easy chaining

suppressClose

public CharBufferWriter suppressClose()

Suppresses sending of a close event when the stream is closed.

Returns:

the stream for easy chaining

suppressEndOfRecord

public CharBufferWriter suppressEndOfRecord()

Suppresses setting the end of record flag when the stream is flushed or closed.

Returns:

the stream for easy chaining

See Also:

• IOEvent.isEndOfRecord()

write

public void write(char[] data,
 int offset,
 int length)
           throws IOException

Specified by:

write in class Writer

Throws:

IOException

flush

public void flush()
           throws IOException

Creates and fires a Output event with the buffer being filled if it contains any data.

By default, the Output event is created with the end of record flag set (see IOEvent.isEndOfRecord()) in order to forward the flush as event. This implies that an Output event with no data (but the end of record flag set) may be fired. This behavior can be disabled with suppressEndOfRecord().

Specified by:

flush in interface Flushable

Specified by:

flush in class Writer

Throws:

IOException

close

public void close()
           throws IOException

Flushes any remaining data with the end of record flag set (unless suppressEndOfRecord() has been called) and fires a Close event (unless suppressClose() has been called).

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in class Writer

Throws:

IOException