story.scheherazade.parameters
Class SCHVariableType

java.lang.Object
  story.scheherazade.parameters.SCHVariableType

All Implemented Interfaces:

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

public class SCHVariableType
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 SCHVariableType	Action
static SCHVariableType	ActionType
static SCHVariableType	Arguments
static SCHVariableType	AssignedAction
static SCHVariableType	AssignedCondition
static SCHVariableType	AssignedGoal
static SCHVariableType	Behavior
static SCHVariableType	BehaviorType
static SCHVariableType	Bool
static SCHVariableType	Character
static SCHVariableType	CharacterGender
static SCHVariableType	CharacterType
static SCHVariableType	Condition
static SCHVariableType	ConditionType
static SCHVariableType	InvokedState
static SCHVariableType	Location
static SCHVariableType	LocationType
static SCHVariableType	Modifier
static SCHVariableType	Name
static SCHVariableType	Noun
static SCHVariableType	NounType
static SCHVariableType	Preposition
static SCHVariableType	Prop
static SCHVariableType	Proposition
static SCHVariableType	PropType
static SCHVariableType	Quality
static SCHVariableType	QualityType
static SCHVariableType	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 SCHVariableType	get(int number) Return the corresponding SCHVariableType for the given Unique ID (see getUniqueID).
static SCHVariableType	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 SCHVariableType 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 SCHVariableType with the type type, formatted with the dot operator that the command interpreter understands.
java.lang.String	toString() Return the string equivalent of the SCHVariableType.

Methods inherited from class java.lang.Object

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

Field Detail

Action

public static final SCHVariableType Action

ActionType

public static final SCHVariableType ActionType

AssignedAction

public static final SCHVariableType AssignedAction

AssignedCondition

public static final SCHVariableType AssignedCondition

AssignedGoal

public static final SCHVariableType AssignedGoal

Bool

public static final SCHVariableType Bool

Behavior

public static final SCHVariableType Behavior

BehaviorType

public static final SCHVariableType BehaviorType

Character

public static final SCHVariableType Character

CharacterGender

public static final SCHVariableType CharacterGender

CharacterType

public static final SCHVariableType CharacterType

Condition

public static final SCHVariableType Condition

ConditionType

public static final SCHVariableType ConditionType

InvokedState

public static final SCHVariableType InvokedState

Prop

public static final SCHVariableType Prop

PropType

public static final SCHVariableType PropType

Timeline

public static final SCHVariableType Timeline

Location

public static final SCHVariableType Location

LocationType

public static final SCHVariableType LocationType

Name

public static final SCHVariableType Name

Arguments

public static final SCHVariableType Arguments

Modifier

public static final SCHVariableType Modifier

Noun

public static final SCHVariableType Noun

NounType

public static final SCHVariableType NounType

Proposition

public static final SCHVariableType Proposition

Preposition

public static final SCHVariableType Preposition

Quality

public static final SCHVariableType Quality

QualityType

public static final SCHVariableType QualityType

Method Detail

get

public static SCHVariableType get(int number)

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

Parameters:

number - Number index.

toString

public java.lang.String toString()

Return the string equivalent of the SCHVariableType.

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 SCHVariableType 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 SCHVariableType 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 SCHVariableType for the given string as a GenericType object.

Specified by:

getAsGeneric in interface GenericType

get

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