story.scheherazade.misc
Class InterpretativeArcType

java.lang.Object
  extended by story.scheherazade.misc.InterpretativeArcType
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable, GenericType, RenderableObject

public class InterpretativeArcType
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 InterpretativeArcType Actualizes
           
static InterpretativeArcType AttemptToCause
           
static InterpretativeArcType AttemptToPrevent
           
static InterpretativeArcType Because
           
static InterpretativeArcType Causes
           
static InterpretativeArcType Ceases
           
static InterpretativeArcType Damages
           
static InterpretativeArcType FollowedBy
           
static InterpretativeArcType Implies
           
static InterpretativeArcType InterpNodeIn
           
static InterpretativeArcType InterpretedAs
           
static InterpretativeArcType Modifies
           
static InterpretativeArcType PreconditionFor
           
static InterpretativeArcType ProvidesFor
           
static InterpretativeArcType WouldCause
           
static InterpretativeArcType WouldPrevent
           
 
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 InterpretativeArcType get(int number)
          Return the corresponding InterpretativeArcType for the given Unique ID (see getUniqueID).
static InterpretativeArcType 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 InterpretativeArcType 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 InterpretativeArcType with the type type, formatted with the dot operator that the command interpreter understands.
 java.lang.String toString()
          Return the string equivalent of the InterpretativeArcType.
 
Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

InterpretedAs

public static final InterpretativeArcType InterpretedAs

FollowedBy

public static final InterpretativeArcType FollowedBy

Causes

public static final InterpretativeArcType Causes

Modifies

public static final InterpretativeArcType Modifies

ProvidesFor

public static final InterpretativeArcType ProvidesFor

Damages

public static final InterpretativeArcType Damages

PreconditionFor

public static final InterpretativeArcType PreconditionFor

WouldCause

public static final InterpretativeArcType WouldCause

WouldPrevent

public static final InterpretativeArcType WouldPrevent

Actualizes

public static final InterpretativeArcType Actualizes

Ceases

public static final InterpretativeArcType Ceases

AttemptToCause

public static final InterpretativeArcType AttemptToCause

AttemptToPrevent

public static final InterpretativeArcType AttemptToPrevent

InterpNodeIn

public static final InterpretativeArcType InterpNodeIn

Implies

public static final InterpretativeArcType Implies

Because

public static final InterpretativeArcType Because
Method Detail

get

public static InterpretativeArcType get(int number)
Return the corresponding InterpretativeArcType for the given Unique ID (see getUniqueID).

Parameters:
number - Number index.

toString

public java.lang.String toString()
Return the string equivalent of the InterpretativeArcType.

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

Specified by:
getAsGeneric in interface GenericType

get

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


Copyright © 2011 David K. Elson. All Rights Reserved.