org.exolab.javasource
Class JEnumConstant
- JAnnotatedElement, JMember
public final class JEnumConstant
Describes the definition of a enum constant.
JEnumConstant(String name) - Constructs a JEnumConstant with a given name and no initialization
arguements.
|
JEnumConstant(String name, String[] arguments) - Constructs a JEnumConstant with a given name and initialization arguments.
|
void | addMethod(JMethod jMethod) - Adds the given JMethod to this JEnumConstant.
|
void | addMethod(JMethod jMethod, boolean importReturnType) - Adds the given JMethod to this JEnumConstant.
|
void | addMethods(JMethod[] jMethods) - Adds the given array of JMethods to this JEnumConstant.
|
String[] | getArguments() - Returns the arguments used by this constant.
|
JDocComment | getComment() - Returns the JavaDoc comment describing this JEnumConstant.
|
JMethod | getMethod(String name, int startIndex) - Returns the first occurance of the method with the given name, starting
from the specified index.
|
JMethod | getMethod(int index) - Returns the JMethod located at the specified index.
|
JMethod[] | getMethods() - Returns an array of all the JMethods of this JEnumConstant.
|
JModifiers | getModifiers() - Returns the modifiers for this JEnumConstant.
|
String | getName() - Returns the name of this JEnumConstant.
|
static void | main(String[] args) - Test drive.
|
void | print(JSourceWriter jsw) - prints this enum constant.
|
void | setArguments(String[] args) - Sets the arguments specified by this constant.
|
void | setComment(String comment) - Sets the JavaDoc comment describing this JEnumConstant.
|
void | setComment(JDocComment comment) - Sets the JavaDoc comment describing this JEnumConstant.
|
void | setName(String name) - Sets the name of this JEnumConstant.
|
JEnumConstant
public JEnumConstant(String name)
Constructs a JEnumConstant with a given name and no initialization
arguements.
name
- name of the constant
JEnumConstant
public JEnumConstant(String name,
String[] arguments)
Constructs a JEnumConstant with a given name and initialization arguments.
name
- name of the constantarguments
- the initialization arguments provided
addMethod
public void addMethod(JMethod jMethod)
Adds the given JMethod to this JEnumConstant.
jMethod
- the JMethod to add
addMethod
public void addMethod(JMethod jMethod,
boolean importReturnType)
Adds the given JMethod to this JEnumConstant.
jMethod
- the JMethod to addimportReturnType
- true if we add the importReturnType to the class
import lists. It could be useful to set it to false when all
types are fully qualified.
addMethods
public void addMethods(JMethod[] jMethods)
Adds the given array of JMethods to this JEnumConstant.
jMethods
- the array of JMethod to add
getArguments
public String[] getArguments()
Returns the arguments used by this constant.
- the arguments used by this constant.
getComment
public JDocComment getComment()
Returns the JavaDoc comment describing this JEnumConstant.
- the JavaDoc comment describing this JEnumConstant, or null if
none has been set.
getMethod
public JMethod getMethod(String name,
int startIndex)
Returns the first occurance of the method with the given name, starting
from the specified index.
name
- the name of the method to look forstartIndex
- the starting index to begin the search
- the method if found, otherwise null.
getMethod
public JMethod getMethod(int index)
Returns the JMethod located at the specified index.
index
- the index of the JMethod to return.
getMethods
public JMethod[] getMethods()
Returns an array of all the JMethods of this JEnumConstant.
- an array of all the JMethods of this JEnumConstant.
getModifiers
public JModifiers getModifiers()
Returns the modifiers for this JEnumConstant.
- getModifiers in interface JMember
- the modifiers for this JEnumConstant.
getName
public String getName()
Returns the name of this JEnumConstant.
- getName in interface JMember
- the name of this JEnumConstant.
print
public void print(JSourceWriter jsw)
prints this enum constant.
setArguments
public void setArguments(String[] args)
Sets the arguments specified by this constant.
args
- initialization arguments for this constant
setComment
public void setComment(String comment)
Sets the JavaDoc comment describing this JEnumConstant.
comment
- the JavaDoc comment for this JEnumConstant
setComment
public void setComment(JDocComment comment)
Sets the JavaDoc comment describing this JEnumConstant.
comment
- the JavaDoc comment for this JEnumConstant.
setName
public void setName(String name)
Sets the name of this JEnumConstant.
name
- the name of this JEnumConstant
Intalio Inc. (C) 1999-2006. All rights reserved http://www.intalio.com