MyCommentGenerator (mybatis-generator-csz-ddd 1.0.0 API)

java.lang.Object
- test.MyCommentGenerator

所有已实现的接口:: CommentGenerator

public class MyCommentGenerator
extends java.lang.Object
implements CommentGenerator

Created by csz on 16/1/18.

构造器概要

构造器
构造器和说明

MyCommentGenerator()

构造器
构造器和说明
`MyCommentGenerator()`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`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(java.util.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.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - MyCommentGenerator
```
public MyCommentGenerator()
```
- 方法详细资料
  - addConfigurationProperties
```
public void addConfigurationProperties(java.util.Properties properties)
```
    从接口复制的说明: CommentGenerator
    
    Adds properties for this instance from any properties configured in the CommentGenerator configuration. This method will be called before any of the other methods.
    
    指定者:
    
    addConfigurationProperties 在接口中 CommentGenerator
    
    参数:
    
    properties - All properties from the configuration
  - addFieldComment
```
public void addFieldComment(Field field,
                            IntrospectedTable introspectedTable,
                            IntrospectedColumn introspectedColumn)
```
    从接口复制的说明: CommentGenerator
    
    This method should add a Javadoc comment to the specified field. The field is related to the specified table and is used to hold the value of the specified column.
    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.
    
    指定者:
    
    addFieldComment 在接口中 CommentGenerator
    
    参数:
    
    field - the field
    
    introspectedTable - the introspected table
    
    introspectedColumn - the introspected column
  - addFieldComment
```
public void addFieldComment(Field field,
                            IntrospectedTable introspectedTable)
```
    从接口复制的说明: CommentGenerator
    
    Adds the field comment.
    
    指定者:
    
    addFieldComment 在接口中 CommentGenerator
    
    参数:
    
    field - the field
    
    introspectedTable - the introspected table
  - addModelClassComment
```
public void addModelClassComment(TopLevelClass topLevelClass,
                                 IntrospectedTable introspectedTable)
```
    从接口复制的说明: CommentGenerator
    
    Adds a comment for a model class. The Java code merger should be notified not to delete the entire class in case any manual changes have been made. So this method will always use the "do not delete" annotation. 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).
    
    指定者:
    
    addModelClassComment 在接口中 CommentGenerator
    
    参数:
    
    topLevelClass - the top level class
    
    introspectedTable - the introspected table
  - addClassComment
```
public void addClassComment(InnerClass innerClass,
                            IntrospectedTable introspectedTable)
```
    从接口复制的说明: CommentGenerator
    
    Adds the inner class comment.
    
    指定者:
    
    addClassComment 在接口中 CommentGenerator
    
    参数:
    
    innerClass - the inner class
    
    introspectedTable - the introspected table
  - addClassComment
```
public void addClassComment(InnerClass innerClass,
                            IntrospectedTable introspectedTable,
                            boolean markAsDoNotDelete)
```
    从接口复制的说明: CommentGenerator
    
    Adds the inner class comment.
    
    指定者:
    
    addClassComment 在接口中 CommentGenerator
    
    参数:
    
    innerClass - the inner class
    
    introspectedTable - the introspected table
    
    markAsDoNotDelete - the mark as do not delete
  - addEnumComment
```
public void addEnumComment(InnerEnum innerEnum,
                           IntrospectedTable introspectedTable)
```
    从接口复制的说明: CommentGenerator
    
    Adds the enum comment.
    
    指定者:
    
    addEnumComment 在接口中 CommentGenerator
    
    参数:
    
    innerEnum - the inner enum
    
    introspectedTable - the introspected table
  - addGetterComment
```
public void addGetterComment(Method method,
                             IntrospectedTable introspectedTable,
                             IntrospectedColumn introspectedColumn)
```
    从接口复制的说明: CommentGenerator
    
    Adds the getter comment.
    
    指定者:
    
    addGetterComment 在接口中 CommentGenerator
    
    参数:
    
    method - the method
    
    introspectedTable - the introspected table
    
    introspectedColumn - the introspected column
  - addSetterComment
```
public void addSetterComment(Method method,
                             IntrospectedTable introspectedTable,
                             IntrospectedColumn introspectedColumn)
```
    从接口复制的说明: CommentGenerator
    
    Adds the setter comment.
    
    指定者:
    
    addSetterComment 在接口中 CommentGenerator
    
    参数:
    
    method - the method
    
    introspectedTable - the introspected table
    
    introspectedColumn - the introspected column
  - addGeneralMethodComment
```
public void addGeneralMethodComment(Method method,
                                    IntrospectedTable introspectedTable)
```
    从接口复制的说明: CommentGenerator
    
    Adds the general method comment.
    
    指定者:
    
    addGeneralMethodComment 在接口中 CommentGenerator
    
    参数:
    
    method - the method
    
    introspectedTable - the introspected table
  - addJavaFileComment
```
public void addJavaFileComment(CompilationUnit compilationUnit)
```
    从接口复制的说明: CommentGenerator
    
    This method is called to add a file level comment to a generated java file. This method could be used to add a general file comment (such as a copyright notice). However, note that the Java file merge function in Eclipse does not deal with this comment. If you run the generator repeatedly, you will only retain the comment from the initial run.
    The default implementation does nothing.
    
    指定者:
    
    addJavaFileComment 在接口中 CommentGenerator
    
    参数:
    
    compilationUnit - the compilation unit
  - addComment
```
public void addComment(XmlElement xmlElement)
```
    从接口复制的说明: CommentGenerator
    
    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.
    
    指定者:
    
    addComment 在接口中 CommentGenerator
    
    参数:
    
    xmlElement - the xml element
  - addRootComment
```
public void addRootComment(XmlElement rootElement)
```
    从接口复制的说明: CommentGenerator
    
    This method is called to add a comment as the first child of the root element. This method could be used to add a general file comment (such as a copyright notice). However, note that the XML file merge function does not deal with this comment. If you run the generator repeatedly, you will only retain the comment from the initial run.
    The default implementation does nothing.
    
    指定者:
    
    addRootComment 在接口中 CommentGenerator
    
    参数:
    
    rootElement - the root element

类 MyCommentGenerator

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

MyCommentGenerator

方法详细资料

addConfigurationProperties

addFieldComment

addFieldComment

addModelClassComment

addClassComment

addClassComment

addEnumComment

addGetterComment

addSetterComment

addGeneralMethodComment

addJavaFileComment

addComment

addRootComment