org.lsst.ccs.command

Class RawCommand

java.lang.Object

org.lsst.ccs.command.RawCommand

All Implemented Interfaces:

Serializable, BasicCommand

public class RawCommand
extends Object
implements BasicCommand

A command with pre-parsed arguments (Objects).

Author:

tonyj

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
RawCommand(String commandName, List<Object> arguments) Builds a Raw Command.

Method Summary

Methods

Modifier and Type	Method and Description
Object	getArgument(int index) Get a specific command argument
int	getArgumentCount() Get the number of arguments associated with this command
Object[]	getArguments()
String	getCommand() Get the root command name (the zeroth token)
static RawCommand	toRawCommand(BasicCommand command, Method method, InputConversionEngine engine) Convert a BasicCommand to a RawCommand.

Methods inherited from class java.lang.Object

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

Constructor Detail

RawCommand

public RawCommand(String commandName,
          List<Object> arguments)

Builds a Raw Command.

Parameters:

commandName - The command name.

arguments - The arguments for the command

Method Detail

getCommand

public String getCommand()

Get the root command name (the zeroth token)

Specified by:

getCommand in interface BasicCommand

Returns:

The command name

getArgument

public Object getArgument(int index)

Get a specific command argument

Parameters:

index - The index of the argument

Returns:

The command argument at the given index

getArguments

public Object[] getArguments()

getArgumentCount

public int getArgumentCount()

Get the number of arguments associated with this command

Specified by:

getArgumentCount in interface BasicCommand

Returns:

The argument count

toRawCommand

public static RawCommand toRawCommand(BasicCommand command,
                      Method method,
                      InputConversionEngine engine)
                               throws CommandInvocationException

Convert a BasicCommand to a RawCommand. If the BasicCommand is already a raw command it is returned unchanged. If it is a tokenized command it will be converted to a RawCommand.

Parameters:

command - The input command

method - The method thar will be invoked, used to find the type of the command arguments

engine - The input conversion engine that will be used to convert strings to objects

Returns:

The converted command

Throws:

CommandInvocationException - If the command cannot be successfully converted