Package adams.core.shutdown

Class MultiHook

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.core.shutdown.AbstractShutdownHook

adams.core.shutdown.MultiHook

All Implemented Interfaces:

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

public class MultiHook
extends AbstractShutdownHook

Executes the specified hooks sequentially.

Version:

$Revision$

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected AbstractShutdownHook[]	m_Hooks	the hooks.

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

Method Summary

Modifier and Type	Method	Description
String	check()	Hook method before generating the runnable and installing it.
Runnable	configure()	Configures the runnable that gets executed when shutting down.
void	defineOptions()	Adds options to the internal list of options.
AbstractShutdownHook[]	getHooks()	Returns the hooks to execute sequentially.
String	globalInfo()	Returns a string describing the object.
String	hooksTipText()	Returns the tip text for this property.
void	setHooks(AbstractShutdownHook[] value)	Sets the hooks to execute sequentially.

Methods inherited from class adams.core.shutdown.AbstractShutdownHook

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_Hooks

protected AbstractShutdownHook[] m_Hooks

the hooks.

Constructor Detail

MultiHook

public MultiHook()

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

setHooks

public void setHooks(AbstractShutdownHook[] value)

Sets the hooks to execute sequentially.

Parameters:

value - the hooks

getHooks

public AbstractShutdownHook[] getHooks()

Returns the hooks to execute sequentially.

Returns:

the hooks

hooksTipText

public String hooksTipText()

Returns the tip text for this property.

Returns:

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

check

public String check()

Hook method before generating the runnable and installing it.

Overrides:

check in class AbstractShutdownHook

Returns:

null if successful, otherwise error message

configure

public Runnable configure()

Configures the runnable that gets executed when shutting down.

Specified by:

configure in class AbstractShutdownHook

Returns:

the runnable