story.scheherazade.prologuer
Class UsageModelType

java.lang.Object
  story.scheherazade.prologuer.UsageModelType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable, GenericType

public class UsageModelType
extends java.lang.Object
implements GenericType, java.lang.Comparable, java.io.Serializable

Manually implemented enum for types. Allows classes to specify types to one another by passing one of the fields of this class rather than a string. No public constructor.

Based (loosely) on http://xoot.org/index.php?name=Java+enum+classes

See Also:

Serialized Form

Field Summary

static UsageModelType	Action
static UsageModelType	Behavior
static UsageModelType	Character
static UsageModelType	Condition
static UsageModelType	Location
static UsageModelType	Prop
static UsageModelType	Quality

Method Summary

static java.lang.String	capitalize(java.lang.String in)
int	compareTo(java.lang.Object other)
boolean	equals(java.lang.Object other) Tests if one instance is the same as some other.
static UsageModelType	get(int number) Return the corresponding UsageModelType for the given number.
static UsageModelType	get(java.lang.String string) Static version of get() that gets around the Java restriction on static types in interfaces.
static ImmutableHashSet	getAllTypes() Return a HashSet of every item in the enumeration.
ImmutableHashSet	getAllTypesNonStatically() Return a HashSet of every item in the enumeration.
GenericType	getAsGeneric(java.lang.String string) Return the corresponding UsageModelType for the given string as a GenericType object.
int	getUniqueID() Get a unique numerial ID for this type that goes from 0 to (numMembers() - 1).
static int	numMembers() Get the number of members of this type.
java.lang.StringBuffer	render() Return the string equivalent of the UsageModelType with the type type, formatted with the dot operator that the command interpreter understands.
java.lang.String	toString() Return the string equivalent of the UsageModelType.

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

Condition

public static final UsageModelType Condition

Action

public static final UsageModelType Action

Behavior

public static final UsageModelType Behavior

Quality

public static final UsageModelType Quality

Character

public static final UsageModelType Character

Location

public static final UsageModelType Location

Prop

public static final UsageModelType Prop

Method Detail

getAsGeneric

public GenericType getAsGeneric(java.lang.String string)

Return the corresponding UsageModelType for the given string as a GenericType object.

Specified by:

getAsGeneric in interface GenericType

get

public static UsageModelType get(int number)

Return the corresponding UsageModelType for the given number.

Parameters:

number - Number index.

toString

public java.lang.String toString()

Return the string equivalent of the UsageModelType.

Specified by:

toString in interface GenericType

Overrides:

toString in class java.lang.Object

render

public java.lang.StringBuffer render()

Return the string equivalent of the UsageModelType with the type type, formatted with the dot operator that the command interpreter understands.

Specified by:

render in interface GenericType

equals

public boolean equals(java.lang.Object other)

Tests if one instance is the same as some other.

Specified by:

equals in interface GenericType

Overrides:

equals in class java.lang.Object

Parameters:

other - Other UsageModelType to compare to.

getAllTypes

public static ImmutableHashSet getAllTypes()

Return a HashSet of every item in the enumeration.

getAllTypesNonStatically

public ImmutableHashSet getAllTypesNonStatically()

Return a HashSet of every item in the enumeration.

Specified by:

getAllTypesNonStatically in interface GenericType

get

public static UsageModelType get(java.lang.String string)

Static version of get() that gets around the Java restriction on static types in interfaces.

compareTo

public int compareTo(java.lang.Object other)
              throws java.lang.ClassCastException

Specified by:

compareTo in interface java.lang.Comparable

Throws:

java.lang.ClassCastException

getUniqueID

public int getUniqueID()

Get a unique numerial ID for this type that goes from 0 to (numMembers() - 1).

numMembers

public static int numMembers()

Get the number of members of this type.

capitalize

public static java.lang.String capitalize(java.lang.String in)