Package adams.scripting.command.basic

Class Stop

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.scripting.command.AbstractCommand

adams.scripting.command.basic.AbstractCommandWithFlowStopping

adams.scripting.command.basic.Stop

All Implemented Interfaces:

ClassCrossReference, CrossReference, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, RemoteCommand, Serializable

public class Stop
extends AbstractCommandWithFlowStopping
implements ClassCrossReference

Attempts to stop the remote ADAMS instance.

Version:

$Revision$

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields inherited from class adams.scripting.command.basic.AbstractCommandWithFlowStopping

m_StopFlows, m_TimeOut

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

Method Summary

Modifier and Type	Method	Description
protected String	doHandleRequest(RemoteScriptingEngine engine, RemoteCommandProcessor processor)	Handles the request.
Class[]	getClassCrossReferences()	Returns the cross-referenced classes.
byte[]	getRequestPayload()	Always zero-length array.
Object[]	getRequestPayloadObjects()	Returns the objects that represent the request payload.
String	globalInfo()	Returns a string describing the object.
void	setRequestPayload(byte[] value)	Ignored.

Methods inherited from class adams.scripting.command.basic.AbstractCommandWithFlowStopping

createFlowID, defineOptions, getStopFlows, getTimeOut, setStopFlows, setTimeOut, stopFlows, stopFlowsTipText, timeOutTipText

Methods inherited from class adams.scripting.command.AbstractCommand

afterSendRequest, assembleRequest, assembleRequestHeader, beforeSendRequest, getRemoteScriptingEngineHandler, handleRequest, initialize, isRequest, parse, prepareRequestPayload, setRemoteScriptingEngineHandler, setRequest, toString

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

Constructor Detail

Stop

public Stop()

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

getClassCrossReferences

public Class[] getClassCrossReferences()

Returns the cross-referenced classes.

Specified by:

getClassCrossReferences in interface ClassCrossReference

Returns:

the classes

setRequestPayload

public void setRequestPayload(byte[] value)

Ignored.

Specified by:

setRequestPayload in interface RemoteCommand

Parameters:

value - the payload

getRequestPayload

public byte[] getRequestPayload()

Always zero-length array.

Specified by:

getRequestPayload in interface RemoteCommand

Returns:

the payload

getRequestPayloadObjects

public Object[] getRequestPayloadObjects()

Returns the objects that represent the request payload.

Specified by:

getRequestPayloadObjects in interface RemoteCommand

Returns:

the objects

doHandleRequest

protected String doHandleRequest(RemoteScriptingEngine engine,
                                 RemoteCommandProcessor processor)

Handles the request.

Specified by:

doHandleRequest in class AbstractCommand

Parameters:

engine - the remote engine handling the request

processor - the processor for formatting/parsing

Returns:

null if successful, otherwise error message