Package adams.flow.rest.interceptor.outgoing

Class EnqueueGenerator

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.rest.interceptor.outgoing.AbstractOutInterceptorGenerator<Enqueue>

adams.flow.rest.interceptor.outgoing.EnqueueGenerator

All Implemented Interfaces:

adams.core.CleanUpHandler, adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.SizeOfHandler, Serializable

public class EnqueueGenerator
extends AbstractOutInterceptorGenerator<Enqueue>

Generator for Enqueue.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	m_EnqueueMessage	whether to enqueue the message or just a NullToken.
protected adams.flow.control.StorageName	m_StorageName	the queue to enqueue the token in.

Fields inherited from class adams.flow.rest.interceptor.outgoing.AbstractOutInterceptorGenerator

m_Enabled, m_LastInterceptor

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

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
protected Enqueue	doGenerate()	Generates the actual interceptor for incoming messages.
String	enqueueMessageTipText()	Returns the tip text for this property.
boolean	getEnqueueMessage()	Returns whether to enqueue the whole message or just a NullToken.
adams.flow.control.StorageName	getStorageName()	Returns the queue in use.
String	globalInfo()	Returns a string describing the object.
void	setEnqueueMessage(boolean value)	Sets whether to enqueue the whole message or just a NullToken.
void	setStorageName(adams.flow.control.StorageName value)	Sets the queue to use.
String	storageNameTipText()	Returns the tip text for this property.

Methods inherited from class adams.flow.rest.interceptor.outgoing.AbstractOutInterceptorGenerator

check, cleanUp, enabledTipText, generate, getEnabled, getLastInterceptor, hasLastInterceptor, setEnabled

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.logging.LoggingLevelHandler

getLoggingLevel

Field Detail

m_StorageName

protected adams.flow.control.StorageName m_StorageName

the queue to enqueue the token in.

m_EnqueueMessage

protected boolean m_EnqueueMessage

whether to enqueue the message or just a NullToken.

Constructor Detail

EnqueueGenerator

public EnqueueGenerator()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface adams.core.GlobalInfoSupporter

Specified by:

globalInfo in class adams.core.option.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 adams.core.option.OptionHandler

Overrides:

defineOptions in class AbstractOutInterceptorGenerator<Enqueue>

setStorageName

public void setStorageName(adams.flow.control.StorageName value)

Sets the queue to use.

Parameters:

value - the queue

getStorageName

public adams.flow.control.StorageName getStorageName()

Returns the queue in use.

Returns:

the queue

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.

setEnqueueMessage

public void setEnqueueMessage(boolean value)

Sets whether to enqueue the whole message or just a NullToken.

Parameters:

value - true if to enqueue whole message

getEnqueueMessage

public boolean getEnqueueMessage()

Returns whether to enqueue the whole message or just a NullToken.

Returns:

true if to enqueue whole message

enqueueMessageTipText

public String enqueueMessageTipText()

Returns the tip text for this property.

Returns:

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

doGenerate

protected Enqueue doGenerate()

Generates the actual interceptor for incoming messages.

Specified by:

doGenerate in class AbstractOutInterceptorGenerator<Enqueue>

Returns:

the interceptor