| java.lang.Object
 org.exolab.javasource.JCompUnit
| JCompUnit | | final public class JCompUnit (Code) | | A representation of the Java Source code for a Java compilation unit. This is
a useful utility when creating in memory source code. This package was
modelled after the Java Reflection API as much as possible to reduce the
learning curve.
author:
Gary Shea
version:
$Revision: 6669 $ $Date: 2005-03-05 06:42:06 -0700 (Sat, 05 Mar 2005) $ |
| Constructor Summary | |
| public | JCompUnit(String packageName, String fileName)
Creates a new JCompUnit.
Parameters:
packageName - The name of the package for this JCompUnit. | | public | JCompUnit(JClass jClass)
Creates a new JCompUnit with the given JClass (which must have been
created with either a full class name or package/local name) as the
public class. | | public | JCompUnit(JInterface jInterface)
Creates a new JCompUnit with the given JInterface as public interface. |
| Method Summary | |
| public void | addClass(JClass jClass)
Adds a JClass to be printed in this file. | | public void | addInterface(JInterface jInterface)
Adds a JInterface to be printed in this file. | | public void | addStructure(JStructure jStructure)
Adds the given JStructure (either a JInterface or a JClass) to this
JCompUnit. | | public String | getFilename(String destDir)
Returns the name of the file that this JCompUnit would be printed to,
given a call to
JCompUnit.print(String,String) , or if destDir is null, a
call to
JCompUnit.print() .
Parameters:
destDir - The destination directory. | | public SortedSet | getImports()
Returns a array of String containing all imported classes/packages, also
imports within the same package of this object. | | public String | getPackageName()
Returns the name of the package that this JCompUnit is a member of. | | public void | print()
Prints the source code for this JClass in the current directory with the
default line seperator of the the runtime platform. | | public void | print(String destDir)
Prints the source code for this JClass with the default line seperator of
the the runtime platform. | | public void | print(String destDir, String lineSeparator)
Prints the source code for this JCompUnit using the provided root
directory and line separator.
Parameters:
destDir - The destination directory to use as the root directory forsource generation.
Parameters:
lineSeparator - The line separator to use at the end of each line. | | public void | print(JSourceWriter jsw)
Prints the source code for this JClass to the provided JSourceWriter. | | public void | printStructures(JSourceWriter jsw, boolean printPublic)
Print the source code for the contained JClass objects. | | public void | setHeader(JComment comment)
Sets the header comment for this JCompUnit. |
| JCompUnit | | public JCompUnit(String packageName, String fileName)(Code) | | Creates a new JCompUnit.
Parameters:
packageName - The name of the package for this JCompUnit. If packageName isnull or empty, no 'package' line will be generated.
Parameters:
fileName - The name of the file to which this JCompUnit will be written. |
| JCompUnit | | public JCompUnit(JClass jClass)(Code) | | Creates a new JCompUnit with the given JClass (which must have been
created with either a full class name or package/local name) as the
public class. Package and file name are taken from jClass.
Parameters:
jClass - The public class for this JCompUnit. |
| JCompUnit | | public JCompUnit(JInterface jInterface)(Code) | | Creates a new JCompUnit with the given JInterface as public interface.
Package and file name are taken from jInterface.
Parameters:
jInterface - The public interface for this JCompUnit. |
| addClass | | public void addClass(JClass jClass)(Code) | | Adds a JClass to be printed in this file.
Parameters:
jClass - The JClass to be printed in this file. |
| addInterface | | public void addInterface(JInterface jInterface)(Code) | | Adds a JInterface to be printed in this file.
Parameters:
jInterface - The JInterface to be printed in this file. |
| addStructure | | public void addStructure(JStructure jStructure)(Code) | | Adds the given JStructure (either a JInterface or a JClass) to this
JCompUnit.
Parameters:
jStructure - The JStructure to add. |
| getFilename | | public String getFilename(String destDir)(Code) | | Returns the name of the file that this JCompUnit would be printed to,
given a call to
JCompUnit.print(String,String) , or if destDir is null, a
call to
JCompUnit.print() .
Parameters:
destDir - The destination directory. This may be null. The name of the file that this JCompUnit would be printed to. |
| getImports | | public SortedSet getImports()(Code) | | Returns a array of String containing all imported classes/packages, also
imports within the same package of this object.
A array of String containing all import classes/packages, alsoimports within the same package of this object. |
| getPackageName | | public String getPackageName()(Code) | | Returns the name of the package that this JCompUnit is a member of.
The name of the package that this JCompUnit is a member of, ornull if there is no current package name defined. |
| print | | public void print()(Code) | | Prints the source code for this JClass in the current directory with the
default line seperator of the the runtime platform.
See Also: JCompUnit.print(String,String) |
| print | | public void print(String destDir)(Code) | | Prints the source code for this JClass with the default line seperator of
the the runtime platform.
Parameters:
destDir - The destination directory to use as the root directory forsource generation.
See Also: JCompUnit.print(String,String) |
| print | | public void print(String destDir, String lineSeparator)(Code) | | Prints the source code for this JCompUnit using the provided root
directory and line separator.
Parameters:
destDir - The destination directory to use as the root directory forsource generation.
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 void print(JSourceWriter jsw)(Code) | | Prints the source code for this JClass to the provided JSourceWriter.
Parameters:
jsw - The JSourceWriter to print to. |
| printStructures | | public void printStructures(JSourceWriter jsw, boolean printPublic)(Code) | | Print the source code for the contained JClass objects.
Parameters:
jsw - The JSourceWriter to print to.
Parameters:
printPublic - If true, print only public classes; if false, print onlynon-public classes. |
| setHeader | | public void setHeader(JComment comment)(Code) | | Sets the header comment for this JCompUnit.
Parameters:
comment - The comment to display at the top of the source file when printed. |
|
|