Package adams.flow.condition.bool
Class 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 DirChangeMonitorm_Checkthe check scheme to use.protected PlaceholderDirectorym_Dirthe 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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Class[]accepts()Returns the class that the consumer accepts.StringcheckTipText()Returns the tip text for this property.voiddefineOptions()Adds options to the internal list of options.StringdirTipText()Returns the tip text for this property.protected booleandoEvaluate(Actor owner, Token token)Performs the actual evaluation.DirChangeMonitorgetCheck()Returns the 'dir changed' check scheme.PlaceholderDirectorygetDir()Returns the dir to check.StringgetQuickInfo()Returns the quick info string to be displayed in the flow editor.StringglobalInfo()Returns a string describing the object.voidsetCheck(DirChangeMonitor value)Sets the 'dir changed' check scheme.voidsetDir(PlaceholderDirectory value)Sets the file to check.StringsetUp(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.
-
-
Method Detail
-
globalInfo
public String globalInfo()
Returns a string describing the object.- Specified by:
globalInfoin interfaceGlobalInfoSupporter- Specified by:
globalInfoin classAbstractOptionHandler- Returns:
- a description suitable for displaying in the gui
-
defineOptions
public void defineOptions()
Adds options to the internal list of options.- Specified by:
defineOptionsin interfaceOptionHandler- Overrides:
defineOptionsin classAbstractOptionHandler
-
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:
getQuickInfoin interfaceBooleanCondition- Specified by:
getQuickInfoin interfaceQuickInfoSupporter- Specified by:
getQuickInfoin classAbstractBooleanCondition- Returns:
- the info or null if no info to be displayed
-
accepts
public Class[] accepts()
Returns the class that the consumer accepts.- Specified by:
acceptsin interfaceBooleanCondition- Specified by:
acceptsin classAbstractBooleanCondition- Returns:
- Unknown
-
setUp
public String setUp(Actor owner)
Configures the condition.- Specified by:
setUpin interfaceBooleanCondition- Overrides:
setUpin classAbstractBooleanCondition- 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:
doEvaluatein classAbstractBooleanCondition- Parameters:
owner- the owning actortoken- the current token passing through- Returns:
- the result of the evaluation
-
-