DefaultCommentGenerator (ibator 1.3.2 API)

java.lang.Object
- org.mybatis.generator.internal.DefaultCommentGenerator

所有已实现的接口:: CommentGenerator

public class DefaultCommentGenerator
extends Object
implements CommentGenerator

作者:: Jeff Butler

构造器概要

构造器
构造器和说明

DefaultCommentGenerator()

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

方法概要

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

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

- 构造器详细资料
  - DefaultCommentGenerator
```
public DefaultCommentGenerator()
```
- 方法详细资料
  - 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 - compilationUnit
  - addComment
```
public void addComment(XmlElement xmlElement)
```
    Adds a suitable comment to warn users that the element was generated, and when it was generated.
    
    指定者:
    
    addComment 在接口中 CommentGenerator
    
    参数:
    
    xmlElement - xmlElement
  - 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 - rootElement
  - addConfigurationProperties
```
public void addConfigurationProperties(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
  - addJavadocTag
```
protected void addJavadocTag(JavaElement javaElement,
                             boolean markAsDoNotDelete)
```
    This method adds the custom javadoc tag for. You may do nothing if you do not wish to include the Javadoc tag - however, if you do not include the Javadoc tag then the Java merge capability of the eclipse plugin will break.
    
    参数:
    
    javaElement - the java element
  - getDateString
```
protected String getDateString()
```
    This method returns a formated date string to include in the Javadoc tag and XML comments. You may return null if you do not want the date in these documentation elements.
    
    返回:
    
    a string representing the current timestamp, or null
  - addClassComment
```
public void addClassComment(InnerClass innerClass,
                            IntrospectedTable introspectedTable)
```
    指定者:
    
    addClassComment 在接口中 CommentGenerator
  - addClassComment
```
public void addClassComment(InnerClass innerClass,
                            IntrospectedTable introspectedTable,
                            boolean markAsDoNotDelete)
```
    指定者:
    
    addClassComment 在接口中 CommentGenerator
  - addEnumComment
```
public void addEnumComment(InnerEnum innerEnum,
                           IntrospectedTable introspectedTable)
```
    指定者:
    
    addEnumComment 在接口中 CommentGenerator
  - 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 "@mbggenerated" to the comment. Without this tag, the Eclipse based Java merge feature will fail.
    
    指定者:
    
    addFieldComment 在接口中 CommentGenerator
    
    参数:
    
    field - field
    
    introspectedTable - introspectedTable
    
    introspectedColumn - introspectedColumn
  - addFieldComment
```
public void addFieldComment(Field field,
                            IntrospectedTable introspectedTable)
```
    指定者:
    
    addFieldComment 在接口中 CommentGenerator
  - addGeneralMethodComment
```
public void addGeneralMethodComment(Method method,
                                    IntrospectedTable introspectedTable)
```
    指定者:
    
    addGeneralMethodComment 在接口中 CommentGenerator
  - addGetterComment
```
public void addGetterComment(Method method,
                             IntrospectedTable introspectedTable,
                             IntrospectedColumn introspectedColumn)
```
    指定者:
    
    addGetterComment 在接口中 CommentGenerator
  - addSetterComment
```
public void addSetterComment(Method method,
                             IntrospectedTable introspectedTable,
                             IntrospectedColumn introspectedColumn)
```
    指定者:
    
    addSetterComment 在接口中 CommentGenerator

类 DefaultCommentGenerator

构造器概要

方法概要

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

构造器详细资料

DefaultCommentGenerator

方法详细资料

addJavaFileComment

addComment

addRootComment

addConfigurationProperties

addJavadocTag

getDateString

addClassComment

addClassComment

addEnumComment

addFieldComment

addFieldComment

addGeneralMethodComment

addGetterComment

addSetterComment