Package za.co.wethinkcode.robots.domain

Enum Class ImplementedClientCommands

java.lang.Object

java.lang.Enum<ImplementedClientCommands>

za.co.wethinkcode.robots.domain.ImplementedClientCommands

All Implemented Interfaces:

Serializable, Comparable<ImplementedClientCommands>, Constable

public enum ImplementedClientCommands
extends Enum<ImplementedClientCommands>

The Implemented client Commands enum captures the allowed variants of a Client Command

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
back	Back command moves a Robot backwards
fire	fire command fires a bullet from a Robot with a gun
forward	forward command moves a Robot forwards
help	The help command displays all currently available command and their usages.
launch	launch command launches a new Robot
look	Look command displays information about the Robot's surroundings
mine	mine command drops a mine from a Robot who uses mines
orientation	Orientation command return the Direction a Robot is facing
quit	Disconnects the currently connected client from the server
reload	The reload command turns the Robot's ammo the allowed maximum for it's RobotKind
repair	The repair command turns the Robot's shield the allowed maximum for it's RobotKind
state	The state command returns information about the current Robot's state
swap	The swap command is an internally implemented client command that allows the client to switch between different launched Robot
turn	The turn command moves the current robot's ordinal in the Direction enum.
world	Displays configuration information about the WorldConfig

Method Summary

Modifier and Type	Method	Description
ArrayList<String>	getAliases()	The available aliases of an implemented Client Command
HelpStruct	getHelpInfo()	How this command is intended to be called e.g.
ResponseKind	getResponseKind()
static Optional<ImplementedClientCommands>	resolveFromAlias(String s)	Returns either an Implemented ClientCommand or null, but leads it to the call site to handle the null case
static ImplementedClientCommands	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ImplementedClientCommands[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

back

public static final ImplementedClientCommands back

Back command moves a Robot backwards

fire

public static final ImplementedClientCommands fire

fire command fires a bullet from a Robot with a gun

forward

public static final ImplementedClientCommands forward

forward command moves a Robot forwards

help

public static final ImplementedClientCommands help

The help command displays all currently available command and their usages.

launch

public static final ImplementedClientCommands launch

launch command launches a new Robot

look

public static final ImplementedClientCommands look

Look command displays information about the Robot's surroundings

mine

public static final ImplementedClientCommands mine

mine command drops a mine from a Robot who uses mines

orientation

public static final ImplementedClientCommands orientation

Orientation command return the Direction a Robot is facing

repair

public static final ImplementedClientCommands repair

The repair command turns the Robot's shield the allowed maximum for it's RobotKind

reload

public static final ImplementedClientCommands reload

The reload command turns the Robot's ammo the allowed maximum for it's RobotKind

state

public static final ImplementedClientCommands state

The state command returns information about the current Robot's state

swap

public static final ImplementedClientCommands swap

The swap command is an internally implemented client command that allows the client to switch between different launched Robot

turn

public static final ImplementedClientCommands turn

The turn command moves the current robot's ordinal in the Direction enum.

world

public static final ImplementedClientCommands world

Displays configuration information about the WorldConfig

quit

public static final ImplementedClientCommands quit

Disconnects the currently connected client from the server

Method Details

values

public static ImplementedClientCommands[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static ImplementedClientCommands valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getAliases

public ArrayList<String> getAliases()

The available aliases of an implemented Client Command

Returns:

all the available aliases for client commands

resolveFromAlias

public static Optional<ImplementedClientCommands> resolveFromAlias(String s)

Returns either an Implemented ClientCommand or null, but leads it to the call site to handle the null case

Parameters:

s - the potential command being parsed

Returns:

either the ImplementedClientCommand it's an alias for or null

getHelpInfo

public HelpStruct getHelpInfo()

How this command is intended to be called e.g. launch invalid input: '<'\make> invalid input: '<'\name>

Returns:

the intended usage of this command

getResponseKind

public ResponseKind getResponseKind()

Returns:

the ResponseKind of the currently executing command