public class DefaultCommentGenerator extends Object implements CommentGenerator
Constructor and Description |
---|
DefaultCommentGenerator() |
Modifier and Type | Method and Description |
---|---|
void |
addClassComment(InnerClass innerClass,
IntrospectedTable introspectedTable) |
void |
addClassComment(InnerClass innerClass,
IntrospectedTable introspectedTable,
boolean markAsDoNotDelete) |
void |
addComment(XmlElement xmlElement)
Adds a suitable comment to warn users that the element was generated, and
when it was generated.
|
void |
addConfigurationProperties(Properties properties)
Adds properties for this instance from any properties configured in the
CommentGenerator configuration.
|
void |
addEnumComment(InnerEnum innerEnum,
IntrospectedTable introspectedTable) |
void |
addFieldComment(Field field,
IntrospectedTable introspectedTable) |
void |
addFieldComment(Field field,
IntrospectedTable introspectedTable,
IntrospectedColumn introspectedColumn)
This method should add a Javadoc comment to the specified field.
|
void |
addGeneralMethodComment(Method method,
IntrospectedTable introspectedTable) |
void |
addGetterComment(Method method,
IntrospectedTable introspectedTable,
IntrospectedColumn introspectedColumn) |
protected void |
addJavadocTag(JavaElement javaElement,
boolean markAsDoNotDelete)
This method adds the custom javadoc tag for.
|
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,
IntrospectedTable introspectedTable,
IntrospectedColumn introspectedColumn) |
protected String |
getDateString()
This method returns a formated date string to include in the Javadoc tag
and XML comments.
|
public void addJavaFileComment(CompilationUnit compilationUnit)
CommentGenerator
The default implementation does nothing.
addJavaFileComment
in interface CommentGenerator
public void addComment(XmlElement xmlElement)
addComment
in interface CommentGenerator
public void addRootComment(XmlElement rootElement)
CommentGenerator
The default implementation does nothing.
addRootComment
in interface CommentGenerator
public void addConfigurationProperties(Properties properties)
CommentGenerator
addConfigurationProperties
in interface CommentGenerator
properties
- All properties from the configurationprotected void addJavadocTag(JavaElement javaElement, boolean markAsDoNotDelete)
javaElement
- the java elementprotected String getDateString()
public void addClassComment(InnerClass innerClass, IntrospectedTable introspectedTable)
addClassComment
in interface CommentGenerator
public void addEnumComment(InnerEnum innerEnum, IntrospectedTable introspectedTable)
addEnumComment
in interface CommentGenerator
public void addFieldComment(Field field, IntrospectedTable introspectedTable, IntrospectedColumn introspectedColumn)
CommentGenerator
Important: This method should add a the nonstandard JavaDoc tag "@mbggenerated" to the comment. Without this tag, the Eclipse based Java merge feature will fail.
addFieldComment
in interface CommentGenerator
public void addFieldComment(Field field, IntrospectedTable introspectedTable)
addFieldComment
in interface CommentGenerator
public void addGeneralMethodComment(Method method, IntrospectedTable introspectedTable)
addGeneralMethodComment
in interface CommentGenerator
public void addGetterComment(Method method, IntrospectedTable introspectedTable, IntrospectedColumn introspectedColumn)
addGetterComment
in interface CommentGenerator
public void addSetterComment(Method method, IntrospectedTable introspectedTable, IntrospectedColumn introspectedColumn)
addSetterComment
in interface CommentGenerator
public void addClassComment(InnerClass innerClass, IntrospectedTable introspectedTable, boolean markAsDoNotDelete)
addClassComment
in interface CommentGenerator
Copyright © 2010–2018 MyBatis.org. All rights reserved.