public interface CommentGenerator
Modifier and Type | Method and Description |
---|---|
void |
addClassAnnotation(InnerClass innerClass,
IntrospectedTable introspectedTable,
Set<FullyQualifiedJavaType> imports)
Adds a @Generated annotation to a class.
|
void |
addClassComment(InnerClass innerClass,
IntrospectedTable introspectedTable)
Adds the inner class comment.
|
void |
addClassComment(InnerClass innerClass,
IntrospectedTable introspectedTable,
boolean markAsDoNotDelete)
Adds the inner class comment.
|
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)
Adds the enum comment.
|
void |
addFieldAnnotation(Field field,
IntrospectedTable introspectedTable,
IntrospectedColumn introspectedColumn,
Set<FullyQualifiedJavaType> imports)
Adds a @Generated annotation to a field.
|
void |
addFieldAnnotation(Field field,
IntrospectedTable introspectedTable,
Set<FullyQualifiedJavaType> imports)
Adds a @Generated annotation to a field.
|
void |
addFieldComment(Field field,
IntrospectedTable introspectedTable)
Adds the field comment.
|
void |
addFieldComment(Field field,
IntrospectedTable introspectedTable,
IntrospectedColumn introspectedColumn)
This method should add a Javadoc comment to the specified field.
|
void |
addGeneralMethodAnnotation(Method method,
IntrospectedTable introspectedTable,
IntrospectedColumn introspectedColumn,
Set<FullyQualifiedJavaType> imports)
Adds a @Generated annotation to a method.
|
void |
addGeneralMethodAnnotation(Method method,
IntrospectedTable introspectedTable,
Set<FullyQualifiedJavaType> imports)
Adds a @Generated annotation to a method.
|
void |
addGeneralMethodComment(Method method,
IntrospectedTable introspectedTable)
Adds the general method comment.
|
void |
addGetterComment(Method method,
IntrospectedTable introspectedTable,
IntrospectedColumn introspectedColumn)
Adds the getter comment.
|
void |
addJavaFileComment(CompilationUnit compilationUnit)
This method is called to add a file level comment to a generated java file.
|
void |
addModelClassComment(TopLevelClass topLevelClass,
IntrospectedTable introspectedTable)
Adds a comment for a model class.
|
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)
Adds the setter comment.
|
void addConfigurationProperties(Properties properties)
This method will be called before any of the other methods.
properties
- All properties from the configurationvoid addFieldComment(Field field, IntrospectedTable introspectedTable, IntrospectedColumn introspectedColumn)
Important: This method should add a the nonstandard JavaDoc tag "@mbg.generated" to the comment. Without this tag, the Eclipse based Java merge feature will fail.
field
- the fieldintrospectedTable
- the introspected tableintrospectedColumn
- the introspected columnvoid addFieldComment(Field field, IntrospectedTable introspectedTable)
field
- the fieldintrospectedTable
- the introspected tablevoid addModelClassComment(TopLevelClass topLevelClass, IntrospectedTable introspectedTable)
Because of difficulties with the Java file merger, the default implementation of this method should NOT add comments. Comments should only be added if specifically requested by the user (for example, by enabling table remark comments).
topLevelClass
- the top level classintrospectedTable
- the introspected tablevoid addClassComment(InnerClass innerClass, IntrospectedTable introspectedTable)
innerClass
- the inner classintrospectedTable
- the introspected tablevoid addClassComment(InnerClass innerClass, IntrospectedTable introspectedTable, boolean markAsDoNotDelete)
innerClass
- the inner classintrospectedTable
- the introspected tablemarkAsDoNotDelete
- the mark as do not deletevoid addEnumComment(InnerEnum innerEnum, IntrospectedTable introspectedTable)
innerEnum
- the inner enumintrospectedTable
- the introspected tablevoid addGetterComment(Method method, IntrospectedTable introspectedTable, IntrospectedColumn introspectedColumn)
method
- the methodintrospectedTable
- the introspected tableintrospectedColumn
- the introspected columnvoid addSetterComment(Method method, IntrospectedTable introspectedTable, IntrospectedColumn introspectedColumn)
method
- the methodintrospectedTable
- the introspected tableintrospectedColumn
- the introspected columnvoid addGeneralMethodComment(Method method, IntrospectedTable introspectedTable)
method
- the methodintrospectedTable
- the introspected tablevoid addJavaFileComment(CompilationUnit compilationUnit)
The default implementation does nothing.
compilationUnit
- the compilation unitvoid addComment(XmlElement xmlElement)
xmlElement
- the xml elementvoid addRootComment(XmlElement rootElement)
The default implementation does nothing.
rootElement
- the root elementvoid addGeneralMethodAnnotation(Method method, IntrospectedTable introspectedTable, Set<FullyQualifiedJavaType> imports)
method
- the methodintrospectedTable
- the introspected tableimports
- the comment generator may add a required imported type to this listvoid addGeneralMethodAnnotation(Method method, IntrospectedTable introspectedTable, IntrospectedColumn introspectedColumn, Set<FullyQualifiedJavaType> imports)
method
- the methodintrospectedTable
- the introspected tableintrospectedColumn
- thr introspected columnimports
- the comment generator may add a required imported type to this listvoid addFieldAnnotation(Field field, IntrospectedTable introspectedTable, Set<FullyQualifiedJavaType> imports)
field
- the fieldintrospectedTable
- the introspected tableimports
- the comment generator may add a required imported type to this listvoid addFieldAnnotation(Field field, IntrospectedTable introspectedTable, IntrospectedColumn introspectedColumn, Set<FullyQualifiedJavaType> imports)
field
- the fieldintrospectedTable
- the introspected tableintrospectedColumn
- the introspected columnimports
- the comment generator may add a required imported type to this listvoid addClassAnnotation(InnerClass innerClass, IntrospectedTable introspectedTable, Set<FullyQualifiedJavaType> imports)
innerClass
- the classintrospectedTable
- the introspected tableimports
- the comment generator may add a required imported type to this listCopyright © 2006–2018 MyBatis.org. All rights reserved.