Class JStructure
java.lang.Object
org.codehaus.modello.plugin.java.javasource.JType
org.codehaus.modello.plugin.java.javasource.JStructure
- Direct Known Subclasses:
JClass
,JInterface
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$ $Date$
- Author:
- Martin Skopp, Keith Visco
-
Field Summary
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
JStructure
(String name) Creates a new JStructure with the given name. -
Method Summary
Modifier and TypeMethodDescriptionabstract void
Adds the given JField to this JStructure.void
Adds the given import to this JStructurevoid
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
(org.codehaus.modello.plugin.java.javasource.JMember jMember) Adds the given JMember to this JStructure.void
appendAnnotation
(String annotation) abstract JField
Returns the field with the given name, or null if no field was found with the given name.abstract JField[]
Returns an array of all the JFields of this JStructuregetFilename
(String destDir) Returns the name of the file that this JStructure would be printed to, given a call to #print.Returns the JComment header to display at the top of the source file for this JStructure, or null if no header was set.Returns an Enumeration of imported package and class names for this JStructure.protected int
Returns an Enumeration of interface names that this JStructure inherits from.Returns the Java Doc comment for this JStructureReturns the JModifiers which allows the qualifiers to be changed.getName
(boolean stripPackage) Returns the name of the interface.protected static String
getPackageFromClassName
(String className) Returns the package name from the given class nameReturns the name of the package that this JStructure is a member of.boolean
Returns true if the given classname exists in the imports of this JStructureboolean
static boolean
isValidClassName
(String name) void
print()
Prints the source code for this JStructure in the current working directory.void
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 JSourceWritervoid
A utility method that prints the imports to the given JSourceWriterprotected 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.void
A utility method that prints the packageDeclaration to the given JSourceWriterboolean
removeImport
(String className) void
setAnnotations
(JAnnotations annotations) void
Sets the header comment for this JStructureMethods inherited from class org.codehaus.modello.plugin.java.javasource.JType
changePackage, createArray, getComponentType, getLocalName, getName, isArray, isPrimitive, toString
-
Constructor Details
-
JStructure
Creates a new JStructure with the given name.- Parameters:
name
- the name of the JStructure.- Throws:
IllegalArgumentException
- when the given name is not a valid Class name.
-
-
Method Details
-
addField
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- Throws:
IllegalArgumentException
- when the given JField has a name of an existing JField
-
addMember
public abstract void addMember(org.codehaus.modello.plugin.java.javasource.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.- Throws:
IllegalArgumentException
- when the given JMember has the same name of an existing JField or JMethod respectively.
-
addImport
Adds the given import to this JStructure- Parameters:
className
- the className of the class to import.
-
addInterface
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
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
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
Returns an array of all the JFields of this JStructure- Returns:
- an array of all the JFields of this JStructure
-
getFilename
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
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
Returns an Enumeration of imported package and class names for this JStructure.- Returns:
- the Enumeration of imports. May be empty.
-
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
Returns the Java Doc comment for this JStructure- Returns:
- the JDocComment for this JStructure
-
getModifiers
Returns the JModifiers which allows the qualifiers to be changed.- Returns:
- the JModifiers for this JStructure.
-
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
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.
-
hasImport
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
-
isAbstract
public boolean isAbstract() -
isValidClassName
-
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
Prints the source code for this JStructure to the destination directory. Sub-directories will be created if necessary for the package.- Parameters:
destDir
- the destination directorylineSeparator
- 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
Prints the source code for this JStructure to the given JSourceWriter.- Parameters:
jsw
- the JSourceWriter to print to.
-
printHeader
A utility method that prints the header to the given JSourceWriter- Parameters:
jsw
- the JSourceWriter to print to.
-
printImportDeclarations
A utility method that prints the imports to the given JSourceWriter- Parameters:
jsw
- the JSourceWriter to print to.
-
printPackageDeclaration
A utility method that prints the packageDeclaration to the given JSourceWriter- Parameters:
jsw
- the JSourceWriter to print to.
-
setHeader
Sets the header comment for this JStructure- Parameters:
comment
- the comment to display at the top of the source file when printed
-
getInterfaceCount
protected int getInterfaceCount() -
printlnWithPrefix
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 printjsw
- the JSourceWriter to print to.
-
getPackageFromClassName
Returns the package name from the given class name- Parameters:
className
- the className- Returns:
- the package of the class, otherwise
null
-
getAnnotations
- Returns:
- the annotations
-
appendAnnotation
- Parameters:
annotation
- the annotation to append
-
setAnnotations
- Parameters:
annotations
- the annotations to set
-