Package adams.flow.container

Class RemoteCommandContainer

java.lang.Object

adams.flow.container.AbstractContainer

adams.flow.container.RemoteCommandContainer

All Implemented Interfaces:

CloneHandler<Container>, GlobalInfoSupporter, SpreadSheetSupporter, Container, Serializable

public class RemoteCommandContainer
extends AbstractContainer

Container to store RemoteCommand objects and associated messages as intercepted by logging handlers.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	EVENT_REQUESTFAILED	the request failed event.
static String	EVENT_REQUESTREJECTED	the request rejected event.
static String	EVENT_REQUESTSUCCESSFUL	the request successful event.
static String	EVENT_RESPONSEFAILED	the response failed event.
static String	EVENT_RESPONSESUCCESSFUL	the response successful event.
static String	VALUE_COMMAND	the identifier for the command.
static String	VALUE_EVENT	the identifier for the event.
static String	VALUE_MESSAGE	the identifier for the optional message.

Fields inherited from class adams.flow.container.AbstractContainer

m_AdditionalNames, m_Help, m_Values

Constructor Summary

Constructors

Constructor	Description
RemoteCommandContainer()	Initializes the container with a dummy command.
RemoteCommandContainer(String event, RemoteCommand cmd)	Initializes the container with the type of event and command but no message.
RemoteCommandContainer(String event, RemoteCommand cmd, String msg)	Initializes the container with the type of event and command but no message.

Method Summary

Modifier and Type	Method	Description
protected void	initHelp()	Initializes the help strings.
boolean	isValid()	Checks whether the setup of the container is valid.
Iterator<String>	names()	Returns all value names that can be used (theoretically).

Methods inherited from class adams.flow.container.AbstractContainer

addAdditionalName, addHelp, addHelp, addHelp, checkDefaultConstructor, getClone, getHelp, getValue, getValue, globalInfo, hasHelp, hasValue, isValidName, removeAdditionalName, setValue, store, stored, toSpreadSheet, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

VALUE_EVENT

public static final String VALUE_EVENT

the identifier for the event.

See Also:

Constant Field Values

VALUE_COMMAND

public static final String VALUE_COMMAND

the identifier for the command.

See Also:

Constant Field Values

VALUE_MESSAGE

public static final String VALUE_MESSAGE

the identifier for the optional message.

See Also:

Constant Field Values

EVENT_REQUESTSUCCESSFUL

public static final String EVENT_REQUESTSUCCESSFUL

the request successful event.

See Also:

Constant Field Values

EVENT_REQUESTFAILED

public static final String EVENT_REQUESTFAILED

the request failed event.

See Also:

Constant Field Values

EVENT_REQUESTREJECTED

public static final String EVENT_REQUESTREJECTED

the request rejected event.

See Also:

Constant Field Values

EVENT_RESPONSESUCCESSFUL

public static final String EVENT_RESPONSESUCCESSFUL

the response successful event.

See Also:

Constant Field Values

EVENT_RESPONSEFAILED

public static final String EVENT_RESPONSEFAILED

the response failed event.

See Also:

Constant Field Values

Constructor Detail

RemoteCommandContainer

public RemoteCommandContainer()

Initializes the container with a dummy command.

Only used for generating help information.

RemoteCommandContainer

public RemoteCommandContainer(String event,
                              RemoteCommand cmd)

Initializes the container with the type of event and command but no message.

Parameters:

event - the type of event

cmd - the command

RemoteCommandContainer

public RemoteCommandContainer(String event,
                              RemoteCommand cmd,
                              String msg)

Initializes the container with the type of event and command but no message.

Parameters:

event - the type of event

cmd - the command

Method Detail

initHelp

protected void initHelp()

Initializes the help strings.

Overrides:

initHelp in class AbstractContainer

names

public Iterator<String> names()

Returns all value names that can be used (theoretically).

Specified by:

names in interface Container

Specified by:

names in class AbstractContainer

Returns:

iterator over all possible value names

isValid

public boolean isValid()

Checks whether the setup of the container is valid.

Specified by:

isValid in interface Container

Specified by:

isValid in class AbstractContainer

Returns:

true if all the necessary values are available