org.exolab.javasource

Class AbstractJClass

Implemented Interfaces:
JAnnotatedElement
Known Direct Subclasses:
JClass

public abstract class AbstractJClass
extends JStructure

A abstract base class for representations of the Java Source code for a Java Class.
Version:
$Revision: 6668 $ $Date: 2005-05-08 12:32:06 -0600 (Sun, 08 May 2005) $
Author:
Ralf Joachim
Since:
1.1

Field Summary

Fields inherited from class org.exolab.javasource.JType

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

Constructor Summary

AbstractJClass(String name)
Creates a new AbstractJClass with the given name.

Method Summary

void
addConstructor(JConstructor constructor)
Adds the given Constructor to this classes list of constructors.
void
addField(JField jField)
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.
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.
int
getContructorsCount()
JField
getField(String name)
int
getFieldCount()
Returns the amount of fields.
JField[]
getFields()
int
getInnerClassCount()
JClass[]
getInnerClasses()
Returns an array of JClass (the inner classes) contained within this JClass.
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.
int
getMethodCount()
JMethod[]
getMethods()
Returns an array of all the JMethods of this JClass.
JSourceCode
getStaticInitializationCode()
Returns the JSourceCode for the static initializer of this JClass.
void
print(JSourceWriter jsw)
abstract void
print(JSourceWriter jsw, boolean classOnly)
Prints the source code for this JClass to the given JSourceWriter.
protected void
printClassHeaders(JSourceWriter jsw)
Writes to the JSourceWriter the headers for this class file.
protected void
printConstructors(JSourceWriter jsw)
Writes to the JSourceWriter all constructors for this class.
protected void
printInnerClasses(JSourceWriter jsw)
Writes to the JSourceWriter all inner classes belonging to this class.
protected void
printMemberVariables(JSourceWriter jsw)
Writes to the JSourceWriter the member variables of this class.
protected void
printMethods(JSourceWriter jsw)
Writes to the JSourceWriter all methods belonging to this class.
protected void
printStaticInitializers(JSourceWriter jsw)
Writes to the JSourceWriter any static initialization used by this class.
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.
boolean
removeMethod(JMethod method)
Removes the given method from this JClass.

Methods inherited from class org.exolab.javasource.JStructure

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

Methods inherited from class org.exolab.javasource.JType

getLocalName, getName, isArray, isPrimitive, setName

Constructor Details

AbstractJClass

protected AbstractJClass(String name)
Creates a new AbstractJClass with the given name.
Parameters:
name - The name of the AbstractJClass to create.

Method Details

addConstructor

public void addConstructor(JConstructor constructor)
Adds the given Constructor to this classes list of constructors. The constructor must have been created with this JClass' createConstructor.
Parameters:
constructor - The constructor to add.

addField

public final void addField(JField jField)
Overrides:
addField in interface JStructure

addMethod

public final void addMethod(JMethod jMethod)
Adds the given JMethod to this JClass.
Parameters:
jMethod - The JMethod to add.

addMethod

public final void addMethod(JMethod jMethod,
                            boolean importReturnType)
Adds the given JMethod to this JClass.
Parameters:
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.

addMethods

public final void addMethods(JMethod[] jMethods)
Adds the given array of JMethods to this JClass.
Parameters:
jMethods - The JMethod[] to add.

createConstructor

public final JConstructor createConstructor()
Creates a new JConstructor and adds it to this JClass.
Returns:
The newly created constructor.

createConstructor

public final JConstructor createConstructor(JParameter[] params)
Creates a new JConstructor and adds it to this JClass.
Parameters:
params - A list of parameters for this constructor.
Returns:
The newly created constructor.

createInnerClass

public final JClass createInnerClass(String localname)
Creates and returns an inner-class for this JClass.
Parameters:
localname - The name of the class (no package name).
Returns:
the new JClass.

getConstructor

public final JConstructor getConstructor(int index)
Returns the constructor at the specified index.
Parameters:
index - The index of the constructor to return.
Returns:
The JConstructor at the specified index.

getConstructors

public final JConstructor[] getConstructors()
Returns the an array of the JConstructors contained within this JClass.
Returns:
An array of JConstructor.

getContructorsCount

public final int getContructorsCount()

getField

public final JField getField(String name)
Overrides:
getField in interface JStructure

getFieldCount

public final int getFieldCount()
Returns the amount of fields.
Returns:
The amount of fields.

getFields

public final JField[] getFields()
Overrides:
getFields in interface JStructure

getInnerClassCount

public final int getInnerClassCount()

getInnerClasses

public final JClass[] getInnerClasses()
Returns an array of JClass (the inner classes) contained within this JClass.
Returns:
An array of JClass contained within this JClass.

getMethod

public final JMethod getMethod(String name,
                               int startIndex)
Returns the first occurance of the method with the given name, starting from the specified index.
Parameters:
name - The name of the method to look for.
startIndex - The starting index to begin the search.
Returns:
The method if found, otherwise null.

getMethod

public final JMethod getMethod(int index)
Returns the JMethod located at the specified index.
Parameters:
index - The index of the JMethod to return.
Returns:
The JMethod.

getMethodCount

public final int getMethodCount()

getMethods

public final JMethod[] getMethods()
Returns an array of all the JMethods of this JClass.
Returns:
An array of all the JMethods of this JClass.

getStaticInitializationCode

public final JSourceCode getStaticInitializationCode()
Returns the JSourceCode for the static initializer of this JClass.
Returns:
The JSourceCode for the static initializer of this JClass.

print

public final void print(JSourceWriter jsw)
Overrides:
print in interface JStructure

print

public abstract void print(JSourceWriter jsw,
                           boolean classOnly)
Prints the source code for this JClass to the given JSourceWriter.
Parameters:
jsw - The JSourceWriter to print to. Must not be null.
classOnly - If true, the file header, package declaration, and imports are not printed.

printClassHeaders

protected final void printClassHeaders(JSourceWriter jsw)
Writes to the JSourceWriter the headers for this class file. Headers include the comment-header, the package declaration, and the imports.
Parameters:
jsw - The JSourceWriter to be used.

printConstructors

protected final void printConstructors(JSourceWriter jsw)
Writes to the JSourceWriter all constructors for this class.
Parameters:
jsw - The JSourceWriter to be used.

printInnerClasses

protected final void printInnerClasses(JSourceWriter jsw)
Writes to the JSourceWriter all inner classes belonging to this class.
Parameters:
jsw - The JSourceWriter to be used.

printMemberVariables

protected final void printMemberVariables(JSourceWriter jsw)
Writes to the JSourceWriter the member variables of this class.
Parameters:
jsw - The JSourceWriter to be used.

printMethods

protected final void printMethods(JSourceWriter jsw)
Writes to the JSourceWriter all methods belonging to this class.
Parameters:
jsw - The JSourceWriter to be used.

printStaticInitializers

protected final void printStaticInitializers(JSourceWriter jsw)
Writes to the JSourceWriter any static initialization used by this class.
Parameters:
jsw - The JSourceWriter to be used.

removeConstructor

public final boolean removeConstructor(JConstructor constructor)
Removes the given constructor from this JClass.
Parameters:
constructor - The JConstructor to remove.
Returns:
true if the constructor was removed, otherwise false.

removeField

public final JField removeField(String name)
Removes the field with the given name from this JClass.
Parameters:
name - The name of the field to remove.
Returns:
The JField if it was found and removed.

removeField

public final boolean removeField(JField jField)
Removes the given JField from this JClass.
Parameters:
jField - The JField to remove.
Returns:
true if the field was found and removed.

removeInnerClass

public final boolean removeInnerClass(JClass jClass)
Removes the given inner-class (JClass) from this JClass.
Parameters:
jClass - The JClass (inner-class) to remove.
Returns:
true if the JClass was removed, otherwise false.

removeMethod

public final boolean removeMethod(JMethod method)
Removes the given method from this JClass.
Parameters:
method - The JMethod to remove.
Returns:
true if the method was removed, otherwise false.

Intalio Inc. (C) 1999-2008. All rights reserved http://www.intalio.com