Package adams.core.command.stdout

Class Enqueue

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.core.command.stdout.AbstractStdOutProcessor

adams.core.command.stdout.Enqueue

All Implemented Interfaces:

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

public class Enqueue
extends AbstractStdOutProcessor
implements StorageUpdater

Adds the output from stdout to the specified queue.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected StorageQueueHandler	m_Handler	the actual queue.
protected StorageName	m_StorageName	the name of the queue in the internal storage.

Fields inherited from class adams.core.command.stdout.AbstractStdOutProcessor

m_Owner

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
Enqueue()

Method Summary

Modifier and Type	Method	Description
void	cleanUp()	Cleans up data structures, frees up memory.
void	defineOptions()	Adds options to the internal list of options.
StorageName	getStorageName()	Returns the name for the queue in the internal storage.
String	globalInfo()	Returns a string describing the object.
boolean	isUpdatingStorage()	Returns whether storage items are being updated.
void	processAsync(String output)	Processes the stdout output received when in async mode.
void	processBlocking(String output)	Processes the stdout output received when in blocking mode.
void	setStorageName(StorageName value)	Sets the name for the queue in the internal storage.
void	setStorageName(String value)	Sets the name for the queue in the internal storage.
String	setUp(FlowContextHandler owner)	Configures the handler.
String	storageNameTipText()	Returns the tip text for this property.

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, 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, getOptionManager, toCommandLine

Field Detail

m_StorageName

protected StorageName m_StorageName

the name of the queue in the internal storage.

m_Handler

protected transient StorageQueueHandler m_Handler

the actual queue.

Constructor Detail

Enqueue

public Enqueue()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface GlobalInfoSupporter

Specified by:

globalInfo in class AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractOptionHandler

isUpdatingStorage

public boolean isUpdatingStorage()

Returns whether storage items are being updated.

Specified by:

isUpdatingStorage in interface StorageUpdater

Returns:

true if storage items are updated

setStorageName

public void setStorageName(String value)

Sets the name for the queue in the internal storage.

Parameters:

value - the name

setStorageName

public void setStorageName(StorageName value)

Sets the name for the queue in the internal storage.

Parameters:

value - the name

getStorageName

public StorageName getStorageName()

Returns the name for the queue in the internal storage.

Returns:

the name

storageNameTipText

public String storageNameTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setUp

public String setUp(FlowContextHandler owner)

Description copied from class: AbstractStdOutProcessor

Configures the handler.

Specified by:

setUp in interface StdOutProcessor

Overrides:

setUp in class AbstractStdOutProcessor

Parameters:

owner - the owning command

Returns:

null if successfully setup, otherwise error message

processAsync

public void processAsync(String output)

Processes the stdout output received when in async mode.

Specified by:

processAsync in interface StdOutProcessor

Specified by:

processAsync in class AbstractStdOutProcessor

Parameters:

output - the output to process

processBlocking

public void processBlocking(String output)

Processes the stdout output received when in blocking mode.

Specified by:

processBlocking in interface StdOutProcessor

Specified by:

processBlocking in class AbstractStdOutProcessor

Parameters:

output - the output to process

cleanUp

public void cleanUp()

Cleans up data structures, frees up memory.

Specified by:

cleanUp in interface CleanUpHandler

Overrides:

cleanUp in class AbstractStdOutProcessor