Package org.jgrapes.io.util

Class CharBufferWriter

java.lang.Object

java.io.Writer

org.jgrapes.io.util.AbstractBufferWriter<CharBuffer>

org.jgrapes.io.util.CharBufferWriter

All Implemented Interfaces:

Closeable, Flushable, Appendable, AutoCloseable

public class CharBufferWriter
extends AbstractBufferWriter<CharBuffer>

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 org.jgrapes.io.util.AbstractBufferWriter

buffer, channel

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
CharBufferWriter	append(char ch)
CharBufferWriter	append(CharSequence csq)
CharBufferWriter	append(CharSequence csq, int start, int end)
protected void	ensureBufferAvailable()	Ensure that a buffer for output data is available.
CharBufferWriter	sendInputEvents()	Causes the data to be fired as Input events rather than the usual Output events.
CharBufferWriter	setEventAssociations(Map<Object,Object> associations)	Configure associations that are applied to the generated Output events, see Event.setAssociated(java.lang.Object, java.lang.Object).
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)
void	write(String str, int offset, int length)

Methods inherited from class org.jgrapes.io.util.AbstractBufferWriter

close, flush, flush, write, write, write

Methods inherited from class java.io.Writer

nullWriter

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()

Description copied from class: AbstractBufferWriter

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

Overrides:

sendInputEvents in class AbstractBufferWriter<CharBuffer>

Returns:

this object for easy chaining

suppressClose

public CharBufferWriter suppressClose()

Description copied from class: AbstractBufferWriter

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

Overrides:

suppressClose in class AbstractBufferWriter<CharBuffer>

Returns:

this object for easy chaining

suppressEndOfRecord

public CharBufferWriter suppressEndOfRecord()

Description copied from class: AbstractBufferWriter

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

Overrides:

suppressEndOfRecord in class AbstractBufferWriter<CharBuffer>

Returns:

this object for easy chaining

See Also:

• IOEvent.isEndOfRecord()

setEventAssociations

public CharBufferWriter setEventAssociations(Map<Object,Object> associations)

Description copied from class: AbstractBufferWriter

Configure associations that are applied to the generated Output events, see Event.setAssociated(java.lang.Object, java.lang.Object).

Overrides:

setEventAssociations in class AbstractBufferWriter<CharBuffer>

Parameters:

associations - the associations to apply

Returns:

this object for easy chaining

ensureBufferAvailable

protected void ensureBufferAvailable()
                              throws InterruptedException

Ensure that a buffer for output data is available.

Specified by:

ensureBufferAvailable in class AbstractBufferWriter<CharBuffer>

Throws:

InterruptedException - the interrupted exception

write

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

Specified by:

write in class AbstractBufferWriter<CharBuffer>

write

public void write(String str,
 int offset,
 int length)

Specified by:

write in class AbstractBufferWriter<CharBuffer>

append

public CharBufferWriter append(char ch)

Specified by:

append in interface Appendable

Overrides:

append in class Writer

append

public CharBufferWriter append(CharSequence csq)

Specified by:

append in interface Appendable

Overrides:

append in class Writer

append

public CharBufferWriter append(CharSequence csq,
 int start,
 int end)

Specified by:

append in interface Appendable

Overrides:

append in class Writer