Package com.j3d.engine.interact.cmd

Enum Class CmdToken.Type

java.lang.Object

java.lang.Enum<CmdToken.Type>

com.j3d.engine.interact.cmd.CmdToken.Type

All Implemented Interfaces:

Serializable, Comparable<CmdToken.Type>, Constable

Enclosing class:

CmdToken

public static enum CmdToken.Type
extends Enum<CmdToken.Type>

Defines the possible types a command token can represent. Each type is associated with a Java class and a usage string for help messages.

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
BOOL
CMD_NAME	Represents the command name itself.
COLOUR
DOUBLE
ID_CURVE
ID_LINE
ID_POINT
ID_THING
ID_TRI
INT
STRING
TAGGED
VECTOR3	Represents a 3D vector.

Field Summary

Fields

Modifier and Type	Field	Description
private Class<?>	clazz	The Java class that this token type maps to.
private String	usage	A short string for usage hints.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Type(Class<?> clazz, String usage)	Constructs a Type enum constant.

Method Summary

Modifier and Type	Method	Description
Class<?>	getTypeClass()	Returns the Java class associated with this token type.
String	toUsage()	Returns a short usage string for this token type.
static CmdToken.Type	valueOf(String name)	Returns the enum constant of this class with the specified name.
static CmdToken.Type[]	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

CMD_NAME

public static final CmdToken.Type CMD_NAME

Represents the command name itself.

VECTOR3

public static final CmdToken.Type VECTOR3

Represents a 3D vector.

ID_POINT

public static final CmdToken.Type ID_POINT

ID_LINE

public static final CmdToken.Type ID_LINE

ID_TRI

public static final CmdToken.Type ID_TRI

ID_THING

public static final CmdToken.Type ID_THING

ID_CURVE

public static final CmdToken.Type ID_CURVE

COLOUR

public static final CmdToken.Type COLOUR

STRING

public static final CmdToken.Type STRING

INT

public static final CmdToken.Type INT

DOUBLE

public static final CmdToken.Type DOUBLE

BOOL

public static final CmdToken.Type BOOL

TAGGED

public static final CmdToken.Type TAGGED

Field Details

clazz

private Class<?> clazz

The Java class that this token type maps to.

usage

private String usage

A short string for usage hints.

Constructor Details

Type

private Type(Class<?> clazz,
 String usage)

Constructs a Type enum constant.

Parameters:

clazz - The Java class associated with this token type.

usage - A short string describing the usage of this type, often used in help messages.

Method Details

values

public static CmdToken.Type[] 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 CmdToken.Type 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

getTypeClass

public Class<?> getTypeClass()

Returns the Java class associated with this token type.

Returns:

The Class object.

toUsage

public String toUsage()

Returns a short usage string for this token type.

Returns:

The usage string.