public interface CommentGenerator
Modifier and Type | Method and Description |
---|---|
void |
addClassComment(InnerClass innerClass,
IntrospectedTable introspectedTable) |
void |
addClassComment(InnerClass innerClass,
IntrospectedTable introspectedTable,
boolean markAsDoNotDelete) |
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(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) |
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) |
void addConfigurationProperties(Properties properties)
properties
- All properties from the configurationvoid addFieldComment(Field field, IntrospectedTable introspectedTable, IntrospectedColumn introspectedColumn)
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.
field
- introspectedTable
- introspectedColumn
- void addFieldComment(Field field, IntrospectedTable introspectedTable)
void addClassComment(InnerClass innerClass, IntrospectedTable introspectedTable)
void addClassComment(InnerClass innerClass, IntrospectedTable introspectedTable, boolean markAsDoNotDelete)
void addEnumComment(InnerEnum innerEnum, IntrospectedTable introspectedTable)
void addGetterComment(Method method, IntrospectedTable introspectedTable, IntrospectedColumn introspectedColumn)
void addSetterComment(Method method, IntrospectedTable introspectedTable, IntrospectedColumn introspectedColumn)
void addGeneralMethodComment(Method method, IntrospectedTable introspectedTable)
void addJavaFileComment(CompilationUnit compilationUnit)
The default implementation does nothing.
compilationUnit
- void addComment(XmlElement xmlElement)
xmlElement
- void addRootComment(XmlElement rootElement)
The default implementation does nothing.
rootElement
- Copyright © 2010–2018 MyBatis.org. All rights reserved.