Package adams.scripting.command.basic

Class StopEngine

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.scripting.command.AbstractCommand

adams.scripting.command.AbstractCommandWithResponse

adams.scripting.command.basic.StopEngine

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, RemoteCommand, RemoteCommandWithErrorMessage, RemoteCommandWithResponse, Serializable

public class StopEngine
extends AbstractCommandWithResponse

Simply stops the scripting engine, either the one handling the request or the response. Useful for terminating the receiving scripting engine once the last command has been processed.

Version:

$Revision$

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	StopEngine.EngineType	The type of engine to stop.

Field Summary

Fields

Modifier and Type	Field	Description
protected StopEngine.EngineType	m_Type	the type.

Fields inherited from class adams.scripting.command.AbstractCommandWithResponse

m_ErrorMessage, m_ResponseConnection

Fields inherited from class adams.scripting.command.AbstractCommand

m_RemoteScriptingEngineHandler, m_Request

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Fields inherited from interface adams.scripting.command.RemoteCommand

KEY_COMMAND, KEY_TYPE, VALUE_REQUEST, VALUE_RESPONSE

Constructor Summary

Constructors

Constructor	Description
StopEngine()

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
byte[]	getRequestPayload()	Returns the payload of the request, if any.
Object[]	getRequestPayloadObjects()	Returns the objects that represent the request payload.
byte[]	getResponsePayload()	Returns the payload of the response, if any.
Object[]	getResponsePayloadObjects()	Returns the objects that represent the response payload.
StopEngine.EngineType	getType()	Returns the type of engine to stop.
String	globalInfo()	Returns a string describing the object.
void	handleRequest(RemoteScriptingEngine engine, RemoteCommandProcessor processor, RequestHandler handler)	Handles the request.
void	handleResponse(RemoteScriptingEngine engine, ResponseHandler handler)	Handles the response.
void	setRequestPayload(byte[] value)	Sets the payload for the request.
void	setResponsePayload(byte[] value)	Sets the payload for the response.
void	setType(StopEngine.EngineType value)	Sets the type of engine to stop.
String	typeTipText()	Returns the tip text for this property.

Methods inherited from class adams.scripting.command.AbstractCommandWithResponse

afterSendResponse, assembleResponse, assembleResponseHeader, beforeSendResponse, doHandleRequest, getDefaultResponseConnection, getErrorMessage, getResponseConnection, hasErrorMessage, parse, prepareResponsePayload, responseConnectionTipText, setResponseConnection, toString

Methods inherited from class adams.scripting.command.AbstractCommand

afterSendRequest, assembleRequest, assembleRequestHeader, beforeSendRequest, getRemoteScriptingEngineHandler, initialize, isRequest, prepareRequestPayload, setRemoteScriptingEngineHandler, setRequest

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine

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.Destroyable

destroy

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.core.logging.LoggingSupporter

getLogger, isLoggingEnabled

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, getOptionManager, toCommandLine

Methods inherited from interface adams.scripting.command.RemoteCommand

afterSendRequest, assembleRequest, beforeSendRequest, getRemoteScriptingEngineHandler, isRequest, setRemoteScriptingEngineHandler, setRequest

Field Detail

m_Type

protected StopEngine.EngineType m_Type

the type.

Constructor Detail

StopEngine

public StopEngine()

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 AbstractCommandWithResponse

setType

public void setType(StopEngine.EngineType value)

Sets the type of engine to stop.

Parameters:

value - the type

getType

public StopEngine.EngineType getType()

Returns the type of engine to stop.

Returns:

the type

typeTipText

public String typeTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the gui

setRequestPayload

public void setRequestPayload(byte[] value)

Sets the payload for the request.

Parameters:

value - the payload

getRequestPayload

public byte[] getRequestPayload()

Returns the payload of the request, if any.

Returns:

the payload

getRequestPayloadObjects

public Object[] getRequestPayloadObjects()

Returns the objects that represent the request payload.

Returns:

the objects

handleRequest

public void handleRequest(RemoteScriptingEngine engine,
                          RemoteCommandProcessor processor,
                          RequestHandler handler)

Handles the request.

Specified by:

handleRequest in interface RemoteCommand

Overrides:

handleRequest in class AbstractCommand

Parameters:

engine - the remote engine handling the request

processor - the processor for formatting/parsing

handler - for handling the request

setResponsePayload

public void setResponsePayload(byte[] value)

Sets the payload for the response.

Parameters:

value - the payload

getResponsePayload

public byte[] getResponsePayload()

Returns the payload of the response, if any.

Returns:

the payload

getResponsePayloadObjects

public Object[] getResponsePayloadObjects()

Returns the objects that represent the response payload.

Returns:

the objects

handleResponse

public void handleResponse(RemoteScriptingEngine engine,
                           ResponseHandler handler)

Handles the response.

Specified by:

handleResponse in interface RemoteCommandWithResponse

Overrides:

handleResponse in class AbstractCommandWithResponse

Parameters:

engine - the remote engine handling the response

handler - for handling the response