Package za.co.wethinkcode.robots.client.commands

Class ClientCommandRequest

java.lang.Object

za.co.wethinkcode.robots.client.commands.ClientCommandRequest

Direct Known Subclasses:

LaunchCommandRequest, LookCommandRequest, StateCommandRequest

public abstract class ClientCommandRequest
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected String[]	arguments
protected ImplementedClientCommands	command

Constructor Summary

Constructors

Constructor	Description
ClientCommandRequest()
ClientCommandRequest(String robotName, ImplementedClientCommands command, String[] arguments)	Standard constructor for a Client Requesting that a command be executed

Method Summary

Modifier and Type	Method	Description
String[]	getArguments()	Getter for arguments as a string
abstract Map<String,Argument>	getArgumentsMap()	Abstract method for childClasses to define their expected argument syntax
ImplementedClientCommands	getCommand()
String	getRobotName()

Methods inherited from class java.lang.Object

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

Field Details

command

protected ImplementedClientCommands command

arguments

protected String[] arguments

Constructor Details

ClientCommandRequest

public ClientCommandRequest()

ClientCommandRequest

public ClientCommandRequest(String robotName,
 ImplementedClientCommands command,
 String[] arguments)

Standard constructor for a Client Requesting that a command be executed

Parameters:

robotName - name of the clientRobot that the command is being executed on

command - the command being executed

arguments - any arguments for this command

Method Details

getRobotName

public String getRobotName()

getCommand

public ImplementedClientCommands getCommand()

getArgumentsMap

public abstract Map<String,Argument> getArgumentsMap()

Abstract method for childClasses to define their expected argument syntax

Returns:

Map of Strings corresponding to the type of argument and a value corresponding to its type.

getArguments

public String[] getArguments()

Getter for arguments as a string

Returns:

the arguments passed into this request