story.scheherazade.prologuer
Class PredicateMode

java.lang.Object
  story.scheherazade.prologuer.PredicateMode

All Implemented Interfaces:

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

public class PredicateMode
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 PredicateMode	ActionAssert
static PredicateMode	ActionGerund
static PredicateMode	ActionHowInstructional
static PredicateMode	ActionImperative
static PredicateMode	ActionInfinitive
static PredicateMode	ConditionAssert
static PredicateMode	ConditionGerund
static PredicateMode	ConditionHowInstructional
static PredicateMode	ConditionImperative
static PredicateMode	ConditionInfinitive
static PredicateMode	GenericPlaceholder
static PredicateMode	How
static PredicateMode	NonApplicable
static PredicateMode	RealityAction
static PredicateMode	RealityCondition
static PredicateMode	TimelineAssert
static PredicateMode	TimelineHowFactual
static PredicateMode	TimelineHowInstructional
static PredicateMode	TimelineImperative
static PredicateMode	TimelineSubjunctive

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

Methods inherited from class java.lang.Object

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

Field Detail

ActionAssert

public static final PredicateMode ActionAssert

ActionInfinitive

public static final PredicateMode ActionInfinitive

ActionImperative

public static final PredicateMode ActionImperative

ActionHowInstructional

public static final PredicateMode ActionHowInstructional

ActionGerund

public static final PredicateMode ActionGerund

ConditionAssert

public static final PredicateMode ConditionAssert

How

public static final PredicateMode How

NonApplicable

public static final PredicateMode NonApplicable

ConditionImperative

public static final PredicateMode ConditionImperative

TimelineImperative

public static final PredicateMode TimelineImperative

TimelineSubjunctive

public static final PredicateMode TimelineSubjunctive

TimelineHowFactual

public static final PredicateMode TimelineHowFactual

TimelineHowInstructional

public static final PredicateMode TimelineHowInstructional

TimelineAssert

public static final PredicateMode TimelineAssert

ConditionInfinitive

public static final PredicateMode ConditionInfinitive

ConditionHowInstructional

public static final PredicateMode ConditionHowInstructional

ConditionGerund

public static final PredicateMode ConditionGerund

GenericPlaceholder

public static final PredicateMode GenericPlaceholder

RealityAction

public static final PredicateMode RealityAction

RealityCondition

public static final PredicateMode RealityCondition

Method Detail

getAsGeneric

public GenericType getAsGeneric(java.lang.String string)

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

Specified by:

getAsGeneric in interface GenericType

get

public static PredicateMode get(int number)

Return the corresponding PredicateMode for the given number.

Parameters:

number - Number index.

toString

public java.lang.String toString()

Return the string equivalent of the PredicateMode.

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 PredicateMode 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 PredicateMode 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 PredicateMode 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)