public class JClass extends JStructure
Constructor | Description |
---|---|
JClass(String name) |
Creates a new JClass with the given name
|
Modifier and Type | Method | Description |
---|---|---|
void |
addConstructor(JConstructor constructor) |
Adds the given Constructor to this classes list of constructors.
|
void |
addField(JField jField) |
Adds the given JField to this JClass
|
void |
addMember(org.codehaus.modello.plugin.java.javasource.JMember jMember) |
Adds the given JMember to this JClass
|
void |
addMethod(JMethod jMethod) |
Adds the given JMethod to this JClass
|
void |
addMethod(JMethod jMethod,
boolean importReturnType) |
Adds the given JMethod to this JClass
|
void |
addMethods(JMethod[] jMethods) |
Adds the given array of JMethods to this JClass
|
void |
addSourceCode(String sourceCode) |
|
JConstructor |
createConstructor() |
Creates a new JConstructor and adds it to this
JClass.
|
JConstructor |
createConstructor(JParameter[] params) |
Creates a new JConstructor and adds it to this
JClass.
|
JClass |
createInnerClass(String localname) |
Creates and returns an inner-class for this JClass
|
JConstructor |
getConstructor(int index) |
Returns the constructor at the specified index.
|
JConstructor[] |
getConstructors() |
Returns the an array of the JConstructors contained within this JClass
|
JField |
getField(String name) |
Returns the member with the given name, or null if no member
was found with the given name
|
JField[] |
getFields() |
Returns an array of all the JFields of this JClass
|
JClass[] |
getInnerClasses() |
Returns an array of JClass (the inner classes)
contained within this JClass.
|
JMethod |
getMethod(int index) |
Returns the JMethod located at the specified index
|
JMethod |
getMethod(String name,
int startIndex) |
Returns the first occurrence of the method with the
given name, starting from the specified index.
|
JMethod[] |
getMethods() |
Returns an array of all the JMethods of this JClass
|
JSourceCode |
getStaticInitializationCode() |
Returns the JSourceCode for the static initializer
of this JClass
|
String |
getSuperClass() |
Gets the super Class that this class extends
|
void |
print(JSourceWriter jsw) |
Prints the source code for this JClass to the given JSourceWriter
|
void |
print(JSourceWriter jsw,
boolean classOnly) |
Prints the source code for this JClass to the given JSourceWriter
|
boolean |
removeConstructor(JConstructor constructor) |
Removes the given constructor from this JClass
|
JField |
removeField(String name) |
Removes the field with the given name from this JClass
|
boolean |
removeField(JField jField) |
Removes the given JField from this JClass
|
boolean |
removeInnerClass(JClass jClass) |
Removes the given inner-class (JClass) from this JClass.
|
void |
setSuperClass(String superClass) |
Sets the super Class that this class extends
|
addImport, addInterface, addInterface, appendAnnotation, getAnnotations, getFilename, getHeader, getImports, getInterfaceCount, getInterfaces, getJDocComment, getModifiers, getName, getPackageFromClassName, getPackageName, hasImport, isAbstract, isValidClassName, print, print, printHeader, printImportDeclarations, printlnWithPrefix, printPackageDeclaration, removeImport, setAnnotations, setHeader, setPackageName
changePackage, createArray, getComponentType, getLocalName, getName, isArray, isPrimitive, toString
public JClass(String name) throws IllegalArgumentException
name
- the name of the JClass to createIllegalArgumentException
- when the given name
is not a valid Class namepublic void addConstructor(JConstructor constructor) throws IllegalArgumentException
constructor
- a constructorIllegalArgumentException
- if constructor
is null
or invalid.public void addField(JField jField) throws IllegalArgumentException
addField
in class JStructure
jField
- , the JField to addIllegalArgumentException
- when the given
JField has a name of an existing JFieldpublic void addMember(org.codehaus.modello.plugin.java.javasource.JMember jMember) throws IllegalArgumentException
addMember
in class JStructure
jMember
- , the JMember to addIllegalArgumentException
- when the given
JMember has the same name of an existing JField
or JMethod respectively, or if the JMember is of an
unrecognized class.public void addMethod(JMethod jMethod)
jMethod
- the JMethod to addpublic void addMethod(JMethod jMethod, boolean importReturnType) throws IllegalArgumentException
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.IllegalArgumentException
- when the given
JMethod has the same name of an existing JMethod.public void addMethods(JMethod[] jMethods) throws IllegalArgumentException
jMethods
- , the JMethod[] to addIllegalArgumentException
- when any of the given
JMethods has the same name of an existing JMethod.public JConstructor createConstructor()
public JConstructor createConstructor(JParameter[] params)
params
- the parameterspublic JClass createInnerClass(String localname)
localname
- the name of the class (no package name)public JConstructor getConstructor(int index)
index
- the index of the constructor to returnpublic JConstructor[] getConstructors()
public JField getField(String name)
getField
in class JStructure
name
- the name of the member to returnpublic JField[] getFields()
getFields
in class JStructure
public JClass[] getInnerClasses()
public JMethod[] getMethods()
public JMethod getMethod(String name, int startIndex)
name
- the name of the method to look forstartIndex
- the starting index to begin the searchpublic JMethod getMethod(int index)
index
- the index of the JMethod to return.public JSourceCode getStaticInitializationCode()
public String getSuperClass()
public void print(JSourceWriter jsw)
print
in class JStructure
jsw
- the JSourceWriter to print to. [May not be null]public void print(JSourceWriter jsw, boolean classOnly)
jsw
- the JSourceWriter to print to. [May not be null]classOnly
- whether the header, package and imports should be printed toopublic void addSourceCode(String sourceCode)
public boolean removeConstructor(JConstructor constructor)
constructor
- the JConstructor to removepublic JField removeField(String name)
name
- the name of the field to removepublic boolean removeField(JField jField)
jField
- , the JField to removetrue
if and only if the field was successfully removedpublic boolean removeInnerClass(JClass jClass)
jClass
- the JClass (inner-class) to remove.public void setSuperClass(String superClass)
superClass
- the super Class that this Class extendsCopyright © 2001–2018 Codehaus Plexus. All rights reserved.