Package org.jgrapes.io.util

Class ByteBufferWriter

java.lang.Object

java.io.Writer

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

org.jgrapes.io.util.ByteBufferWriter

All Implemented Interfaces:

Closeable, Flushable, Appendable, AutoCloseable

public class ByteBufferWriter
extends AbstractBufferWriter<ByteBuffer>

An Writer that encodes the data written to it and stores it in a ByteBuffer 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.

The function of this class can also be achieved by wrapping a ByteBufferOutputStream in a OutputStreamWriter. The major advantage of this class is that it drops the IOExceptions (which cannot happen) from the methods. Besides, it should be more resource efficient.

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
ByteBufferWriter(IOSubchannel channel)	Creates a new instance that uses Output events to dispatch buffers on the given channel, using the channel’s response pipeline.
ByteBufferWriter(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
ByteBufferWriter	append(char ch)
ByteBufferWriter	append(CharSequence csq)
ByteBufferWriter	append(CharSequence csq, int start, int end)
ByteBufferWriter	charset(Charset charset)	Sets the charset to be used for converting the written data to bytes which defaults to UTF-8.
protected void	ensureBufferAvailable()	Ensure that a buffer for output data is available.
ByteBufferWriter	nativeCharset()	Sets the charset to be used for converting the written data to bytes to the charset specified as system property native.encoding.
ByteBufferWriter	sendInputEvents()	Causes the data to be fired as Input events rather than the usual Output events.
ByteBufferWriter	setEventAssociations(Map<Object,Object> associations)	Configure associations that are applied to the generated Output events, see Event.setAssociated(java.lang.Object, java.lang.Object).
ByteBufferWriter	suppressClose()	Suppresses sending of a close event when the stream is closed.
ByteBufferWriter	suppressEndOfRecord()	Suppresses setting the end of record flag when the stream is flushed or closed.
void	write(char[] cbuf)
void	write(char[] data, int offset, int length)
void	write(int ch)
void	write(String str)
void	write(String str, int offset, int length)

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

close, flush, flush

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

ByteBufferWriter

public ByteBufferWriter(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

ByteBufferWriter

public ByteBufferWriter(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 ByteBufferWriter 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<ByteBuffer>

Returns:

this object for easy chaining

suppressClose

public ByteBufferWriter suppressClose()

Description copied from class: AbstractBufferWriter

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

Overrides:

suppressClose in class AbstractBufferWriter<ByteBuffer>

Returns:

this object for easy chaining

suppressEndOfRecord

public ByteBufferWriter 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<ByteBuffer>

Returns:

this object for easy chaining

See Also:

• IOEvent.isEndOfRecord()

setEventAssociations

public ByteBufferWriter 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<ByteBuffer>

Parameters:

associations - the associations to apply

Returns:

this object for easy chaining

charset

public ByteBufferWriter charset(Charset charset)

Sets the charset to be used for converting the written data to bytes which defaults to UTF-8.

Must be set before the first invocation of any write method.

Parameters:

charset - the charset

Returns:

the writer

nativeCharset

public ByteBufferWriter nativeCharset()

Sets the charset to be used for converting the written data to bytes to the charset specified as system property native.encoding.

If this property does not specify a valid charset, Charset.defaultCharset() is used.

Must be invoked before the first write (or append) operation.

Returns:

the writer

ensureBufferAvailable

protected void ensureBufferAvailable()
                              throws InterruptedException

Description copied from class: AbstractBufferWriter

Ensure that a buffer for output data is available.

Specified by:

ensureBufferAvailable in class AbstractBufferWriter<ByteBuffer>

Throws:

InterruptedException - the interrupted exception

write

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

Specified by:

write in class AbstractBufferWriter<ByteBuffer>

write

public void write(char[] cbuf)

Overrides:

write in class AbstractBufferWriter<ByteBuffer>

write

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

Specified by:

write in class AbstractBufferWriter<ByteBuffer>

write

public void write(String str)

Overrides:

write in class AbstractBufferWriter<ByteBuffer>

write

public void write(int ch)

Overrides:

write in class AbstractBufferWriter<ByteBuffer>

append

public ByteBufferWriter append(char ch)

Specified by:

append in interface Appendable

Overrides:

append in class Writer

append

public ByteBufferWriter append(CharSequence csq)

Specified by:

append in interface Appendable

Overrides:

append in class Writer

append

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

Specified by:

append in interface Appendable

Overrides:

append in class Writer