org.exolab.javasource

Class JEnum

java.lang.Object

org.exolab.javasource.JType

org.exolab.javasource.JStructure

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.

Author:

Andrew Fawcett

Nested Class Summary

Nested classes/interfaces inherited from class org.exolab.javasource.JClass

JClass.JInnerClass

Field Summary

Fields inherited from class org.exolab.javasource.JClass

_constructors, _fields, _innerClasses, _methods, _staticInitializer

Fields inherited from class org.exolab.javasource.JType

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JEnum(java.lang.String name)

Method Summary

Modifier and Type	Method and Description
void	addConstant(JEnumConstant jConstant) Adds the given JEnumConstant to this JEnum.
void	addMember(JMember jMember) Adds the given JMember to this JEnum.
JEnumConstant	getConstant(java.lang.String name) Returns the member with the given name, or null if no member was found with the given name.
JEnumConstant[]	getConstants() Returns an array of all the JEnumConstant of this JEnum.
static void	main(java.lang.String[] args) Test drive.
void	print(JSourceWriter jsw) Prints the source code for this JEnum to the given JSourceWriter.
void	setSuperClass(java.lang.String superClass) Sets the super Class that this class extends.

Methods inherited from class org.exolab.javasource.JClass

addConstructor, addField, addImport, addMethod, addMethod, addMethods, createConstructor, createConstructor, createInnerClass, getConstructor, getConstructors, getField, getFields, getInnerClasses, getMethod, getMethod, getMethods, getStaticInitializationCode, getSuperClass, getSuperClassQualifiedName, print, removeConstructor, removeField, removeField, removeInnerClass, removeMethod

Methods inherited from class org.exolab.javasource.JStructure

addAnnotation, addImport, addImport, addInterface, addInterface, getAnnotatedElementHelper, getAnnotation, getAnnotations, getFilename, getHeader, getImports, getInterfaceCount, getInterfaces, getJDocComment, getModifiers, getName, getPackageFromClassName, getPackageName, hasAnnotations, hasImport, isAnnotationPresent, isValidClassName, print, print, printHeader, printImportDeclarations, printlnWithPrefix, printPackageDeclaration, removeAnnotation, removeImport, setHeader, setPackageName

Methods inherited from class org.exolab.javasource.JType

changePackage, getLocalName, getName, getWrapperName, isArray, isPrimitive, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

JEnum

protected JEnum(java.lang.String name)

Parameters:

name - the name for this JEnum

Method Detail

addMember

public void addMember(JMember jMember)

Adds the given JMember to this JEnum.

Overrides:

addMember in class JClass

Parameters:

jMember - the JMember to add

addConstant

public void addConstant(JEnumConstant jConstant)

Adds the given JEnumConstant to this JEnum.

Parameters:

jConstant - the constant to add

getConstant

public JEnumConstant getConstant(java.lang.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.

getConstants

public JEnumConstant[] getConstants()

Returns an array of all the JEnumConstant of this JEnum.

Returns:

an array of all the JEnumConstant of this JEnum.

setSuperClass

public void setSuperClass(java.lang.String superClass)

Description copied from class: JClass

Sets the super Class that this class extends.

Overrides:

setSuperClass in class JClass

Parameters:

superClass - the super Class that this Class extends

See Also:

{@inheritDoc}

print

public void print(JSourceWriter jsw)

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

Overrides:

print in class JClass

Parameters:

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

main

public static void main(java.lang.String[] args)

Test drive.

Parameters:

args - command-line arguments.