Package adams.scripting.requesthandler

Class AbstractRequestHandler

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.scripting.requesthandler.AbstractRequestHandler

All Implemented Interfaces:

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

Direct Known Subclasses:

CallableActorsHandler, CommandDumperHandler, LoggingHandler, MultiHandler, NullHandler, SimpleLogPanelRequestHandler

public abstract class AbstractRequestHandler
extends AbstractOptionHandler
implements RequestHandler

Ancestor for request handlers.

Version:

$Revision$

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	m_Enabled	whether the handler is enabled.
protected RemoteScriptingEngine	m_Owner	the owner.

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

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
String	enabledTipText()	Returns the tip text for this property.
boolean	getEnabled()	Returns whether the handler is enabled.
RemoteScriptingEngine	getOwner()	Returns the owning engine.
static boolean	insertHandler(Object source, AbstractApplicationFrame app, RequestHandler handler)	For inserting a request handler into the scripting engine.
void	setEnabled(boolean value)	Sets whether the handler is enabled.
void	setOwner(RemoteScriptingEngine value)	Sets the owning engine.

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, 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

Methods inherited from interface adams.scripting.requesthandler.RequestHandler

requestFailed, requestRejected, requestSuccessful

Field Detail

m_Owner

protected RemoteScriptingEngine m_Owner

the owner.

m_Enabled

protected boolean m_Enabled

whether the handler is enabled.

Constructor Detail

AbstractRequestHandler

public AbstractRequestHandler()

Method Detail

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractOptionHandler

setOwner

public void setOwner(RemoteScriptingEngine value)

Sets the owning engine.

Specified by:

setOwner in interface RequestHandler

Parameters:

value - the owner

getOwner

public RemoteScriptingEngine getOwner()

Returns the owning engine.

Specified by:

getOwner in interface RequestHandler

Returns:

the owner, null if none set

setEnabled

public void setEnabled(boolean value)

Sets whether the handler is enabled.

Parameters:

value - true if enabled

getEnabled

public boolean getEnabled()

Returns whether the handler is enabled.

Returns:

true if enabled

enabledTipText

public String enabledTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the gui

insertHandler

public static boolean insertHandler(Object source,
                                    AbstractApplicationFrame app,
                                    RequestHandler handler)

For inserting a request handler into the scripting engine.

Parameters:

source - the caller

app - the application frame to update

handler - the handler to insert

Returns:

true if not present and therefore inserted