Class ClassDefinition
- java.lang.Object
-
- org.eclipse.persistence.internal.codegen.CodeDefinition
-
- org.eclipse.persistence.internal.codegen.ClassDefinition
-
public class ClassDefinition extends CodeDefinition
INTERNAL:Purpose: Model a class for code generation purposes.
- Since:
- TopLink 3.0
- Author:
- James Sutherland
-
-
Field Summary
Fields Modifier and Type Field Description protected Vector
attributes
static int
CLASS_TYPE
protected Vector
imports
protected Vector
innerClasses
static int
INTERFACE_TYPE
protected Vector
interfaces
protected Vector
methods
protected String
packageName
protected String
superClass
protected int
type
-
Fields inherited from class org.eclipse.persistence.internal.codegen.CodeDefinition
accessLevel, comment, JAVA_LANG_PACKAGE_NAME, JAVA_UTIL_PACKAGE_NAME, name, TOPLINK_INDIRECTION_PACKAGE_NAME
-
-
Constructor Summary
Constructors Constructor Description ClassDefinition()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addAttribute(AttributeDefinition attribute)
void
addImport(String importStatement)
The importStatement should be of the form "{packageName}.{shortName or '*'}"void
addInnerClass(ClassDefinition classDefinition)
void
addInterface(String interfaceClassName)
void
addMethod(MethodDefinition method)
void
calculateImports()
Parses the class definition, pulls out fully qualified class names, adds imports for them, and un-fully qualifies the class names.boolean
containsMethod(MethodDefinition method)
protected Vector
getAttributes()
protected Vector
getImports()
protected Vector
getInnerClasses()
protected Vector
getInterfaces()
protected Vector
getMethods()
String
getPackageName()
String
getSuperClass()
int
getType()
boolean
isInterface()
protected void
replaceInterface(String oldInterfaceName, String newInterfaceName)
void
setPackageName(String packageName)
void
setSuperClass(String superClass)
If the class to be generated is an interface, do not use this method.void
setType(int type)
protected void
sortImports()
protected void
sortMethods()
void
write(CodeGenerator generator)
Write the code out to the generator's stream.void
writeBody(CodeGenerator generator)
Write the code out to the generator's stream.-
Methods inherited from class org.eclipse.persistence.internal.codegen.CodeDefinition
adjustTypeName, getAccessLevel, getComment, getName, parseForTypeNames, putTypeNameInMap, setAccessLevel, setComment, setName, toString
-
-
-
-
Field Detail
-
packageName
protected String packageName
-
imports
protected Vector imports
-
type
protected int type
-
CLASS_TYPE
public static final int CLASS_TYPE
- See Also:
- Constant Field Values
-
INTERFACE_TYPE
public static final int INTERFACE_TYPE
- See Also:
- Constant Field Values
-
superClass
protected String superClass
-
interfaces
protected Vector interfaces
-
attributes
protected Vector attributes
-
methods
protected Vector methods
-
innerClasses
protected Vector innerClasses
-
-
Method Detail
-
addAttribute
public void addAttribute(AttributeDefinition attribute)
-
addImport
public void addImport(String importStatement)
The importStatement should be of the form "{packageName}.{shortName or '*'}"
-
addInnerClass
public void addInnerClass(ClassDefinition classDefinition)
-
addInterface
public void addInterface(String interfaceClassName)
-
addMethod
public void addMethod(MethodDefinition method)
-
calculateImports
public void calculateImports()
Parses the class definition, pulls out fully qualified class names, adds imports for them, and un-fully qualifies the class names. - Assumes that no imports have been previously added. - Assumes that all types have been fully qualified to start. - Will not unqualify ambiguous classes (java.util.Date and java.sql.Date). - Will not add imports for java.lang.* - Will not add imports for classes in the same package. - Will not parse method bodies, but will unqualify types it finds. ?? - Should unqualification occur during writing? That way, reflective definitions could take advantage.
-
containsMethod
public boolean containsMethod(MethodDefinition method)
-
getAttributes
protected Vector getAttributes()
-
getImports
protected Vector getImports()
-
getInnerClasses
protected Vector getInnerClasses()
-
getInterfaces
protected Vector getInterfaces()
-
getMethods
protected Vector getMethods()
-
getPackageName
public String getPackageName()
-
getSuperClass
public String getSuperClass()
-
getType
public int getType()
-
isInterface
public boolean isInterface()
-
setPackageName
public void setPackageName(String packageName)
-
setSuperClass
public void setSuperClass(String superClass)
If the class to be generated is an interface, do not use this method. Instead, use addInterface(String) for each interface superclass.
-
setType
public void setType(int type)
-
sortImports
protected void sortImports()
-
sortMethods
protected void sortMethods()
-
write
public void write(CodeGenerator generator)
Write the code out to the generator's stream.- Overrides:
write
in classCodeDefinition
-
writeBody
public void writeBody(CodeGenerator generator)
Write the code out to the generator's stream.- Specified by:
writeBody
in classCodeDefinition
-
-