|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.ibatis.abator.internal.DefaultCommentGenerator
Constructor Summary | |
DefaultCommentGenerator()
|
Method Summary | |
protected void |
addAbatorJavadocTag(JavaElement javaElement)
This method adds the custom javadoc tag for Abator. |
void |
addClassComment(InnerClass innerClass,
FullyQualifiedTable table)
|
void |
addComment(XmlElement xmlElement)
Adds a suitable comment to warn users that the element was generated, and when it was generated. |
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)
|
protected java.lang.String |
getDateString()
This method returns a formated date string to include in the Javadoc tag and XML comments. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public DefaultCommentGenerator()
Method Detail |
public void addFieldComment(Field field, FullyQualifiedTable table, java.lang.String columnName)
CommentGenerator
Important: This method should add a the nonstandard JavaDoc tag "@abatorgenerated" to the comment. Without this tag, the Eclipse based Java merge feature will fail.
addFieldComment
in interface CommentGenerator
field
- table
- columnName
- public void addFieldComment(Field field, FullyQualifiedTable table)
addFieldComment
in interface CommentGenerator
public void addClassComment(InnerClass innerClass, FullyQualifiedTable table)
addClassComment
in interface CommentGenerator
public void addEnumComment(InnerEnum innerEnum, FullyQualifiedTable table)
addEnumComment
in interface CommentGenerator
public void addGetterComment(Method method, FullyQualifiedTable table, java.lang.String columnName)
addGetterComment
in interface CommentGenerator
public void addSetterComment(Method method, FullyQualifiedTable table, java.lang.String columnName)
addSetterComment
in interface CommentGenerator
public void addGeneralMethodComment(Method method, FullyQualifiedTable table)
addGeneralMethodComment
in interface CommentGenerator
public void addJavaFileComment(CompilationUnit compilationUnit)
CommentGenerator
The default implementation does nothing.
addJavaFileComment
in interface CommentGenerator
compilationUnit
- public void addComment(XmlElement xmlElement)
addComment
in interface CommentGenerator
public void addRootComment(XmlElement rootElement)
CommentGenerator
The default implementation does nothing.
addRootComment
in interface CommentGenerator
rootElement
- public void addConfigurationProperties(java.util.Properties properties)
CommentGenerator
addConfigurationProperties
in interface CommentGenerator
properties
- All properties from the configurationprotected void addAbatorJavadocTag(JavaElement javaElement)
javaElement
- protected java.lang.String getDateString()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |