org.exolab.javasource

Class JStructure

Known Direct Subclasses:
JClass, JInterface

(package private) abstract class JStructure
extends JType

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: 1.1.1.1 $ $Date: 2003/03/03 07:09:57 $
Authors:
Martin Skopp
Keith Visco

Field Summary

(package private) static String
DEFAULT_HEADER
The Id for Source control systems I needed to separate this line to prevent CVS from expanding it here! ;-)
(package private) static String
version
The source control version for listed in the JavaDoc I needed to separate this line to prevent CVS from expanding it here! ;-)

Fields inherited from class org.exolab.javasource.JType

Boolean, Byte, Char, Double, Float, Int, Long, Short

Constructor Summary

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

Method Summary

abstract void
addField(JField jField)
Adds the given JField to this JStructure.
void
addImport(String className)
Adds the given import to this JStructure
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).
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).
abstract void
addMember(JMember jMember)
Adds the given JMember to this JStructure.
abstract JField
getField(String name)
Returns the field with the given name, or null if no field was found with the given name.
abstract JField[]
getFields()
Returns an array of all the JFields of this JStructure
String
getFilename(String destDir)
Returns the name of the file that this JStructure would be printed to, given a call to #print.
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.
Enumeration
getImports()
Returns an Enumeration of imported package and class names for this JStructure.
protected int
getInterfaceCount()
Enumeration
getInterfaces()
Returns an Enumeration of interface names that this JStructure inherits from.
JDocComment
getJDocComment()
Returns the Java Doc comment for this JStructure
JModifiers
getModifiers()
Returns the JModifiers which allows the qualifiers to be changed.
String
getName(boolean stripPackage)
Returns the name of the interface.
protected static String
getPackageFromClassName(String className)
Returns the package name from the given class name
String
getPackageName()
Returns the name of the package that this JStructure is a member of.
boolean
hasImport(String classname)
Returns true if the given classname exists in the imports of this JStructure
static boolean
isValidClassName(String name)
void
print()
Prints the source code for this JStructure in the current working directory.
void
print(String destDir, String lineSeparator)
Prints the source code for this JStructure to the destination directory.
abstract void
print(JSourceWriter jsw)
Prints the source code for this JStructure to the given JSourceWriter.
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
void
printPackageDeclaration(JSourceWriter jsw)
A utility method that prints the packageDeclaration to the given JSourceWriter
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.
boolean
removeImport(String className)
void
setHeader(JComment comment)
Sets the header comment for this JStructure
void
setPackageName(String packageName)
Allows changing the package name of this JStructure

Methods inherited from class org.exolab.javasource.JType

changePackage, createArray, getComponentType, getLocalName, getName, isArray, isPrimitive, toString

Field Details

DEFAULT_HEADER

(package private) static final String DEFAULT_HEADER
The Id for Source control systems I needed to separate this line to prevent CVS from expanding it here! ;-)

version

(package private) static final String version
The source control version for listed in the JavaDoc I needed to separate this line to prevent CVS from expanding it here! ;-)

Constructor Details

JStructure

protected JStructure(String name)
            throws IllegalArgumentException
Creates a new JStructure with the given name.
Parameters:
name - the name of the JStructure.

Method Details

addField

public abstract void addField(JField jField)
            throws IllegalArgumentException
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:

addImport

public void addImport(String className)
Adds the given import to this JStructure
Parameters:

addInterface

public 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 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)
            throws IllegalArgumentException
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.

getField

public abstract JField getField(String name)
Returns the field with the given name, or null if no field was found with the given 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 String getFilename(String destDir)
Returns the name of the file that this JStructure would be printed to, given a call to #print.
Parameters:
destDir - the destination directory. This may be null.
Returns:
the name of the file that this JInterface would be printed as, given a call to #print.

getHeader

public 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 Enumeration getImports()
Returns an Enumeration of imported package and class names for this JStructure.
Returns:
the Enumeration of imports. May be empty.

getInterfaceCount

protected int getInterfaceCount()

getInterfaces

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

getJDocComment

public JDocComment getJDocComment()
Returns the Java Doc comment for this JStructure
Returns:
the JDocComment for this JStructure

getModifiers

public JModifiers getModifiers()
Returns the JModifiers which allows the qualifiers to be changed.
Returns:
the JModifiers for this JStructure.

getName

public String getName(boolean stripPackage)
Returns the name of the interface.
Parameters:
stripPackage - a boolean that when true indicates that only the local name (no package) should be returned.
Returns:
the name of the class.

getPackageFromClassName

protected static String getPackageFromClassName(String className)
Returns the package name from the given class name

getPackageName

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

hasImport

public 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

isValidClassName

public static boolean isValidClassName(String name)

print

public 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 void print(String destDir,
                  String lineSeparator)
Prints the source code for this JStructure to the destination directory. Sub-directories will be created if necessary for the package.
Parameters:
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 void printHeader(JSourceWriter jsw)
A utility method that prints the header to the given JSourceWriter
Parameters:
jsw - the JSourceWriter to print to.

printImportDeclarations

public void printImportDeclarations(JSourceWriter jsw)
A utility method that prints the imports to the given JSourceWriter
Parameters:
jsw - the JSourceWriter to print to.

printPackageDeclaration

public void printPackageDeclaration(JSourceWriter jsw)
A utility method that prints the packageDeclaration 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.

removeImport

public boolean removeImport(String className)

setHeader

public 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-2003. All rights reserved http://www.intalio.com