story.scheherazade.misc
Class ScheherIDType

java.lang.Object
  story.scheherazade.misc.ScheherIDType

All Implemented Interfaces:

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

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

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 ScheherIDType	Action
static ScheherIDType	BehaviorName
static ScheherIDType	BehaviorType
static ScheherIDType	CharacterName
static ScheherIDType	CharacterType
static ScheherIDType	Condition
static ScheherIDType	ContributorID
static ScheherIDType	GenericNounType
static ScheherIDType	LocationName
static ScheherIDType	LocationType
static ScheherIDType	Modifier
static ScheherIDType	Narrative
static ScheherIDType	PropName
static ScheherIDType	PropType
static ScheherIDType	QualityName
static ScheherIDType	QualityType
static ScheherIDType	Timeline

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 ScheherIDType	get(int number) Return the corresponding ScheherIDType for the given Unique ID (see getUniqueID).
static ScheherIDType	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 ScheherIDType 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 ScheherIDType with the type type, formatted with the dot operator that the command interpreter understands.
java.lang.String	toString() Return the string equivalent of the ScheherIDType.

Methods inherited from class java.lang.Object

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

Field Detail

Narrative

public static final ScheherIDType Narrative

Timeline

public static final ScheherIDType Timeline

Condition

public static final ScheherIDType Condition

BehaviorName

public static final ScheherIDType BehaviorName

BehaviorType

public static final ScheherIDType BehaviorType

QualityName

public static final ScheherIDType QualityName

QualityType

public static final ScheherIDType QualityType

CharacterName

public static final ScheherIDType CharacterName

CharacterType

public static final ScheherIDType CharacterType

Action

public static final ScheherIDType Action

PropType

public static final ScheherIDType PropType

PropName

public static final ScheherIDType PropName

LocationType

public static final ScheherIDType LocationType

LocationName

public static final ScheherIDType LocationName

Modifier

public static final ScheherIDType Modifier

ContributorID

public static final ScheherIDType ContributorID

GenericNounType

public static final ScheherIDType GenericNounType

Method Detail

get

public static ScheherIDType get(int number)

Return the corresponding ScheherIDType for the given Unique ID (see getUniqueID).

Parameters:

number - Number index.

toString

public java.lang.String toString()

Return the string equivalent of the ScheherIDType.

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 ScheherIDType with the type type, formatted with the dot operator that the command interpreter understands.

Specified by:

render in interface GenericType

Specified by:

render in interface RenderableObject

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 ScheherIDType 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

getAsGeneric

public GenericType getAsGeneric(java.lang.String string)

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

Specified by:

getAsGeneric in interface GenericType

get

public static ScheherIDType 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)