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

Class BackCommand

java.lang.Object

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

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

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

All Implemented Interfaces:

Stateful

public class BackCommand
extends ExternalCommand
implements Stateful

Constructor Summary

Constructors

Constructor	Description
BackCommand(com.google.gson.JsonObject json)	Overload command constructor
BackCommand(String robotName, int steps)

Method Summary

Modifier and Type	Method	Description
com.google.gson.JsonObject	execute(World world)	Modern OO implementation of the execute method
String	executeToString(World world)	Each command must implement this method It does the work and returns a result
ImplementedClientCommands	getCommandName()	Return which client command this command implements
String	getUsage()	Get the way this command is supposed to be used.

Methods inherited from class za.co.wethinkcode.robots.server.commands.external.ExternalCommand

getArgs

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

findRobot, getRobotName

Methods inherited from class java.lang.Object

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

Methods inherited from interface za.co.wethinkcode.robots.server.commands.Stateful

verify

Constructor Details

BackCommand

public BackCommand(String robotName,
 int steps)

BackCommand

public BackCommand(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

executeToString

public String executeToString(World world)

Description copied from class: Command

Each command must implement this method It does the work and returns a result

Specified by:

executeToString in class Command

execute

public com.google.gson.JsonObject execute(World world)

Modern OO implementation of the execute method

Specified by:

execute in class Command

Parameters:

world - the world this command is being executed on

getCommandName

public ImplementedClientCommands getCommandName()

Return which client command this command implements

Specified by:

getCommandName in class ExternalCommand

Returns:

the command this child is

getUsage

public String getUsage()

Get the way this command is supposed to be used.

This is used to return more robust errors to the client

Specified by:

getUsage in class ExternalCommand

Returns:

the string representation of the usage of this command.