Class Enumerator
java.lang.Object
org.codehaus.janino.util.enumerator.Enumerator
- Direct Known Subclasses:
Access
,Parser.ClassDeclarationContext
,Parser.InterfaceDeclarationContext
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); } }
- See Also:
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
Enumerator
(String name) Initialize the enumerator to the given value. -
Method Summary
Modifier and TypeMethodDescriptionfinal boolean
Equality is reference identity.protected static final Enumerator
fromString
(String name, Class enumeratorClass) Initialize anEnumerator
from a string.final int
hashCode()
EnforceObject
's notion ofObject.hashCode()
.toString()
Returns thename
passed toEnumerator(String)
.
-
Constructor Details
-
Enumerator
Initialize the enumerator to the given value.
-
-
Method Details
-
equals
Equality is reference identity. -
hashCode
public final int hashCode()EnforceObject
's notion ofObject.hashCode()
. -
fromString
protected static final Enumerator fromString(String name, Class enumeratorClass) throws EnumeratorFormatException Initialize anEnumerator
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); } }
- Throws:
EnumeratorFormatException
- if the string cannot be identified
-
toString
Returns thename
passed toEnumerator(String)
.
-