org.exolab.javasource

Class JStructure

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

Constructor Summary
protected JStructure(String name)
Creates a new JStructure with the given name.
Method Summary
voidaddAnnotation(JAnnotation annotation)
abstract voidaddField(JField jField)
Adds the given JField to this JStructure.
voidaddImport(String className)
Adds the given import to this JStructure.
protected voidaddImport(JAnnotation annotation)
Adds appropriate import for this JAnnotation.
protected voidaddImport(JAnnotation[] annotations)
Adds appropriate imports for each JAnnotation in the given Array.
voidaddInterface(String interfaceName)
Adds the given interface to the list of interfaces this JStructure inherits method declarations from, and either implements (JClass) or extends (JInterface).
voidaddInterface(JInterface jInterface)
Adds the given interface to the list of interfaces this JStructure inherits method declarations from, and either implements (JClass) or extends (JInterface).
abstract voidaddMember(JMember jMember)
Adds the given JMember to this JStructure.
protected JAnnotatedElementHelpergetAnnotatedElementHelper()
Returns the object managing the annotations for this JStructure.
JAnnotationgetAnnotation(JAnnotationType annotationType)
JAnnotation[]getAnnotations()
abstract JFieldgetField(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.
StringgetFilename(String destDir)
Returns the name of the file that this JStructure would be printed to, given a call to JStructure, or given a call to print if the parameter destDir is null.
JCommentgetHeader()
Returns the JComment header to display at the top of the source file for this JStructure, or null if no header was set.
EnumerationgetImports()
Returns an Enumeration of imported package and class names for this JStructure.
protected intgetInterfaceCount()
Return the count of the number of Interfaces that have been added to this JStructure.
EnumerationgetInterfaces()
Returns an Enumeration of interface names that this JStructure inherits from.
JDocCommentgetJDocComment()
Returns the JavaDoc comment for this JStructure.
JModifiersgetModifiers()
Returns the JModifiers, which allows the qualifiers to be changed.
StringgetName(boolean stripPackage)
Returns the name of the class represented by this JStructure.
protected static StringgetPackageFromClassName(String className)
Returns the package name from the given class name.
StringgetPackageName()
Returns the name of the package that this JStructure is a member of.
booleanhasAnnotations()
booleanhasImport(String classname)
Returns true if the given classname exists in the imports of this JStructure.
booleanisAnnotationPresent(JAnnotationType annotationType)
static booleanisValidClassName(String classname)
Test the provided name and return true if it is a valid class name.
voidprint()
Prints the source code for this JStructure in the current working directory.
voidprint(String destDir, String lineSeparator)
Prints the source code for this JStructure to the destination directory.
abstract voidprint(JSourceWriter jsw)
Prints the source code for this JStructure to the given JSourceWriter.
voidprintHeader(JSourceWriter jsw)
A utility method that prints the header to the given JSourceWriter.
voidprintImportDeclarations(JSourceWriter jsw)
A utility method that prints the imports to the given JSourceWriter.
protected static voidprintlnWithPrefix(String prefix, String source, JSourceWriter jsw)
Prints the given source string to the JSourceWriter using the given prefix at the beginning of each new line.
voidprintPackageDeclaration(JSourceWriter jsw)
A utility method that prints the packageDeclaration to the given JSourceWriter.
JAnnotationremoveAnnotation(JAnnotationType annotationType)
booleanremoveImport(String className)
Remove the import of the given class name from this JStucture, returning true if the import was found and removed.
voidsetHeader(JComment comment)
Sets the header comment for this JStructure.
voidsetPackageName(String packageName)
Allows changing the package name of this JStructure.

Constructor Detail

JStructure

protected JStructure(String name)
Creates a new JStructure with the given name.

Parameters: name the name of the JStructure.

Method Detail

addAnnotation

public final void addAnnotation(JAnnotation annotation)

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

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

addImport

public void addImport(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(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.

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.

getAnnotatedElementHelper

protected final JAnnotatedElementHelper getAnnotatedElementHelper()
Returns the object managing the annotations for this JStructure.

Returns: the object managing the annotations for this JStructure.

getAnnotation

public final JAnnotation getAnnotation(JAnnotationType annotationType)

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

getAnnotations

public final JAnnotation[] getAnnotations()

See Also: {@inheritDoc }

getField

public abstract JField getField(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 String getFilename(String destDir)
Returns the name of the file that this JStructure would be printed to, given a call to JStructure, 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 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.

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.

getInterfaces

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

getModifiers

public final JModifiers getModifiers()
Returns the JModifiers, which allows the qualifiers to be changed.

Returns: the JModifiers for this JStructure.

getName

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

getPackageFromClassName

protected static String getPackageFromClassName(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.

getPackageName

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

hasAnnotations

public final boolean hasAnnotations()

See Also: {@inheritDoc }

hasImport

public final boolean hasImport(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.

isAnnotationPresent

public final boolean isAnnotationPresent(JAnnotationType annotationType)

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

isValidClassName

public static boolean isValidClassName(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(String destDir, 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.

printlnWithPrefix

protected static void printlnWithPrefix(String prefix, 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.

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.

removeAnnotation

public final JAnnotation removeAnnotation(JAnnotationType annotationType)

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

removeImport

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

Parameters: className Name of the class to remove the import of

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

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(String packageName)
Allows changing the package name of this JStructure.

Parameters: packageName the package name to use

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