Package adams.scripting.requesthandler

Class MultiHandler

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.scripting.requesthandler.AbstractRequestHandler

adams.scripting.requesthandler.MultiHandler

All Implemented Interfaces:

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

public class MultiHandler
extends AbstractRequestHandler

Combines multiple 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 RequestHandler[]	m_Handlers	the handlers to combine.

Fields inherited from class adams.scripting.requesthandler.AbstractRequestHandler

m_Enabled, 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
MultiHandler()

Method Summary

Modifier and Type	Method	Description
void	addHandler(RequestHandler value)	Adds the handler to use.
void	defineOptions()	Adds options to the internal list of options.
RequestHandler[]	getHandlers()	Returns the handlers in use.
String	globalInfo()	Returns a string describing the object.
String	handlersTipText()	Returns the tip text for this property.
void	requestFailed(RemoteCommand cmd, String msg)	Handles failed requests.
void	requestRejected(RemoteCommand cmd, String msg)	Handles rejected requests.
void	requestSuccessful(RemoteCommand cmd)	Handles successfuly requests.
void	setHandlers(RequestHandler[] value)	Sets the handlers to use.

Methods inherited from class adams.scripting.requesthandler.AbstractRequestHandler

enabledTipText, getEnabled, getOwner, insertHandler, setEnabled, setOwner

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_Handlers

protected RequestHandler[] m_Handlers

the handlers to combine.

Constructor Detail

MultiHandler

public MultiHandler()

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 AbstractRequestHandler

setHandlers

public void setHandlers(RequestHandler[] value)

Sets the handlers to use.

Parameters:

value - the handlers

getHandlers

public RequestHandler[] getHandlers()

Returns the handlers in use.

Returns:

the handlers

handlersTipText

public String handlersTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the gui

addHandler

public void addHandler(RequestHandler value)

Adds the handler to use.

Parameters:

value - the handler to add

requestSuccessful

public void requestSuccessful(RemoteCommand cmd)

Handles successfuly requests.

Parameters:

cmd - the command with the request

requestFailed

public void requestFailed(RemoteCommand cmd,
                          String msg)

Handles failed requests.

Parameters:

cmd - the command with the request

msg - the optional error message, can be null

requestRejected

public void requestRejected(RemoteCommand cmd,
                            String msg)

Handles rejected requests.

Parameters:

cmd - the command with the request

msg - the optional error message, can be null