Enum Class Describer.Key

java.lang.Object

java.lang.Enum<Describer.Key>

edu.uky.cs.nil.tt.world.Describer.Key

All Implemented Interfaces:

Serializable, Comparable<Describer.Key>, Constable

Enclosing class:

Describer

public static enum Describer.Key
extends Enum<Describer.Key>

The names of elements which can be replaced in description templates

Author:

Stephen G. Ware

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ACTION	The action being described or the action of the turn being described
ARG_0	The first argument of the signature of the object being described
ARG_1	The second argument of the signature of the object being described
ARG_2	The third argument of the signature of the object being described
ARG_3	The fourth argument of the signature of the object being described
ARG_4	The fifth argument of the signature of the object being described
ARG_5	The sixth argument of the signature of the object being described
ARG_6	The seventh argument of the signature of the object being described
ARG_7	The eighth argument of the signature of the object being described
ARG_8	The ninth argument of the signature of the object being described
ARG_9	The tenth argument of the signature of the object being described
ENDING	The ending being described
ENTITY	The entity being described
NAME	The name of the named object being described or the name part of the signature of the object being described if the object is a signed asset
ROLE	The role who takes the turn being described
TO	The role for whom this description is being generated
TURN_TYPE	The type of turn object being described
TYPE	The type of object being described.
VALUE	The value of the assignment being described
VARIABLE	The variable being described or the variable of the assignment being described

Method Summary

Modifier and Type	Method	Description
static Describer.Key	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Describer.Key[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

TYPE

public static final Describer.Key TYPE

The type of object being described. The value should be a string in lower case. When the type is a Java class, it should be the class's simple name only, not the fully qualified name including its package.

ROLE

public static final Describer.Key ROLE

The role who takes the turn being described

TURN_TYPE

public static final Describer.Key TURN_TYPE

The type of turn object being described

ENTITY

public static final Describer.Key ENTITY

The entity being described

VARIABLE

public static final Describer.Key VARIABLE

The variable being described or the variable of the assignment being described

ACTION

public static final Describer.Key ACTION

The action being described or the action of the turn being described

ENDING

public static final Describer.Key ENDING

The ending being described

NAME

public static final Describer.Key NAME

The name of the named object being described or the name part of the signature of the object being described if the object is a signed asset

ARG_0

public static final Describer.Key ARG_0

The first argument of the signature of the object being described

ARG_1

public static final Describer.Key ARG_1

The second argument of the signature of the object being described

ARG_2

public static final Describer.Key ARG_2

The third argument of the signature of the object being described

ARG_3

public static final Describer.Key ARG_3

The fourth argument of the signature of the object being described

ARG_4

public static final Describer.Key ARG_4

The fifth argument of the signature of the object being described

ARG_5

public static final Describer.Key ARG_5

The sixth argument of the signature of the object being described

ARG_6

public static final Describer.Key ARG_6

The seventh argument of the signature of the object being described

ARG_7

public static final Describer.Key ARG_7

The eighth argument of the signature of the object being described

ARG_8

public static final Describer.Key ARG_8

The ninth argument of the signature of the object being described

ARG_9

public static final Describer.Key ARG_9

The tenth argument of the signature of the object being described

VALUE

public static final Describer.Key VALUE

The value of the assignment being described

TO

public static final Describer.Key TO

The role for whom this description is being generated

Method Details

values

public static Describer.Key[] 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 Describer.Key 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