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

Class MineCommand

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.MineCommand

All Implemented Interfaces:

Stateful

public class MineCommand
extends ExternalCommand
implements Stateful

Constructor Summary

Constructors

Constructor	Description
MineCommand(com.google.gson.JsonObject json)	Overload command constructor

Method Summary

Modifier and Type	Method	Description
com.google.gson.JsonObject	execute(World world)	Modern a modern OO implementation of the execute method
String	executeToString(World world)	Deprecated.
ImplementedClientCommands	getCommandName()	Return which client command this command implements
String	getUsage()	Get the way this command is supposed to be used.
Status	verify(World world, String robotName)	Verify if a command is able to be executed given the current state of the robot.

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

Constructor Details

MineCommand

public MineCommand(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 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.

Example for a command foo

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

Specified by:

getUsage in class ExternalCommand

Returns:

the string representation of the usage of this command.

executeToString

@Deprecated
public String executeToString(World world)

Deprecated.

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

Specified by:

executeToString in class Command

Parameters:

world -

execute

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

Modern a modern OO implementation of the execute method

Specified by:

execute in class Command

Parameters:

world -

verify

public Status verify(World world,
 String robotName)
              throws RobotCannotActException

Verify if a command is able to be executed given the current state of the robot. THIS METHOD INDUCES THE SIDE EFFECT OF CHANGING THE Status OF THE ROBOT, updating it's Status if needed.

Specified by:

verify in interface Stateful

Parameters:

world - the world that this command is being verified against.

Returns:

the status of the robot executing the command.

Throws:

RobotCannotActException