|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.exolab.javasource.JAnnotatedElementHelper
org.exolab.javasource.JEnumConstant
public final class JEnumConstant
Describes the definition of a enum constant.
Constructor Summary | |
---|---|
JEnumConstant(java.lang.String name)
Constructs a JEnumConstant with a given name and no initialization arguements. |
|
JEnumConstant(java.lang.String name,
java.lang.String[] arguments)
Constructs a JEnumConstant with a given name and initialization arguments. |
Method Summary | |
---|---|
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. |
java.lang.String[] |
getArguments()
Returns the arguments used by this constant. |
JDocComment |
getComment()
Returns the JavaDoc comment describing this JEnumConstant. |
JMethod |
getMethod(int index)
Returns the JMethod located at the specified index. |
JMethod |
getMethod(java.lang.String name,
int startIndex)
Returns the first occurance of the method with the given name, starting from the specified index. |
JMethod[] |
getMethods()
Returns an array of all the JMethods of this JEnumConstant. |
JModifiers |
getModifiers()
Returns the modifiers for this JEnumConstant. |
java.lang.String |
getName()
Returns the name of this JEnumConstant. |
void |
print(JSourceWriter jsw)
prints this enum constant. |
void |
setArguments(java.lang.String[] args)
Sets the arguments specified by this constant. |
void |
setComment(JDocComment comment)
Sets the JavaDoc comment describing this JEnumConstant. |
void |
setComment(java.lang.String comment)
Sets the JavaDoc comment describing this JEnumConstant. |
void |
setName(java.lang.String name)
Sets the name of this JEnumConstant. |
Methods inherited from class org.exolab.javasource.JAnnotatedElementHelper |
---|
addAnnotation, getAnnotation, getAnnotations, hasAnnotations, isAnnotationPresent, printAnnotations, removeAnnotation |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public JEnumConstant(java.lang.String name)
name
- Name of the constant.public JEnumConstant(java.lang.String name, java.lang.String[] arguments)
name
- Name of the constant.arguments
- The initialization arguments provided.Method Detail |
---|
public JModifiers getModifiers()
getModifiers
in interface JMember
public void setArguments(java.lang.String[] args)
args
- Initialization arguments for this constant.public java.lang.String[] getArguments()
public void addMethod(JMethod jMethod)
jMethod
- The JMethod to add.public void addMethod(JMethod jMethod, boolean importReturnType)
jMethod
- The JMethod to add.importReturnType
- 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.public void addMethods(JMethod[] jMethods)
jMethods
- The array of JMethod to add.public JMethod[] getMethods()
public JMethod getMethod(java.lang.String name, int startIndex)
name
- The name of the method to look for.startIndex
- The starting index to begin the search.
public JMethod getMethod(int index)
index
- The index of the JMethod to return.
public void setName(java.lang.String name)
name
- The name of this JEnumConstant.public java.lang.String getName()
getName
in interface JMember
public void setComment(JDocComment comment)
comment
- The JavaDoc comment for this JEnumConstant.public void setComment(java.lang.String comment)
comment
- The JavaDoc comment for this JEnumConstant.public JDocComment getComment()
public void print(JSourceWriter jsw)
jsw
- The JSourceWriter to print to. Must not be null.
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |