public interface CommentGenerator
| 限定符和类型 | 方法和说明 |
|---|---|
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 |
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 |
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)
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 - the fieldintrospectedTable - the introspected tableintrospectedColumn - the introspected columnvoid addFieldComment(Field field, IntrospectedTable introspectedTable)
field - the fieldintrospectedTable - the introspected tablevoid addModelClassComment(TopLevelClass topLevelClass, IntrospectedTable introspectedTable)
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 elementCopyright © 2006–2016 MyBatis.org. All rights reserved.