Package adams.scripting.engine

Class DefaultMainScriptingEngine.RemoteCommandGrabber

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.scripting.engine.AbstractRemoteCommandHandler

adams.scripting.engine.DefaultMainScriptingEngine.RemoteCommandGrabber

All Implemented Interfaces:

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

Enclosing class:

DefaultMainScriptingEngine

public static class DefaultMainScriptingEngine.RemoteCommandGrabber
extends AbstractRemoteCommandHandler

Handles the registering/deregistering of workers.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected MainScriptingEngine	m_Main	the main.

Fields inherited from class adams.scripting.engine.AbstractRemoteCommandHandler

m_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
RemoteCommandGrabber()

Method Summary

Modifier and Type	Method	Description
protected String	check(RemoteCommand cmd)	Hook method for checks before handling the command.
protected String	doHandle(RemoteCommand cmd, RemoteCommandProcessor processor)	Handles the command.
MainScriptingEngine	getMain()	Returns the main scripting engine this command handler belongs to.
String	globalInfo()	Returns a string describing the object.
void	setMain(MainScriptingEngine value)	Sets the main scripting engine this command handler belongs to.

Methods inherited from class adams.scripting.engine.AbstractRemoteCommandHandler

getOwner, handle, setOwner

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, defineOptions, 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_Main

protected MainScriptingEngine m_Main

the main.

Constructor Detail

RemoteCommandGrabber

public RemoteCommandGrabber()

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

setMain

public void setMain(MainScriptingEngine value)

Sets the main scripting engine this command handler belongs to.

Parameters:

value - the owner

getMain

public MainScriptingEngine getMain()

Returns the main scripting engine this command handler belongs to.

Returns:

the owner

check

protected String check(RemoteCommand cmd)

Hook method for checks before handling the command.

Overrides:

check in class AbstractRemoteCommandHandler

Parameters:

cmd - the command to handle

Returns:

null if checks passed, otherwise error message

doHandle

protected String doHandle(RemoteCommand cmd,
                          RemoteCommandProcessor processor)

Handles the command.

Specified by:

doHandle in class AbstractRemoteCommandHandler

Parameters:

cmd - the command to handle

processor - the processor for formatting/parsing

Returns:

null if successful, otherwise error message