autohit.server.command
Class CommandAtom

java.lang.Object
  extended byautohit.common.channels.Atom
      extended byautohit.server.command.CommandAtom
All Implemented Interfaces:
java.io.Serializable

public class CommandAtom
extends Atom

A command Atom. It carries a command. It is based on a channel Atom so it should be transmittable.

The object must be a String if it carries a single, required parameter, or a Vector if it carries multiple, required or optional parameters. See the specific target command for usage.

Version:
1.0 Version History EPG - Initial - 24Jul03
Author:
Erich P. Gatejen
See Also:
Serialized Form

Field Summary
static int UNKNOWN_COMMAND
          Numeric values
 
Fields inherited from class autohit.common.channels.Atom
DEBUG, FLASH, FLOOD, IMMEDIATE, numeric, P_ALL, P_NONE, P_TOP, P1, P2, P3, P4, P5, priority, PRIORITY, ROUTINE, senderID, stamp, thing, type, TYPE_CONTROL, TYPE_EVENT, TYPE_GENERIC, TYPE_INVALID, TYPE_LOG
 
Constructor Summary
CommandAtom()
          Default constructor.
CommandAtom(Injector response)
          Set response injector constructor.
CommandAtom(int n, java.lang.Object o)
          Constructor Sets command numeric and param object.
CommandAtom(int n, java.lang.Object o, int p)
          Use this constructor, as it is the most convenient
 
Methods inherited from class autohit.common.channels.Atom
stampit
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

UNKNOWN_COMMAND

public static final int UNKNOWN_COMMAND
Numeric values

See Also:
Constant Field Values
Constructor Detail

CommandAtom

public CommandAtom()
Default constructor. Default priority of ROUTINE. Null object. Generic type. Timestamped. You may need to set ri to a response injector, though the handler may use a default.


CommandAtom

public CommandAtom(Injector response)
Set response injector constructor. Default priority of ROUTINE. Null object. Generic type. Timestamped.


CommandAtom

public CommandAtom(int n,
                   java.lang.Object o)
Constructor Sets command numeric and param object.

Parameters:
n - the command numeric
o - the object

CommandAtom

public CommandAtom(int n,
                   java.lang.Object o,
                   int p)
Use this constructor, as it is the most convenient

Parameters:
n - the command numeric
o - the object
p - the priority


Test.