Package za.co.wethinkcode.robots.domain

Enum Class ResponseKind

java.lang.Object

java.lang.Enum<ResponseKind>

za.co.wethinkcode.robots.domain.ResponseKind

All Implemented Interfaces:

Serializable, Comparable<ResponseKind>, Constable

public enum ResponseKind
extends Enum<ResponseKind>

Enum encapsulating the variants of response.

This information is useful for parsing information in Memory

• RESULT is for commands that return a result from the server eg. ImplementedClientCommands.launch
• STATE return information about state from the server e.g. ImplementedClientCommands.world
• INTERNAL do not send information to the server e.g. ImplementedClientCommands.swap

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
INTERNAL	This response does not send information to the server e.g.
RESULT	This response is for commands that return a result from the server eg.
STATE	This response returns information about state from the server e.g.

Method Summary

Modifier and Type	Method	Description
String	getHelpInfo()
static ResponseKind	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ResponseKind[]	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

RESULT

public static final ResponseKind RESULT

This response is for commands that return a result from the server eg. ImplementedClientCommands.launch

STATE

public static final ResponseKind STATE

This response returns information about state from the server e.g. ImplementedClientCommands.world

INTERNAL

public static final ResponseKind INTERNAL

This response does not send information to the server e.g. ImplementedClientCommands.swap

Method Details

values

public static ResponseKind[] 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 ResponseKind 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

getHelpInfo

public String getHelpInfo()