org.exolab.javasource

Class JStructure

java.lang.Object

org.exolab.javasource.JType

org.exolab.javasource.JStructure

All Implemented Interfaces:

JAnnotatedElement

Direct Known Subclasses:

JAnnotationType, JClass, JInterface

public abstract class JStructure
extends JType
implements JAnnotatedElement

This class represents the basic Java "structure" for a Java source file. This is the base class for JClass and JInterface.

This is a useful utility when creating in memory source code. The code in this package was modelled after the Java Reflection API as much as possible to reduce the learning curve.

Version:

$Revision: 6324 $ $Date: 2005-12-13 14:58:48 -0700 (Tue, 13 Dec 2005) $

Author:

Martin Skopp, Keith Visco

Field Summary

Fields inherited from class org.exolab.javasource.JType

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JStructure(java.lang.String name) Creates a new JStructure with the given name.

Method Summary

Modifier and Type	Method and Description
void	addAnnotation(JAnnotation annotation) Adds a JAnnotation to this source element.
abstract void	addField(JField jField) Adds the given JField to this JStructure.
protected void	addImport(JAnnotation annotation) Adds appropriate import for this JAnnotation.
protected void	addImport(JAnnotation[] annotations) Adds appropriate imports for each JAnnotation in the given Array.
void	addImport(java.lang.String className) Adds the given import to this JStructure.
void	addInterface(JInterface jInterface) Adds the given interface to the list of interfaces this JStructure inherits method declarations from, and either implements (JClass) or extends (JInterface).
void	addInterface(java.lang.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 JAnnotatedElementHelper	getAnnotatedElementHelper() Returns the object managing the annotations for this JStructure.
JAnnotation	getAnnotation(JAnnotationType annotationType) Retrieves a JAnnotation for the given JAnnotationType, returns null if no annotation has been set.
JAnnotation[]	getAnnotations() Returns a list of JAnnotation's already set on this source element.
abstract JField	getField(java.lang.String name) Returns the field with the given name, or null if no field was found with that name.
abstract JField[]	getFields() Returns an array of all the JFields of this JStructure.
java.lang.String	getFilename(java.lang.String destDir) Returns the name of the file that this JStructure would be printed to, given a call to print(String, String), or given a call to print() if the parameter destDir is null.
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.
java.util.Enumeration	getImports() Returns an Enumeration of imported package and class names for this JStructure.
protected int	getInterfaceCount() Return the count of the number of Interfaces that have been added to this JStructure.
java.util.Enumeration	getInterfaces() Returns an Enumeration of interface names that this JStructure inherits from.
JDocComment	getJDocComment() Returns the JavaDoc comment for this JStructure.
JModifiers	getModifiers() Returns the JModifiers, which allows the qualifiers to be changed.
java.lang.String	getName(boolean stripPackage) Returns the name of the class represented by this JStructure.
protected static java.lang.String	getPackageFromClassName(java.lang.String className) Returns the package name from the given class name.
java.lang.String	getPackageName() Returns the name of the package that this JStructure is a member of.
boolean	hasAnnotations() Returns true if this source element has any annotations.
boolean	hasImport(java.lang.String classname) Returns true if the given classname exists in the imports of this JStructure.
boolean	isAnnotationPresent(JAnnotationType annotationType) Returns true if a JAnnotation exists for the given JAnnotationType.
static boolean	isValidClassName(java.lang.String classname) Test the provided name and return true if it is a valid class name.
void	print() Prints the source code for this JStructure in the current working directory.
abstract void	print(JSourceWriter jsw) Prints the source code for this JStructure to the given JSourceWriter.
void	print(java.lang.String destDir, java.lang.String lineSeparator) Prints the source code for this JStructure to the destination directory.
void	printHeader(JSourceWriter jsw) A utility method that prints the header to the given JSourceWriter.
void	printImportDeclarations(JSourceWriter jsw) A utility method that prints the imports to the given JSourceWriter.
protected static void	printlnWithPrefix(java.lang.String prefix, java.lang.String source, JSourceWriter jsw) Prints the given source string to the JSourceWriter using the given prefix at the beginning of each new line.
void	printPackageDeclaration(JSourceWriter jsw) A utility method that prints the packageDeclaration to the given JSourceWriter.
JAnnotation	removeAnnotation(JAnnotationType annotationType) Removes the JAnnotation from this source element for the given JAnnotationType.
boolean	removeImport(java.lang.String className) Remove the import of the given class name from this JStucture, returning true if the import was found and removed.
void	setHeader(JComment comment) Sets the header comment for this JStructure.
void	setPackageName(java.lang.String packageName) Allows changing the package name of this JStructure.

Methods inherited from class org.exolab.javasource.JType

changePackage, getLocalName, getName, getWrapperName, isArray, isPrimitive, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

JStructure

protected JStructure(java.lang.String name)

Creates a new JStructure with the given name.

Parameters:

name - the name of the JStructure.

Method Detail

addField

public abstract 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.

Parameters:

jField - the JField to add

addMember

public abstract void addMember(JMember jMember)

Adds the given JMember to this JStructure.

This method is implemented by subclasses and should only accept the proper types for the subclass otherwise an IllegalArgumentException will be thrown.

Parameters:

jMember - the JMember to add to this JStructure.

addImport

public void addImport(java.lang.String className)

Adds the given import to this JStructure.

Parameters:

className - name of the class to import.

addImport

protected final void addImport(JAnnotation annotation)

Adds appropriate import for this JAnnotation.

Parameters:

annotation - a JAnnotation for which we want to add an import to this JStructure

addImport

protected final void addImport(JAnnotation[] annotations)

Adds appropriate imports for each JAnnotation in the given Array.

Parameters:

annotations - an Array of JAnnotation; we want to add an import to this JStructure for each JAnnotation in the Array

addInterface

public final void addInterface(java.lang.String interfaceName)

Adds the given interface to the list of interfaces this JStructure inherits method declarations from, and either implements (JClass) or extends (JInterface).

Parameters:

interfaceName - the name of the interface to "inherit" method declarations from.

addInterface

public final void addInterface(JInterface jInterface)

Adds the given interface to the list of interfaces this JStructure inherits method declarations from, and either implements (JClass) or extends (JInterface).

Parameters:

jInterface - the JInterface to inherit from.

getField

public abstract JField getField(java.lang.String name)

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

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.

getFields

public abstract JField[] getFields()

Returns an array of all the JFields of this JStructure.

Returns:

an array of all the JFields of this JStructure.

getFilename

public final java.lang.String getFilename(java.lang.String destDir)

Returns the name of the file that this JStructure would be printed to, given a call to print(String, String), or given a call to print() if the parameter destDir is null.

Parameters:

destDir - the destination directory. This may be null.

Returns:

the name of the file that this JInterface would be printed to

getHeader

public 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.

Returns:

the JComment header or null if none exists.

getImports

public final java.util.Enumeration getImports()

Returns an Enumeration of imported package and class names for this JStructure.

Returns:

the Enumeration of imports. May be empty but will not be null.

getInterfaces

public final java.util.Enumeration getInterfaces()

Returns an Enumeration of interface names that this JStructure inherits from.

Returns:

the Enumeration of interface names for this JStructure. May be empty but will not be null.

getJDocComment

public final JDocComment getJDocComment()

Returns the JavaDoc comment for this JStructure.

Returns:

the JDocComment for this JStructure.

getAnnotatedElementHelper

protected final JAnnotatedElementHelper getAnnotatedElementHelper()

Returns the object managing the annotations for this JStructure.

Returns:

the object managing the annotations for this JStructure.

getModifiers

public final JModifiers getModifiers()

Returns the JModifiers, which allows the qualifiers to be changed.

Returns:

the JModifiers for this JStructure.

getPackageName

public final java.lang.String getPackageName()

Returns the name of the package that this JStructure is a member of.

Returns:

the name of the package that this JStructure is a member of, or null if there is no current package name defined.

getName

public final java.lang.String getName(boolean stripPackage)

Returns the name of the class represented by this JStructure.

Parameters:

stripPackage - a boolean that when true indicates that only the local name (no package) should be returned.

Returns:

the name of the class represented by this JStructure, including the full package if stripPackage is false.

hasImport

public final boolean hasImport(java.lang.String classname)

Returns true if the given classname exists in the imports of this JStructure.

Parameters:

classname - the class name to check for

Returns:

true if the given classname exists in the imports list.

removeImport

public final boolean removeImport(java.lang.String className)

Remove the import of the given class name from this JStucture, returning true if the import was found and removed.

Parameters:

className - Name of the class to remove the import of

Returns:

if the import was previously part of this JStructure, false otherwise.

isValidClassName

public static boolean isValidClassName(java.lang.String classname)

Test the provided name and return true if it is a valid class name.

Parameters:

classname - A class name to test.

Returns:

true if the provided class name is a valid class name.

print

public final void print()

Prints the source code for this JStructure in the current working directory. Sub-directories will be created if necessary for the package.

print

public final void print(java.lang.String destDir,
                        java.lang.String lineSeparator)

Prints the source code for this JStructure to the destination directory. Subdirectories will be created if necessary for the package.

Parameters:

destDir - directory name to use as the root directory for all output

lineSeparator - the line separator to use at the end of each line. If null, then the default line separator for the runtime platform will be used.

print

public abstract void print(JSourceWriter jsw)

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

Parameters:

jsw - the JSourceWriter to print to.

printHeader

public final void printHeader(JSourceWriter jsw)

A utility method that prints the header to the given JSourceWriter.

Parameters:

jsw - the JSourceWriter to print to.

printImportDeclarations

public final void printImportDeclarations(JSourceWriter jsw)

A utility method that prints the imports to the given JSourceWriter.

Parameters:

jsw - the JSourceWriter to print to.

printPackageDeclaration

public final void printPackageDeclaration(JSourceWriter jsw)

A utility method that prints the packageDeclaration to the given JSourceWriter.

Parameters:

jsw - the JSourceWriter to print to.

setHeader

public final void setHeader(JComment comment)

Sets the header comment for this JStructure.

Parameters:

comment - the comment to display at the top of the source file when printed

setPackageName

public void setPackageName(java.lang.String packageName)

Allows changing the package name of this JStructure.

Parameters:

packageName - the package name to use

addAnnotation

public final void addAnnotation(JAnnotation annotation)

Description copied from interface: JAnnotatedElement

Adds a JAnnotation to this source element. An IllegalArgumentException is thrown if one already exists for the associated JAnnotationType.

Specified by:

addAnnotation in interface JAnnotatedElement

Parameters:

annotation - a JAnnotation to add to this source element.

See Also:

#addAnnotation(org.exolab.javasource.JAnnotation) {@inheritDoc}

getAnnotation

public final JAnnotation getAnnotation(JAnnotationType annotationType)

Description copied from interface: JAnnotatedElement

Retrieves a JAnnotation for the given JAnnotationType, returns null if no annotation has been set.

Specified by:

getAnnotation in interface JAnnotatedElement

Parameters:

annotationType - Annotation type to retrieve

Returns:

A JAnnotation for the given JAnnotationType

See Also:

#getAnnotation(org.exolab.javasource.JAnnotationType) {@inheritDoc}

getAnnotations

public final JAnnotation[] getAnnotations()

Description copied from interface: JAnnotatedElement

Returns a list of JAnnotation's already set on this source element.

Specified by:

getAnnotations in interface JAnnotatedElement

Returns:

A list of all JAnnotations associated with this source element.

See Also:

{@inheritDoc}

isAnnotationPresent

public final boolean isAnnotationPresent(JAnnotationType annotationType)

Description copied from interface: JAnnotatedElement

Returns true if a JAnnotation exists for the given JAnnotationType.

Specified by:

isAnnotationPresent in interface JAnnotatedElement

Parameters:

annotationType - Annotation type to check for presence or absense

Returns:

True if a JAnnotation has been added for the given JAnnotationType.

See Also:

#isAnnotationPresent(org.exolab.javasource.JAnnotationType) {@inheritDoc}

removeAnnotation

public final JAnnotation removeAnnotation(JAnnotationType annotationType)

Description copied from interface: JAnnotatedElement

Removes the JAnnotation from this source element for the given JAnnotationType. An IllegalArgumentException is thrown if the provided JAnnotation isn't present.

Specified by:

removeAnnotation in interface JAnnotatedElement

Parameters:

annotationType - Annotation type to remove

Returns:

The JAnnotation that was associated with this source element

See Also:

#removeAnnotation(org.exolab.javasource.JAnnotationType) {@inheritDoc}

hasAnnotations

public final boolean hasAnnotations()

Description copied from interface: JAnnotatedElement

Returns true if this source element has any annotations.

Specified by:

hasAnnotations in interface JAnnotatedElement

Returns:

Returns true if this source element has any annotations.

See Also:

{@inheritDoc}

getInterfaceCount

protected final int getInterfaceCount()

Return the count of the number of Interfaces that have been added to this JStructure.

Returns:

the count of the number of Interfaces that have been added to this JStructure.

printlnWithPrefix

protected static void printlnWithPrefix(java.lang.String prefix,
                                        java.lang.String source,
                                        JSourceWriter jsw)

Prints the given source string to the JSourceWriter using the given prefix at the beginning of each new line.

Parameters:

prefix - the prefix for each new line.

source - the source code to print

jsw - the JSourceWriter to print to.

getPackageFromClassName

protected static java.lang.String getPackageFromClassName(java.lang.String className)

Returns the package name from the given class name.

Parameters:

className - an arbitrary class name, optionally including a package

Returns:

the package name from the given class name.