story.scheherazade.misc
Class GenericScheherID

java.lang.Object
  extended by story.scheherazade.misc.GenericScheherID
All Implemented Interfaces:
java.lang.Comparable, RenderableObject
Direct Known Subclasses:
ActionType, ConditionType, ContributorID, ModifierType, NarrativeID, NounName, NounType, TimelineID

public abstract class GenericScheherID
extends java.lang.Object
implements RenderableObject, java.lang.Comparable

An abstract class that represents a Scheherazade-specific identifier.

Other classes pass around extensions of this class when referring to various data by name.


Constructor Summary
GenericScheherID()
           
 
Method Summary
 int compareTo(java.lang.Object other)
           
 boolean equals(GenericScheherID other)
          Test the equality of this GenericScheherID with another one.
 ScheherIDType getIDType()
           
 boolean isEveryType()
           
 boolean isGenericType()
           
 boolean isGroupType()
           
 boolean isUniversalType()
           
abstract  java.lang.StringBuffer render()
          Render the ID in a StringBuffer.
 java.lang.String toRawString()
          Render the ID as a String without punctuation.
 java.lang.String toString()
          Render the ID as a string.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

GenericScheherID

public GenericScheherID()
Method Detail

render

public abstract java.lang.StringBuffer render()
                                       throws Scheherexception
Render the ID in a StringBuffer. Automatically punctuates according to ID type.

Specified by:
render in interface RenderableObject
Throws:
Scheherexception

toRawString

public java.lang.String toRawString()
Render the ID as a String without punctuation.


toString

public java.lang.String toString()
Render the ID as a string.

Overrides:
toString in class java.lang.Object

equals

public boolean equals(GenericScheherID other)
               throws Scheherexception
Test the equality of this GenericScheherID with another one.

Throws:
Scheherexception

getIDType

public ScheherIDType getIDType()

compareTo

public int compareTo(java.lang.Object other)
              throws java.lang.ClassCastException
Specified by:
compareTo in interface java.lang.Comparable
Throws:
java.lang.ClassCastException

isUniversalType

public boolean isUniversalType()

isGroupType

public boolean isGroupType()

isEveryType

public boolean isEveryType()

isGenericType

public boolean isGenericType()


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