Package adams.flow.condition.bool

Class IsAnyStringValue

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.condition.bool.AbstractBooleanCondition

adams.flow.condition.bool.IsAnyStringValue

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<BooleanCondition>, SizeOfHandler, Stoppable, BooleanCondition, Serializable

public class IsAnyStringValue
extends AbstractBooleanCondition

Evaluates to 'true' if the payload of the token is any of specified string values.

-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
    min-user-mode: Expert
 

-value <adams.core.base.BaseString> [-value ...] (property: values)
    The string values that the payload must match (one of them).
    default:
 

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected BaseString[]	m_Values	the string values to check against.
protected Set<String>	m_ValuesSet	the set of values.

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
IsAnyStringValue()	Default constructor.
IsAnyStringValue(BaseString[] values)	Initializes the condition with the specified values.
IsAnyStringValue(String[] values)	Initializes the condition with the specified values.

Method Summary

Modifier and Type	Method	Description
Class[]	accepts()	Returns the class that the consumer accepts.
void	defineOptions()	Adds options to the internal list of options.
protected boolean	doEvaluate(Actor owner, Token token)	Performs the actual evaluation.
String	getQuickInfo()	Returns the quick info string to be displayed in the flow editor.
BaseString[]	getValues()	Returns the string values that the payload must match (one of them).
String	globalInfo()	Returns a string describing the object.
protected void	reset()	Resets the scheme.
void	setValues(BaseString[] values)	Sets the string values that the payload must match (one of them).
String	valuesTipText()	Returns the tip text for this property.

Methods inherited from class adams.flow.condition.bool.AbstractBooleanCondition

evaluate, preEvaluate, setUp, shallowCopy, shallowCopy, stopExecution

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, toCommandLine, toString

Methods inherited from class adams.core.logging.CustomLoggingLevelObject

setLoggingLevel

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_Values

protected BaseString[] m_Values

the string values to check against.

m_ValuesSet

protected Set<String> m_ValuesSet

the set of values.

Constructor Detail

IsAnyStringValue

public IsAnyStringValue()

Default constructor.

IsAnyStringValue

public IsAnyStringValue(String[] values)

Initializes the condition with the specified values.

Parameters:

values - the values to use

IsAnyStringValue

public IsAnyStringValue(BaseString[] values)

Initializes the condition with the specified values.

Parameters:

values - the values to use

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

reset

protected void reset()

Resets the scheme.

Overrides:

reset in class AbstractOptionHandler

setValues

public void setValues(BaseString[] values)

Sets the string values that the payload must match (one of them).

Parameters:

values - the values

getValues

public BaseString[] getValues()

Returns the string values that the payload must match (one of them).

Returns:

the values

valuesTipText

public String valuesTipText()

Returns the tip text for this property.

Returns:

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

getQuickInfo

public String getQuickInfo()

Returns the quick info string to be displayed in the flow editor.

Specified by:

getQuickInfo in interface BooleanCondition

Specified by:

getQuickInfo in interface QuickInfoSupporter

Specified by:

getQuickInfo in class AbstractBooleanCondition

Returns:

always null

accepts

public Class[] accepts()

Returns the class that the consumer accepts.

Specified by:

accepts in interface BooleanCondition

Specified by:

accepts in class AbstractBooleanCondition

Returns:

Unknown

doEvaluate

protected boolean doEvaluate(Actor owner,
                             Token token)

Performs the actual evaluation.

Specified by:

doEvaluate in class AbstractBooleanCondition

Parameters:

owner - the owning actor

token - the current token passing through

Returns:

the result of the evaluation