Package adams.flow.condition.bool

Class DirChanged

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.condition.bool.AbstractBooleanCondition

adams.flow.condition.bool.DirChanged

All Implemented Interfaces:

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

public class DirChanged
extends AbstractBooleanCondition

Evaluates to 'true' if the dir change monitor detects a change.

-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
 

-dir <adams.core.io.PlaceholderDirectory> (property: dir)
    The directory to check.
    default: ${CWD}
 

-check <adams.core.io.dirchanged.DirChangeMonitor> (property: check)
    The dir changed monitor to use.
    default: adams.core.io.dirchanged.NoChange
 

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected DirChangeMonitor	m_Check	the check scheme to use.
protected PlaceholderDirectory	m_Dir	the file to look for.

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

Method Summary

Modifier and Type	Method	Description
Class[]	accepts()	Returns the class that the consumer accepts.
String	checkTipText()	Returns the tip text for this property.
void	defineOptions()	Adds options to the internal list of options.
String	dirTipText()	Returns the tip text for this property.
protected boolean	doEvaluate(Actor owner, Token token)	Performs the actual evaluation.
DirChangeMonitor	getCheck()	Returns the 'dir changed' check scheme.
PlaceholderDirectory	getDir()	Returns the dir to check.
String	getQuickInfo()	Returns the quick info string to be displayed in the flow editor.
String	globalInfo()	Returns a string describing the object.
void	setCheck(DirChangeMonitor value)	Sets the 'dir changed' check scheme.
void	setDir(PlaceholderDirectory value)	Sets the file to check.
String	setUp(Actor owner)	Configures the condition.

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

evaluate, preEvaluate, shallowCopy, shallowCopy, stopExecution

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_Dir

protected PlaceholderDirectory m_Dir

the file to look for.

m_Check

protected DirChangeMonitor m_Check

the check scheme to use.

Constructor Detail

DirChanged

public DirChanged()

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

setDir

public void setDir(PlaceholderDirectory value)

Sets the file to check.

Parameters:

value - the file

getDir

public PlaceholderDirectory getDir()

Returns the dir to check.

Returns:

the dir

dirTipText

public String dirTipText()

Returns the tip text for this property.

Returns:

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

setCheck

public void setCheck(DirChangeMonitor value)

Sets the 'dir changed' check scheme.

Parameters:

value - the check scheme

getCheck

public DirChangeMonitor getCheck()

Returns the 'dir changed' check scheme.

Returns:

the check scheme

checkTipText

public String checkTipText()

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:

the info or null if no info to be displayed

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

setUp

public String setUp(Actor owner)

Configures the condition.

Specified by:

setUp in interface BooleanCondition

Overrides:

setUp in class AbstractBooleanCondition

Parameters:

owner - the actor this condition belongs to

Returns:

null if everything is fine, otherwise error message

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