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

Class ClientHelpCommand

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

public final class ClientHelpCommand
extends ExternalCommand

Displays help information for commands available to the Robot World client.

Constructor Summary

Constructors

Constructor	Description
ClientHelpCommand(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)	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.
static String	showHelp()	Displays all available client commands.

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

ClientHelpCommand

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

showHelp

public static String showHelp()

Displays all available client commands.

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

public String executeToString(World world)

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 -