com.github.tuupertunut.powershelllibjava

Class AsyncReaderRecorder

java.lang.Object

com.github.tuupertunut.powershelllibjava.AsyncReaderRecorder

All Implemented Interfaces:

Runnable

public class AsyncReaderRecorder
extends Object
implements Runnable

An asynchronous recorder for Readers (character streams). A recorder instance is associated with a Reader and then executed on a Thread or an Executor. The recorder will then autonomously record the input of the given Reader into an internal buffer. Another thread may then consume the buffer in parts, or as a whole.

Author:

Tuupertunut

Constructor Summary

Constructors

Constructor and Description
AsyncReaderRecorder(Reader reader) Creates a new recorder, recording the given Reader.

Method Summary

Modifier and Type	Method and Description
String	consumeAll() Consumes and returns the whole buffer at once.
String	consumeAllAfterCurrentInput() Consumes and returns the whole buffer after the current reading is complete.
Optional<String>	consumeAmount(int amount) Consumes and returns a fixed amount of characters from the buffer.
Optional<String>	consumeToNextDelimiter(String delimiter) Consumes and returns the buffer up to the point where the delimiter first occurs.
String	getBuffer()
int	getBufferedAmount()
IOException	getException()
boolean	hasExceptionOccurred()
boolean	hasStreamEnded()
void	run() Records the reader into the buffer.

Methods inherited from class java.lang.Object

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

Constructor Detail

AsyncReaderRecorder

public AsyncReaderRecorder(Reader reader)

Creates a new recorder, recording the given Reader.

Parameters:

reader - the reader to be recorded.

Method Detail

run

public void run()

Records the reader into the buffer. This method is meant to be executed on a separate thread. It will block for as long as the reader has not closed or thrown an exception.

Specified by:

run in interface Runnable

hasStreamEnded

public boolean hasStreamEnded()

hasExceptionOccurred

public boolean hasExceptionOccurred()

getException

public IOException getException()

getBuffer

public String getBuffer()
                 throws IOException

Throws:

IOException

getBufferedAmount

public int getBufferedAmount()
                      throws IOException

Throws:

IOException

consumeAll

public String consumeAll()
                  throws IOException

Consumes and returns the whole buffer at once. Note: Only one consumption method should be called at once.

Returns:

the buffer contents.

Throws:

IOException - if an IOException has occurred since the last consumption.

consumeAllAfterCurrentInput

public String consumeAllAfterCurrentInput()
                                   throws IOException,
                                          InterruptedException

Consumes and returns the whole buffer after the current reading is complete. This method will wait until there is no input immediately available from the Reader. This is preferable to consumeAll() in cases where the input is some kind of message based communication, because the whole current message will be included into the buffer before consuming it. Note: Only one consumption method should be called at once.

Returns:

the buffer contents.

Throws:

IOException - if an IOException has occurred since the last consumption or occurs while waiting.

InterruptedException - if the current thread was interrupted while waiting for the current input to end.

consumeToNextDelimiter

public Optional<String> consumeToNextDelimiter(String delimiter)
                                        throws IOException,
                                               InterruptedException

Consumes and returns the buffer up to the point where the delimiter first occurs. The delimiter will be included in the consumed part. If the delimiter does not yet occur in the buffer, this method will wait until the next one is recorded or the input stream ends. This is useful when the input is divided into segments, separated by a delimiter. Note: Only one consumption method should be called at once.

Parameters:

delimiter - the delimiter up to which to consume.

Returns:

an optional containing the buffer contents up to and including the delimiter, or an empty optional if the input stream ended before a delimiter was recorded.

Throws:

IOException - if an IOException has occurred since the last consumption or occurs while waiting.

InterruptedException - if the current thread was interrupted while waiting for the delimiter to be recorded.

consumeAmount

public Optional<String> consumeAmount(int amount)
                               throws IOException,
                                      InterruptedException

Consumes and returns a fixed amount of characters from the buffer. If the buffer does not yet contain that many characters, this method will wait until it does or the input stream ends. Note: Only one consumption method should be called at once.

Parameters:

amount - the amount of characters to consume.

Returns:

an optional containing the next given amount of buffer contents, or an empty optional if the input stream ended before that many characters were recorded.

Throws:

IOException - if an IOException has occurred since the last consumption or occurs while waiting.

InterruptedException - if the current thread was interrupted while waiting for more characters to be recorded.