Package adams.core.command.stdout

Class AbstractStdOutProcessor

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.core.command.stdout.AbstractStdOutProcessor

All Implemented Interfaces:

CleanUpHandler, StdOutProcessor, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, Serializable

Direct Known Subclasses:

CallableActorSink, Enqueue, Log, Null

public abstract class AbstractStdOutProcessor
extends AbstractOptionHandler
implements StdOutProcessor

Ancestor for processing the command output received on stdout.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected FlowContextHandler	m_Owner	the owning command.

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
AbstractStdOutProcessor()

Method Summary

Modifier and Type	Method	Description
void	cleanUp()	Cleans up data structures, frees up memory.
abstract void	processAsync(String output)	Processes the stdout output received when in async mode.
abstract void	processBlocking(String output)	Processes the stdout output received when in blocking mode.
String	setUp(FlowContextHandler owner)	Configures the handler.

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, defineOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, initialize, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject

configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object

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

Methods inherited from interface adams.core.Destroyable

destroy

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, defineOptions, getOptionManager, toCommandLine

Field Detail

m_Owner

protected FlowContextHandler m_Owner

the owning command.

Constructor Detail

AbstractStdOutProcessor

public AbstractStdOutProcessor()

Method Detail

setUp

public String setUp(FlowContextHandler owner)

Configures the handler.

Specified by:

setUp in interface StdOutProcessor

Parameters:

owner - the owning command

Returns:

null if successfully setup, otherwise error message

processAsync

public abstract void processAsync(String output)

Processes the stdout output received when in async mode.

Specified by:

processAsync in interface StdOutProcessor

Parameters:

output - the output to process

processBlocking

public abstract void processBlocking(String output)

Processes the stdout output received when in blocking mode.

Specified by:

processBlocking in interface StdOutProcessor

Parameters:

output - the output to process

cleanUp

public void cleanUp()

Cleans up data structures, frees up memory.

Specified by:

cleanUp in interface CleanUpHandler