Package org.jgrapes.io.util

Class AbstractBufferWriter<B extends Buffer>

java.lang.Object

java.io.Writer

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

All Implemented Interfaces:

Closeable, Flushable, Appendable, AutoCloseable

Direct Known Subclasses:

ByteBufferWriter, CharBufferWriter

public abstract class AbstractBufferWriter<B extends Buffer>
extends Writer

A base class for CharBufferWriter and ByteBufferWriter.

Field Summary

Fields

Modifier and Type	Field	Description
protected ManagedBuffer<B>	buffer
protected IOSubchannel	channel

Fields inherited from class java.io.Writer

lock

Constructor Summary

Constructors

Constructor	Description
AbstractBufferWriter(IOSubchannel channel)	Creates a new instance that uses Output events to dispatch buffers on the given channel, using the channel’s response pipeline.
AbstractBufferWriter(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).
protected abstract void	ensureBufferAvailable()	Ensure that a buffer for output data is available.
void	flush()	Creates and fires a Output event with the buffer being filled if it contains any data.
protected void	flush(boolean endOfRecord)	Creates and fires an Output event with the buffer being filled.
protected AbstractBufferWriter<B>	sendInputEvents()	Causes the data to be fired as Input events rather than the usual Output events.
AbstractBufferWriter<B>	setEventAssociations(Map<Object,Object> associations)	Configure associations that are applied to the generated Output events, see Event.setAssociated(java.lang.Object, java.lang.Object).
AbstractBufferWriter<B>	suppressClose()	Suppresses sending of a close event when the stream is closed.
AbstractBufferWriter<B>	suppressEndOfRecord()	Suppresses setting the end of record flag when the stream is flushed or closed.
void	write(char[] cbuf)
abstract void	write(char[] data, int offset, int length)
void	write(int ch)
void	write(String str)
abstract void	write(String str, int offset, int length)

Methods inherited from class java.io.Writer

append, append, append, nullWriter

Methods inherited from class java.lang.Object

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

Field Details

channel

protected IOSubchannel channel

buffer

protected ManagedBuffer<B extends Buffer> buffer

Constructor Details

AbstractBufferWriter

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

AbstractBufferWriter

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

protected AbstractBufferWriter<B> sendInputEvents()

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

Returns:

this object for easy chaining

suppressClose

public AbstractBufferWriter<B> suppressClose()

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

Returns:

this object for easy chaining

suppressEndOfRecord

public AbstractBufferWriter<B> suppressEndOfRecord()

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

Returns:

this object for easy chaining

See Also:

• IOEvent.isEndOfRecord()

setEventAssociations

public AbstractBufferWriter<B> setEventAssociations(Map<Object,Object> associations)

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

Parameters:

associations - the associations to apply

Returns:

this object for easy chaining

ensureBufferAvailable

protected abstract void ensureBufferAvailable()
                                       throws InterruptedException

Ensure that a buffer for output data is available.

Throws:

InterruptedException - the interrupted exception

write

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

Specified by:

write in class Writer

write

public void write(char[] cbuf)

Overrides:

write in class Writer

write

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

Overrides:

write in class Writer

write

public void write(String str)

Overrides:

write in class Writer

write

public void write(int ch)

Overrides:

write in class Writer

flush

protected void flush(boolean endOfRecord)

Creates and fires an Output event with the buffer being filled.

The end of record flag of the event is set according to the parameter. Frees any allocated buffer.

flush

public void flush()

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

close

public 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).

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in class Writer