Package adams.flow.control.flowrestart.trigger

Class DirMonitor

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.control.flowrestart.trigger.AbstractTrigger

adams.flow.control.flowrestart.trigger.DirMonitor

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, SizeOfHandler, Serializable

public class DirMonitor
extends AbstractTrigger

Monitors a dir using the specified dir change monitor.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected int	m_Interval	the interval in milli-seconds.
protected DirChangeMonitor	m_Monitor	the type of monitor to use.
protected PlaceholderDirectory	m_MonitoredDir	the file to monitor.
protected RunnableWithLogging	m_Runnable	the runnable for the monitor.

Fields inherited from class adams.flow.control.flowrestart.trigger.AbstractTrigger

m_TriggerHandler

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

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
protected String	doStart(Flow flow)	Starts the trigger.
int	getInterval()	Returns the interval to wait in milli-seconds.
DirChangeMonitor	getMonitor()	Returns the monitor in use.
PlaceholderDirectory	getMonitoredDir()	Returns the dir to monitor.
String	getQuickInfo()	Returns a quick info about the actor, which will be displayed in the GUI.
String	globalInfo()	Returns a string describing the object.
String	intervalTipText()	Returns the tip text for this property.
String	monitoredDirTipText()	Returns the tip text for this property.
String	monitorTipText()	Returns the tip text for this property.
void	setInterval(int value)	Sets the interval in milli-seconds to wait.
void	setMonitor(DirChangeMonitor value)	Sets the monitor to use.
void	setMonitoredDir(PlaceholderDirectory value)	Sets the dir to monitor.
String	stop()	Stops the trigger.

Methods inherited from class adams.flow.control.flowrestart.trigger.AbstractTrigger

check, getTriggerHandler, setTriggerHandler, start

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_MonitoredDir

protected PlaceholderDirectory m_MonitoredDir

the file to monitor.

m_Monitor

protected DirChangeMonitor m_Monitor

the type of monitor to use.

m_Interval

protected int m_Interval

the interval in milli-seconds.

m_Runnable

protected RunnableWithLogging m_Runnable

the runnable for the monitor.

Constructor Detail

DirMonitor

public DirMonitor()

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

setMonitoredDir

public void setMonitoredDir(PlaceholderDirectory value)

Sets the dir to monitor.

Parameters:

value - the dir

getMonitoredDir

public PlaceholderDirectory getMonitoredDir()

Returns the dir to monitor.

Returns:

the dir

monitoredDirTipText

public String monitoredDirTipText()

Returns the tip text for this property.

Returns:

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

setMonitor

public void setMonitor(DirChangeMonitor value)

Sets the monitor to use.

Parameters:

value - the type of monitor

getMonitor

public DirChangeMonitor getMonitor()

Returns the monitor in use.

Returns:

the type of monitor

monitorTipText

public String monitorTipText()

Returns the tip text for this property.

Returns:

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

setInterval

public void setInterval(int value)

Sets the interval in milli-seconds to wait.

Parameters:

value - the interval

getInterval

public int getInterval()

Returns the interval to wait in milli-seconds.

Returns:

the interval

intervalTipText

public String intervalTipText()

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 a quick info about the actor, which will be displayed in the GUI.

Specified by:

getQuickInfo in interface QuickInfoSupporter

Overrides:

getQuickInfo in class AbstractTrigger

Returns:

null if no info available, otherwise short string

doStart

protected String doStart(Flow flow)

Starts the trigger.

Specified by:

doStart in class AbstractTrigger

Parameters:

flow - the flow to handle

Returns:

null if successfully started, otherwise error message

stop

public String stop()

Stops the trigger.

Specified by:

stop in class AbstractTrigger

Returns:

null if successfully stopped, otherwise error message