public class TypesafeEnumerationGenerator
extends java.lang.Object
This class is a generator for the typesafe enumeration pattern. It creates a class that contains only a few, specified instances. Other instances cannot be created.
Any instance has a name and a value. The name
Modifier and Type | Class and Description |
---|---|
static class |
TypesafeEnumerationGenerator.Item |
Constructor and Description |
---|
TypesafeEnumerationGenerator() |
Modifier and Type | Method and Description |
---|---|
JavaSource |
generate(JavaSourceFactory pFactory,
JavaQName pTargetClass,
TypesafeEnumerationGenerator.Item[] pItems)
Generates a new typesafe enumeration.
|
JavaInnerClass |
generate(JavaSource pSource,
java.lang.String pName,
TypesafeEnumerationGenerator.Item[] pItems)
Generates a new typesafe enumeration, which is an inner class of
the class
pSource . |
boolean |
isAddingEquals()
Returns whether the generator should add implementations for the methods
Object.equals(java.lang.Object) and Object.hashCode()
or not. |
void |
setAddingEquals(boolean pAddingEquals)
Sets whether the generator should add implementations for the methods
Object.equals(java.lang.Object) and Object.hashCode()
or not. |
public void setAddingEquals(boolean pAddingEquals)
Sets whether the generator should add implementations for the methods
Object.equals(java.lang.Object)
and Object.hashCode()
or not. Defaults to true.
public boolean isAddingEquals()
Returns whether the generator should add implementations for the methods
Object.equals(java.lang.Object)
and Object.hashCode()
or not. Defaults to true.
public JavaSource generate(JavaSourceFactory pFactory, JavaQName pTargetClass, TypesafeEnumerationGenerator.Item[] pItems)
Generates a new typesafe enumeration.
pFactory
- The factory to use for generating the items.pTargetClass
- Fully qualified name of the class being generated.pItems
- The enumeration items; a public, static, final instance
will be generated for any element in the arraypublic JavaInnerClass generate(JavaSource pSource, java.lang.String pName, TypesafeEnumerationGenerator.Item[] pItems)
Generates a new typesafe enumeration, which is an inner class of
the class pSource
.
pSource
- The class, which shall have an inner classpName
- Name of the inner classpItems
- The enumeration items; a public, static, final instance
will be generated for any element in the array