org.michailov.async.io

Class AsyncLineJoiner

java.lang.Object

org.michailov.async.AsyncAgent

org.michailov.async.io.AsyncLineJoiner

public class AsyncLineJoiner
extends AsyncAgent

Asynchronous joiner of discrete lines into a sequence of chars.

See Also:

WhenReady, AsyncAgent, CharRingBuffer, StringRingBuffer

Constructor Summary

Constructors

Constructor and Description
AsyncLineJoiner(StringRingBuffer stringRingBuffer, CharRingBuffer charRingBuffer, LineAsyncOptions lineAsyncOptions) Constructs an AsyncLineJoiner instance over the given ring buffers.

Method Summary

Modifier and Type	Method and Description
protected void	action() "action" function that reads chars from the input char ring buffer and writes lines to the output string ring buffer.
protected boolean	done() "done" predicate that returns true when this async agent wants to quit the current async loop.
CharRingBuffer	getCharRingBuffer() Returns the attached char ring buffer from where chars will be written.
StringRingBuffer	getStringRingBuffer() Returns the attached string ring buffer where lines will be read from.
boolean	isEOF() Checks whether this line joiner has reached EOF of the input string ring buffer.
protected boolean	ready() "ready" predicate that returns true when lines can be read from the input string ring buffer and chars can be written to the output char ring buffer without blocking.

Methods inherited from class org.michailov.async.AsyncAgent

applyAsync, isIdle, setIdle, setIdleAndThrow, startApplyLoopAsync

Methods inherited from class java.lang.Object

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

Constructor Detail

AsyncLineJoiner

public AsyncLineJoiner(StringRingBuffer stringRingBuffer,
                       CharRingBuffer charRingBuffer,
                       LineAsyncOptions lineAsyncOptions)

Constructs an AsyncLineJoiner instance over the given ring buffers.

Parameters:

stringRingBuffer - StringRingBuffer to read lines from.

charRingBuffer - CharRingBuffer to write chars to.

lineAsyncOptions - LineAsyncOptions to use for all async operations.

Method Detail

getStringRingBuffer

public StringRingBuffer getStringRingBuffer()

Returns the attached string ring buffer where lines will be read from.

Returns:

The attached string ring buffer where lines will be read from.

getCharRingBuffer

public CharRingBuffer getCharRingBuffer()

Returns the attached char ring buffer from where chars will be written.

Returns:

The attached char ring buffer from where chars will be written.

isEOF

public boolean isEOF()

Checks whether this line joiner has reached EOF of the input string ring buffer.

Returns:

true iff EOF has been reached or an exception has been encountered.

ready

protected boolean ready()

"ready" predicate that returns true when lines can be read from the input string ring buffer and chars can be written to the output char ring buffer without blocking.

Overrides:

ready in class AsyncAgent

Returns:

Derived classes should override this method to return true iff it is time to execute AsyncAgent.action().

done

protected boolean done()

"done" predicate that returns true when this async agent wants to quit the current async loop.

Overrides:

done in class AsyncAgent

Returns:

Derived classes should override this method to return true iff it is time for the loop to stop.

action

protected void action()

"action" function that reads chars from the input char ring buffer and writes lines to the output string ring buffer.

Overrides:

action in class AsyncAgent