|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.codehaus.janino.util.enumerator.Enumerator
public abstract class Enumerator
A class that represents an enumerated value. Its main features are its toString()
and
fromString(String, Class)
method, which map names to values and vice versa.
To use this class, derive from it and define one or more
public static final
fields, as follows:
public final class Suit extends Enumerator { // Exactly N instances of "Suit" exist to represent the N possible values. public static final Suit CLUBS = new Suit("clubs"); public static final Suit DIAMONDS = new Suit("diamonds"); public static final Suit HEARTS = new Suit("hearts"); public static final Suit SPADES = new Suit("spades"); // Optional, if you want to use EumeratorSet arithmetics. public static final EnumeratorSet NONE = new EnumeratorSet(Suit.class ).setName("none"); public static final EnumeratorSet ALL = new EnumeratorSet(Suit.class, true).setName("all"); // These MUST be declared exactly like this: private Suit(String name) { super(name); } public static Suit fromString(String name) throws EnumeratorFormatException { return (Suit) Enumerator.fromString(name, Suit.class); } }
Constructor Summary | |
---|---|
protected |
Enumerator(java.lang.String name)
Initialize the enumerator to the given value. |
Method Summary | |
---|---|
boolean |
equals(java.lang.Object that)
Equality is reference identity. |
protected static Enumerator |
fromString(java.lang.String name,
java.lang.Class enumeratorClass)
Initialize an Enumerator from a string. |
int |
hashCode()
Enforce Object 's notion of Object.hashCode() . |
java.lang.String |
toString()
Returns the name passed to Enumerator(String) . |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
protected Enumerator(java.lang.String name)
Method Detail |
---|
public final boolean equals(java.lang.Object that)
equals
in class java.lang.Object
public final int hashCode()
Object
's notion of Object.hashCode()
.
hashCode
in class java.lang.Object
protected static final Enumerator fromString(java.lang.String name, java.lang.Class enumeratorClass) throws EnumeratorFormatException
Enumerator
from a string.
The given string is converted into a value by looking at all instances of the given type created so far.
Derived classes should invoke this method as follows:
public class Suit extends Enumerator { ... public static Suit fromString(String name) throws EnumeratorFormatException { return (Suit) Enumerator.fromString(name, Suit.class); } }
EnumeratorFormatException
- if the string cannot be identifiedpublic java.lang.String toString()
name
passed to Enumerator(String)
.
toString
in class java.lang.Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |