Package adams.core.shutdown

Class StopFlows

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.core.shutdown.AbstractShutdownHook

adams.core.shutdown.StopFlows

All Implemented Interfaces:

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

public class StopFlows
extends AbstractShutdownHook

Stops registered flows.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected int	m_TimeOut	the timeout period in msec for stopping a flow.

Fields inherited from class adams.core.shutdown.AbstractShutdownHook

m_Hook

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

Method Summary

Modifier and Type	Method	Description
Runnable	configure()	Configures the runnable that gets executed when shutting down.
protected String	createFlowID(int id, Flow flow)	Generates a flow ID string.
void	defineOptions()	Adds options to the internal list of options.
int	getTimeOut()	Returns the timeout period before considering a flow to be unresponsive.
String	globalInfo()	Returns a string describing the object.
void	setTimeOut(int value)	Sets the timeout period before considering a flow to be unresponsive.
String	timeOutTipText()	Returns the tip text for this property.

Methods inherited from class adams.core.shutdown.AbstractShutdownHook

check, install, remove

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_TimeOut

protected int m_TimeOut

the timeout period in msec for stopping a flow.

Constructor Detail

StopFlows

public StopFlows()

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

setTimeOut

public void setTimeOut(int value)

Sets the timeout period before considering a flow to be unresponsive.

Parameters:

value - the timeout in msec

getTimeOut

public int getTimeOut()

Returns the timeout period before considering a flow to be unresponsive.

Returns:

the timeout in msec

timeOutTipText

public String timeOutTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the gui

createFlowID

protected String createFlowID(int id,
                              Flow flow)

Generates a flow ID string.

Parameters:

id - the registry ID

flow - the flow

Returns:

the ID string

configure

public Runnable configure()

Configures the runnable that gets executed when shutting down.

Specified by:

configure in class AbstractShutdownHook

Returns:

the runnable