|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface CommentGenerator
Implementations of this interface are used to generate comments for the various artifacts generated by ibator.
Method Summary | |
---|---|
void |
addClassComment(InnerClass innerClass,
FullyQualifiedTable table)
|
void |
addComment(XmlElement xmlElement)
This method should add a suitable comment as a child element of the specified xmlElement to warn users that the element was generated and is subject to regeneration. |
void |
addConfigurationProperties(java.util.Properties properties)
Adds properties for this instance from any properties configured in the CommentGenerator configuration. |
void |
addEnumComment(InnerEnum innerEnum,
FullyQualifiedTable table)
|
void |
addFieldComment(Field field,
FullyQualifiedTable table)
|
void |
addFieldComment(Field field,
FullyQualifiedTable table,
java.lang.String columnName)
This method should add a Javadoc comment to the specified field. |
void |
addGeneralMethodComment(Method method,
FullyQualifiedTable table)
|
void |
addGetterComment(Method method,
FullyQualifiedTable table,
java.lang.String columnName)
|
void |
addJavaFileComment(CompilationUnit compilationUnit)
This method is called to add a file level comment to a generated java file. |
void |
addRootComment(XmlElement rootElement)
This method is called to add a comment as the first child of the root element. |
void |
addSetterComment(Method method,
FullyQualifiedTable table,
java.lang.String columnName)
|
Method Detail |
---|
void addConfigurationProperties(java.util.Properties properties)
properties
- All properties from the configurationvoid addFieldComment(Field field, FullyQualifiedTable table, java.lang.String columnName)
Important: This method should add a the nonstandard JavaDoc tag "@ibatorgenerated" to the comment. Without this tag, the Eclipse based Java merge feature will fail.
field
- table
- columnName
- void addFieldComment(Field field, FullyQualifiedTable table)
void addClassComment(InnerClass innerClass, FullyQualifiedTable table)
void addEnumComment(InnerEnum innerEnum, FullyQualifiedTable table)
void addGetterComment(Method method, FullyQualifiedTable table, java.lang.String columnName)
void addSetterComment(Method method, FullyQualifiedTable table, java.lang.String columnName)
void addGeneralMethodComment(Method method, FullyQualifiedTable table)
void addJavaFileComment(CompilationUnit compilationUnit)
The default implementation does nothing.
compilationUnit
- void addComment(XmlElement xmlElement)
void addRootComment(XmlElement rootElement)
The default implementation does nothing.
rootElement
-
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |