Package za.co.wethinkcode.robots.server.commands.external

Class ExternalCommand

java.lang.Object

za.co.wethinkcode.robots.server.commands.Command

za.co.wethinkcode.robots.server.commands.external.ExternalCommand

Direct Known Subclasses:

BackCommand, ClientQuitCommand, FireCommand, ForwardCommand, LaunchCommand, LookCommand, ReloadCommand, RepairCommand, StateCommand, TurnCommand, WorldCommand

public abstract class ExternalCommand
extends Command

Abstract class of commands external to server, typically from clients

Constructor Summary

Constructors

Constructor	Description
ExternalCommand(com.google.gson.JsonObject json)	Overload command constructor
ExternalCommand(String robotName)	Required command constructor

Method Summary

Modifier and Type	Method	Description
List<String>	getArgs()	Getter for the args of an external command
abstract ImplementedClientCommands	getCommandName()	Return which client command this command implements
abstract String	getUsage()	Get the way this command is supposed to be used.

Methods inherited from class za.co.wethinkcode.robots.server.commands.Command

execute, executeToString, findRobot, getRobotName

Methods inherited from class java.lang.Object

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

Constructor Details

ExternalCommand

public ExternalCommand(String robotName)

Required command constructor

Parameters:

robotName - the name of the robot the command is being executed on

ExternalCommand

public ExternalCommand(com.google.gson.JsonObject json)
                throws ClassCastException,
UnsupportedOperationException,
IllegalStateException

Overload command constructor

Parameters:

json - the Json version of the input

Throws:

ClassCastException

UnsupportedOperationException

IllegalStateException

Method Details

getCommandName

public abstract ImplementedClientCommands getCommandName()

Return which client command this command implements

Returns:

the command this child is

getArgs

public List<String> getArgs()

Getter for the args of an external command

Returns:

a list of arguments.

getUsage

public abstract String getUsage()

Get the way this command is supposed to be used.

Example for a command foo

 #robot-world-client
 > invalid input: '<'foo-usage> invalid input: '<'foo-args>
 

Returns:

the string representation of the usage of this command.