Class JEnum

java.lang.Object

org.exolab.javasource.JType

org.exolab.javasource.JStructure

org.exolab.javasource.AbstractJClass

org.exolab.javasource.JClass

org.exolab.javasource.JEnum

All Implemented Interfaces:

JAnnotatedElement

public final class JEnum
extends JClass

Describes the definition of a enum type class.

Version:

$Revision: 8130 $ $Date: 2006-04-25 16:09:10 -0600 (Tue, 25 Apr 2006) $

Author:

Andrew Fawcett

Field Summary

Fields inherited from class JType

BOOLEAN, BYTE, CHAR, DOUBLE, FLOAT, INT, LONG, SHORT

Modifier and Type	Field	Description
static final JPrimitiveType	BOOLEAN	JType for a boolean (Boolean).
static final JPrimitiveType	BYTE	JType instance for a byte (Byte).
static final JPrimitiveType	CHAR	JType instance for a char (Char).
static final JPrimitiveType	DOUBLE	JType instance for a double (Double).
static final JPrimitiveType	FLOAT	JType instance for a float (Float).
static final JPrimitiveType	INT	JType instance for a int (Integer).
static final JPrimitiveType	LONG	JType instance for a long (Long).
static final JPrimitiveType	SHORT	JType instance for a short (Short).

Constructor Summary

Constructors

Constructor	Description
JEnum(String name)	Construct JEnum with given name.

Method Summary

Modifier and Type	Method	Description
void	addConstructor(JConstructor constructor)	Override to only allow private constructors.
void	addEnumConstant(JEnumConstant jEnumConstant)	Adds the given JEnumConstant to this JEnum.
void	addMember(JMember jMember)	Adds the given JMember to this JEnum.
JEnumConstant	getEnumConstant(String name)	Returns the member with the given name, or null if no member was found with the given name.
int	getEnumConstantCount()	Returns the number of enum constants.
JEnumConstant[]	getEnumConstants()	Returns an array of all the JEnumConstant of this JEnum.
void	print(JSourceWriter jsw, boolean classOnly)	Prints the source code for this JClass to the given JSourceWriter.

Methods inherited from class JClass

addImport, changeLocalName, getSuperClass, getSuperClassQualifiedName, setSuperClass

Modifier and Type	Method	Description
final void	addImport(String className)	Adds the given import to this JStructure.
void	changeLocalName(String localName)	Changes the local name of this class type.
final JTypeName	getSuperClass()	Returns the super class that this class extends.
final String	getSuperClassQualifiedName()	Returns the qualified name of the super class that this class extends.
final void	setSuperClass(String superClass)	Sets the super Class that this class extends.

Methods inherited from class AbstractJClass

addConstant, addField, addMethod, addMethod, addMethods, addSourceCode, createConstructor, createConstructor, createInnerClass, getConstant, getConstantCount, getConstants, getConstructor, getConstructors, getContructorsCount, getField, getFieldCount, getFields, getInnerClassCount, getInnerClasses, getMethod, getMethod, getMethodCount, getMethods, getSourceCodeEntries, getSourceCodeEntryCount, getStaticInitializationCode, print, printClassHeaders, printConstantDefinitions, printConstructors, printInnerClasses, printMemberVariables, printMethods, printSourceCodeFragments, printStaticInitializers, removeConstant, removeConstant, removeConstructor, removeField, removeField, removeInnerClass, removeMethod

Modifier and Type	Method	Description
final void	addConstant(JConstant jConstant)
final void	addField(JField jField)	Adds the given JField to this JStructure.
final void	addMethod(JMethod jMethod)	Adds the given JMethod to this JClass.
final void	addMethod(JMethod jMethod, boolean importReturnType)	Adds the given JMethod to this JClass.
final void	addMethods(JMethod[] jMethods)	Adds the given array of JMethods to this JClass.
void	addSourceCode(String sourceCode)	Adds a complete source code fragment (method) to this class.
final JConstructor	createConstructor()	Creates a new JConstructor and adds it to this JClass.
final JConstructor	createConstructor(JParameter[] params)	Creates a new JConstructor and adds it to this JClass.
final JClass	createInnerClass(String localname)	Creates and returns an inner-class for this JClass.
final JConstant	getConstant(String name)
final int	getConstantCount()	Returns the amount of constants.
final JConstant[]	getConstants()
final JConstructor	getConstructor(int index)	Returns the constructor at the specified index.
final JConstructor[]	getConstructors()	Returns the an array of the JConstructors contained within this JClass.
final int	getContructorsCount()
final JField	getField(String name)	Returns the field with the given name, or null if no field was found with that name.
final int	getFieldCount()	Returns the amount of fields.
final JField[]	getFields()	Returns an array of all the JFields of this JStructure.
final int	getInnerClassCount()
final JClass[]	getInnerClasses()	Returns an array of JClass (the inner classes) contained within this JClass.
final JMethod	getMethod(int index)	Returns the JMethod located at the specified index.
final JMethod	getMethod(String name, int startIndex)	Returns the first occurance of the method with the given name, starting from the specified index.
final int	getMethodCount()
final JMethod[]	getMethods()	Returns an array of all the JMethods of this JClass.
String[]	getSourceCodeEntries()	Returns a collection of (complete) source code fragments.
final int	getSourceCodeEntryCount()
final JSourceCode	getStaticInitializationCode()	Returns the JSourceCode for the static initializer of this JClass.
final void	print(JSourceWriter jsw)	Deprecated. Please use the Velocity-template based approach instead.
protected final void	printClassHeaders(JSourceWriter jsw)	Writes to the JSourceWriter the headers for this class file.
protected final void	printConstantDefinitions(JSourceWriter jsw)	Writes to the JSourceWriter the constant definitions of this class.
protected final void	printConstructors(JSourceWriter jsw)	Writes to the JSourceWriter all constructors for this class.
protected final void	printInnerClasses(JSourceWriter jsw)	Writes to the JSourceWriter all inner classes belonging to this class.
protected final void	printMemberVariables(JSourceWriter jsw)	Writes to the JSourceWriter the member variables of this class.
protected final void	printMethods(JSourceWriter jsw)	Writes to the JSourceWriter all methods belonging to this class.
protected final void	printSourceCodeFragments(JSourceWriter sourceWriter)
protected final void	printStaticInitializers(JSourceWriter jsw)	Writes to the JSourceWriter any static initialization used by this class.
final JConstant	removeConstant(String name)	Removes the constant with the given name from this JClass.
final boolean	removeConstant(JConstant jConstant)	Removes the given JConstant from this JClass.
final boolean	removeConstructor(JConstructor constructor)	Removes the given constructor from this JClass.
final JField	removeField(String name)	Removes the field with the given name from this JClass.
final boolean	removeField(JField jField)	Removes the given JField from this JClass.
final boolean	removeInnerClass(JClass jClass)	Removes the given inner-class (JClass) from this JClass.
final boolean	removeMethod(JMethod method)	Removes the given method from this JClass.

Methods inherited from class JStructure

addAnnotation, addImport, addImport, addImportInternal, addInterface, getAnnotatedElementHelper, getAnnotation, getAnnotations, getFilename, getHeader, getImportCount, getImports, getInterfaceCount, getInterfaces, getJDocComment, getModifiers, getPackageName, hasAnnotations, hasImport, isAnnotationPresent, print, printHeader, printImportDeclarations, printPackageDeclaration, removeAnnotation, removeImport, removeInterface, setHeader, toString

Modifier and Type	Method	Description
final void	addAnnotation(JAnnotation annotation)	Adds a JAnnotation to this source element.
protected final void	addImport(JAnnotation annotation)	Adds appropriate import for this JAnnotation.
protected final void	addImport(JAnnotation[] annotations)	Adds appropriate imports for each JAnnotation in the given Array.
protected final void	addImportInternal(String className)	Adds the given import to this JStructure.
final void	addInterface(String interfaceName)	Adds the given interface to the list of interfaces this JStructure inherits method declarations from, and either implements (JClass) or extends (JInterface).
protected final JAnnotatedElementHelper	getAnnotatedElementHelper()	Returns the object managing the annotations for this JStructure.
final JAnnotation	getAnnotation(JAnnotationType annotationType)	Retrieves a JAnnotation for the given JAnnotationType, returns null if no annotation has been set.
final JAnnotation[]	getAnnotations()	Returns a list of JAnnotation's already set on this source element.
final String	getFilename(String destDir)	Returns the name of the file that this JStructure would be printed to, given a call to JStructure.print(String, String).
final JComment	getHeader()	Returns the JComment header to display at the top of the source file for this JStructure, or null if no header was set.
final int	getImportCount()	Returns the amount of imports.
final Enumeration<String>	getImports()	Returns an Enumeration of imported package and class names for this JStructure.
final int	getInterfaceCount()	Return the count of the number of Interfaces that have been added to this JStructure.
final Enumeration<String>	getInterfaces()	Returns an Enumeration of interface names that this JStructure inherits from.
final JDocComment	getJDocComment()	Returns the JavaDoc comment for this JStructure.
final JModifiers	getModifiers()	Returns the JModifiers, which allows the qualifiers to be changed.
final String	getPackageName()	Returns the name of the package that this JStructure is a member of.
final boolean	hasAnnotations()	Returns true if this source element has any annotations.
final boolean	hasImport(String classname)	Returns true if the given classname exists in the imports of this JStructure.
final boolean	isAnnotationPresent(JAnnotationType annotationType)	Returns true if a JAnnotation exists for the given JAnnotationType.
final void	print(String destDir, String lineSeparator)	Prints the source code for this JStructure to the destination directory.
final void	printHeader(JSourceWriter jsw)	A utility method that prints the header to the given JSourceWriter.
protected final void	printImportDeclarations(JSourceWriter jsw)	A utility method that prints the imports to the given JSourceWriter.
final void	printPackageDeclaration(JSourceWriter jsw)	A utility method that prints the packageDeclaration to the given JSourceWriter.
final JAnnotation	removeAnnotation(JAnnotationType annotationType)	Removes the JAnnotation from this source element for the given JAnnotationType.
final boolean	removeImport(String className)	Remove the import of the given class name from this JStucture, returning true if the import was found and removed.
final boolean	removeInterface(String interfaceName)	Removes the given interface from the list of interfaces this JStructure has.
final void	setHeader(JComment comment)	Sets the header comment for this JStructure.
final String	toString()	Returns the String representation of this JType.

Methods inherited from class JType

getLocalName, getName, isArray, isPrimitive, setName

Modifier and Type	Method	Description
final String	getLocalName()	Returns the unqualified Java type name (i.e.
final String	getName()	Returns the qualified Java type name.
final boolean	isArray()	Returns true if this type represents an Array.
final boolean	isPrimitive()	Returns true if this type represents a Java primitive type.
protected void	setName(String name)	Sets the qualified name of this type.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

JEnum

public JEnum(String name)

Construct JEnum with given name.

Parameters:

name - The name for this JEnum.

Method Details

addConstructor

public void addConstructor(JConstructor constructor)

Override to only allow private constructors.

Overrides:

addConstructor in class AbstractJClass

Parameters:

constructor - The constructor that should be added.

addMember

public void addMember(JMember jMember)

Adds the given JMember to this JEnum.

Overrides:

addMember in class JClass

Parameters:

jMember - The JMember to add.

addEnumConstant

public void addEnumConstant(JEnumConstant jEnumConstant)

Adds the given JEnumConstant to this JEnum.

Parameters:

jEnumConstant - The constant to add.

getEnumConstant

public JEnumConstant getEnumConstant(String name)

Returns the member with the given name, or null if no member was found with the given name.

Parameters:

name - The name of the member to return.

Returns:

The member with the given name, or null if no member was found with the given name.

getEnumConstants

public JEnumConstant[] getEnumConstants()

Returns an array of all the JEnumConstant of this JEnum.

Returns:

An array of all the JEnumConstant of this JEnum.

getEnumConstantCount

public int getEnumConstantCount()

Returns the number of enum constants.

Returns:

The number of enum constants.

print

public void print(JSourceWriter jsw,
 boolean classOnly)

Prints the source code for this JClass to the given JSourceWriter.

Overrides:

print in class JClass

Parameters:

jsw - The JSourceWriter to print to. Must not be null.

classOnly - If true, the file header, package declaration, and imports are not printed.

See Also:

• SourceGenerator.setJClassPrinterType(String)