Class AbstractJClass

java.lang.Object

org.exolab.javasource.JType

org.exolab.javasource.JStructure

org.exolab.javasource.AbstractJClass

All Implemented Interfaces:

JAnnotatedElement

Direct Known Subclasses:

JClass

public abstract class AbstractJClass
extends JStructure

A abstract base class for representations of the Java Source code for a Java Class.

Since:

1.1

Version:

$Revision: 6668 $ $Date: 2005-05-08 12:32:06 -0600 (Sun, 08 May 2005) $

Author:

Ralf Joachim

Field Summary

Fields inherited from class JType

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

Modifier and Type	Field	Description
static final JPrimitiveType	BOOLEAN	JType for a boolean (Boolean).
static final JPrimitiveType	BYTE	JType instance for a byte (Byte).
static final JPrimitiveType	CHAR	JType instance for a char (Char).
static final JPrimitiveType	DOUBLE	JType instance for a double (Double).
static final JPrimitiveType	FLOAT	JType instance for a float (Float).
static final JPrimitiveType	INT	JType instance for a int (Integer).
static final JPrimitiveType	LONG	JType instance for a long (Long).
static final JPrimitiveType	SHORT	JType instance for a short (Short).

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractJClass(String name)	Creates a new AbstractJClass with the given name.
protected	AbstractJClass(String name, boolean useOldFieldNaming)	Creates a new AbstractJClass with the given name.

Method Summary

Modifier and Type	Method	Description
final void	addConstant(JConstant jConstant)
void	addConstructor(JConstructor constructor)	Adds the given Constructor to this classes list of constructors.
final void	addField(JField jField)	Adds the given JField to this JStructure.
final void	addMethod(JMethod jMethod)	Adds the given JMethod to this JClass.
final void	addMethod(JMethod jMethod, boolean importReturnType)	Adds the given JMethod to this JClass.
final void	addMethods(JMethod[] jMethods)	Adds the given array of JMethods to this JClass.
void	addSourceCode(String sourceCode)	Adds a complete source code fragment (method) to this class.
final JConstructor	createConstructor()	Creates a new JConstructor and adds it to this JClass.
final JConstructor	createConstructor(JParameter[] params)	Creates a new JConstructor and adds it to this JClass.
final JClass	createInnerClass(String localname)	Creates and returns an inner-class for this JClass.
final JConstant	getConstant(String name)
final int	getConstantCount()	Returns the amount of constants.
final JConstant[]	getConstants()
final JConstructor	getConstructor(int index)	Returns the constructor at the specified index.
final JConstructor[]	getConstructors()	Returns the an array of the JConstructors contained within this JClass.
final int	getContructorsCount()
final JField	getField(String name)	Returns the field with the given name, or null if no field was found with that name.
final int	getFieldCount()	Returns the amount of fields.
final JField[]	getFields()	Returns an array of all the JFields of this JStructure.
final int	getInnerClassCount()
final JClass[]	getInnerClasses()	Returns an array of JClass (the inner classes) contained within this JClass.
final JMethod	getMethod(int index)	Returns the JMethod located at the specified index.
final JMethod	getMethod(String name, int startIndex)	Returns the first occurance of the method with the given name, starting from the specified index.
final int	getMethodCount()
final JMethod[]	getMethods()	Returns an array of all the JMethods of this JClass.
String[]	getSourceCodeEntries()	Returns a collection of (complete) source code fragments.
final int	getSourceCodeEntryCount()
final JSourceCode	getStaticInitializationCode()	Returns the JSourceCode for the static initializer of this JClass.
final void	print(JSourceWriter jsw)	Deprecated. Please use the Velocity-template based approach instead.
abstract void	print(JSourceWriter jsw, boolean classOnly)	Deprecated. Please use the Velocity-template based approach instead.
protected final void	printClassHeaders(JSourceWriter jsw)	Writes to the JSourceWriter the headers for this class file.
protected final void	printConstantDefinitions(JSourceWriter jsw)	Writes to the JSourceWriter the constant definitions of this class.
protected final void	printConstructors(JSourceWriter jsw)	Writes to the JSourceWriter all constructors for this class.
protected final void	printInnerClasses(JSourceWriter jsw)	Writes to the JSourceWriter all inner classes belonging to this class.
protected final void	printMemberVariables(JSourceWriter jsw)	Writes to the JSourceWriter the member variables of this class.
protected final void	printMethods(JSourceWriter jsw)	Writes to the JSourceWriter all methods belonging to this class.
protected final void	printSourceCodeFragments(JSourceWriter sourceWriter)
protected final void	printStaticInitializers(JSourceWriter jsw)	Writes to the JSourceWriter any static initialization used by this class.
final JConstant	removeConstant(String name)	Removes the constant with the given name from this JClass.
final boolean	removeConstant(JConstant jConstant)	Removes the given JConstant from this JClass.
final boolean	removeConstructor(JConstructor constructor)	Removes the given constructor from this JClass.
final JField	removeField(String name)	Removes the field with the given name from this JClass.
final boolean	removeField(JField jField)	Removes the given JField from this JClass.
final boolean	removeInnerClass(JClass jClass)	Removes the given inner-class (JClass) from this JClass.
final boolean	removeMethod(JMethod method)	Removes the given method from this JClass.

Methods inherited from class JStructure

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

Modifier and Type	Method	Description
final void	addAnnotation(JAnnotation annotation)	Adds a JAnnotation to this source element.
abstract void	addImport(String className)	Adds the given import to this JStructure.
protected final void	addImport(JAnnotation annotation)	Adds appropriate import for this JAnnotation.
protected final void	addImport(JAnnotation[] annotations)	Adds appropriate imports for each JAnnotation in the given Array.
protected final void	addImportInternal(String className)	Adds the given import to this JStructure.
final void	addInterface(String interfaceName)	Adds the given interface to the list of interfaces this JStructure inherits method declarations from, and either implements (JClass) or extends (JInterface).
abstract void	addMember(JMember jMember)	Adds the given JMember to this JStructure.
protected final JAnnotatedElementHelper	getAnnotatedElementHelper()	Returns the object managing the annotations for this JStructure.
final JAnnotation	getAnnotation(JAnnotationType annotationType)	Retrieves a JAnnotation for the given JAnnotationType, returns null if no annotation has been set.
final JAnnotation[]	getAnnotations()	Returns a list of JAnnotation's already set on this source element.
final String	getFilename(String destDir)	Returns the name of the file that this JStructure would be printed to, given a call to JStructure.print(String, String).
final JComment	getHeader()	Returns the JComment header to display at the top of the source file for this JStructure, or null if no header was set.
final int	getImportCount()	Returns the amount of imports.
final Enumeration<String>	getImports()	Returns an Enumeration of imported package and class names for this JStructure.
final int	getInterfaceCount()	Return the count of the number of Interfaces that have been added to this JStructure.
final Enumeration<String>	getInterfaces()	Returns an Enumeration of interface names that this JStructure inherits from.
final JDocComment	getJDocComment()	Returns the JavaDoc comment for this JStructure.
final JModifiers	getModifiers()	Returns the JModifiers, which allows the qualifiers to be changed.
final String	getPackageName()	Returns the name of the package that this JStructure is a member of.
final boolean	hasAnnotations()	Returns true if this source element has any annotations.
final boolean	hasImport(String classname)	Returns true if the given classname exists in the imports of this JStructure.
final boolean	isAnnotationPresent(JAnnotationType annotationType)	Returns true if a JAnnotation exists for the given JAnnotationType.
final void	print(String destDir, String lineSeparator)	Prints the source code for this JStructure to the destination directory.
final void	printHeader(JSourceWriter jsw)	A utility method that prints the header to the given JSourceWriter.
protected final void	printImportDeclarations(JSourceWriter jsw)	A utility method that prints the imports to the given JSourceWriter.
final void	printPackageDeclaration(JSourceWriter jsw)	A utility method that prints the packageDeclaration to the given JSourceWriter.
final JAnnotation	removeAnnotation(JAnnotationType annotationType)	Removes the JAnnotation from this source element for the given JAnnotationType.
final boolean	removeImport(String className)	Remove the import of the given class name from this JStucture, returning true if the import was found and removed.
final boolean	removeInterface(String interfaceName)	Removes the given interface from the list of interfaces this JStructure has.
final void	setHeader(JComment comment)	Sets the header comment for this JStructure.
final String	toString()	Returns the String representation of this JType.

Methods inherited from class JType

getLocalName, getName, isArray, isPrimitive, setName

Modifier and Type	Method	Description
final String	getLocalName()	Returns the unqualified Java type name (i.e.
final String	getName()	Returns the qualified Java type name.
final boolean	isArray()	Returns true if this type represents an Array.
final boolean	isPrimitive()	Returns true if this type represents a Java primitive type.
protected void	setName(String name)	Sets the qualified name of this type.

Methods inherited from class Object

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

Constructor Details

AbstractJClass

protected AbstractJClass(String name)

Creates a new AbstractJClass with the given name.

Parameters:

name - The name of the AbstractJClass to create.

AbstractJClass

protected AbstractJClass(String name,
 boolean useOldFieldNaming)

Creates a new AbstractJClass with the given name.

Parameters:

name - The name of the AbstractJClass to create.

Method Details

getSourceCodeEntries

public String[] getSourceCodeEntries()

Returns a collection of (complete) source code fragments.

Returns:

A collection of (complete) source code fragments.

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.

getField

public final JField getField(String name)

Returns the field with the given name, or null if no field was found with that name.

Specified by:

getField in class JStructure

Parameters:

name - The name of the field to return.

Returns:

The field with the given name, or null if no field was found with the given name.

getConstant

public final JConstant getConstant(String name)

getFields

public final JField[] getFields()

Returns an array of all the JFields of this JStructure.

Specified by:

getFields in class JStructure

Returns:

An array of all the JFields of this JStructure.

getConstants

public final JConstant[] getConstants()

getFieldCount

public final int getFieldCount()

Returns the amount of fields.

Returns:

The amount of fields.

getConstantCount

public final int getConstantCount()

Returns the amount of constants.

Returns:

The amount of constants.

addField

public final void addField(JField jField)

Adds the given JField to this JStructure.
This method is implemented by subclasses and should only accept the proper fields for the subclass otherwise an IllegalArgumentException will be thrown. For example a JInterface will only accept static fields.

Specified by:

addField in class JStructure

Parameters:

jField - The JField to add.

addConstant

public final void addConstant(JConstant jConstant)

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.

removeConstant

public final JConstant removeConstant(String name)

Removes the constant with the given name from this JClass.

Parameters:

name - The name of the constant to remove.

Returns:

The JConstant 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.

removeConstant

public final boolean removeConstant(JConstant jConstant)

Removes the given JConstant from this JClass.

Parameters:

jConstant - The JConstant to remove.

Returns:

true if the constant was found and removed.

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.

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()

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.

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.

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.

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()

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.

addMethod

public final void addMethod(JMethod jMethod)

Adds the given JMethod to this JClass.

Parameters:

jMethod - The JMethod to add.

addMethods

public final void addMethods(JMethod[] jMethods)

Adds the given array of JMethods to this JClass.

Parameters:

jMethods - The JMethod[] to add.

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.

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.

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.

getInnerClassCount

public final int getInnerClassCount()

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.

print

public final void print(JSourceWriter jsw)

Deprecated.

Please use the Velocity-template based approach instead.

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

Specified by:

print in class JStructure

Parameters:

jsw - The JSourceWriter to print to.

See Also:

• SourceGenerator.setJClassPrinterType(String)

print

public abstract void print(JSourceWriter jsw,
 boolean classOnly)

Deprecated.

Please use the Velocity-template based approach instead.

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.

See Also:

• SourceGenerator.setJClassPrinterType(String)

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.

printConstantDefinitions

protected final void printConstantDefinitions(JSourceWriter jsw)

Writes to the JSourceWriter the constant definitions of 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.

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.

printConstructors

protected final void printConstructors(JSourceWriter jsw)

Writes to the JSourceWriter all constructors for 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.

printSourceCodeFragments

protected final void printSourceCodeFragments(JSourceWriter sourceWriter)

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.

addSourceCode

public void addSourceCode(String sourceCode)

Adds a complete source code fragment (method) to this class.

Parameters:

sourceCode - The complete source code fragment to be added.

getSourceCodeEntryCount

public final int getSourceCodeEntryCount()