程序包 pro.leaco.mybatis.generator.plugins.comment

类 DefaultCommentGenerator

  • 所有已实现的接口:
    org.mybatis.generator.api.CommentGenerator
    直接已知子类:
    CommentGenerator
    public class DefaultCommentGenerator
extends Object
implements org.mybatis.generator.api.CommentGenerator
    作者:
    Jeff Butler

    • 方法概要

      所有方法 实例方法 具体方法 
      修饰符和类型 方法 说明
      void addClassAnnotation​(org.mybatis.generator.api.dom.java.InnerClass innerClass, org.mybatis.generator.api.IntrospectedTable introspectedTable, Set<org.mybatis.generator.api.dom.java.FullyQualifiedJavaType> imports)  
      void addClassComment​(org.mybatis.generator.api.dom.java.InnerClass innerClass, org.mybatis.generator.api.IntrospectedTable introspectedTable)  
      void addClassComment​(org.mybatis.generator.api.dom.java.InnerClass innerClass, org.mybatis.generator.api.IntrospectedTable introspectedTable, boolean markAsDoNotDelete)  
      void addComment​(org.mybatis.generator.api.dom.xml.XmlElement xmlElement)
      Adds a suitable comment to warn users that the element was generated, and when it was generated.
      void addConfigurationProperties​(Properties properties)  
      void addEnumComment​(org.mybatis.generator.api.dom.java.InnerEnum innerEnum, org.mybatis.generator.api.IntrospectedTable introspectedTable)  
      void addFieldAnnotation​(org.mybatis.generator.api.dom.java.Field field, org.mybatis.generator.api.IntrospectedTable introspectedTable, Set<org.mybatis.generator.api.dom.java.FullyQualifiedJavaType> imports)  
      void addFieldAnnotation​(org.mybatis.generator.api.dom.java.Field field, org.mybatis.generator.api.IntrospectedTable introspectedTable, org.mybatis.generator.api.IntrospectedColumn introspectedColumn, Set<org.mybatis.generator.api.dom.java.FullyQualifiedJavaType> imports)  
      void addFieldComment​(org.mybatis.generator.api.dom.java.Field field, org.mybatis.generator.api.IntrospectedTable introspectedTable)  
      void addFieldComment​(org.mybatis.generator.api.dom.java.Field field, org.mybatis.generator.api.IntrospectedTable introspectedTable, org.mybatis.generator.api.IntrospectedColumn introspectedColumn)  
      void addGeneralMethodAnnotation​(org.mybatis.generator.api.dom.java.Method method, org.mybatis.generator.api.IntrospectedTable introspectedTable, Set<org.mybatis.generator.api.dom.java.FullyQualifiedJavaType> imports)  
      void addGeneralMethodAnnotation​(org.mybatis.generator.api.dom.java.Method method, org.mybatis.generator.api.IntrospectedTable introspectedTable, org.mybatis.generator.api.IntrospectedColumn introspectedColumn, Set<org.mybatis.generator.api.dom.java.FullyQualifiedJavaType> imports)  
      void addGeneralMethodComment​(org.mybatis.generator.api.dom.java.Method method, org.mybatis.generator.api.IntrospectedTable introspectedTable)  
      void addGetterComment​(org.mybatis.generator.api.dom.java.Method method, org.mybatis.generator.api.IntrospectedTable introspectedTable, org.mybatis.generator.api.IntrospectedColumn introspectedColumn)  
      protected void addJavadocTag​(org.mybatis.generator.api.dom.java.JavaElement javaElement, boolean markAsDoNotDelete)
      This method adds the custom javadoc tag for.
      void addJavaFileComment​(org.mybatis.generator.api.dom.java.CompilationUnit compilationUnit)  
      void addModelClassComment​(org.mybatis.generator.api.dom.java.TopLevelClass topLevelClass, org.mybatis.generator.api.IntrospectedTable introspectedTable)  
      void addRootComment​(org.mybatis.generator.api.dom.xml.XmlElement rootElement)  
      void addSetterComment​(org.mybatis.generator.api.dom.java.Method method, org.mybatis.generator.api.IntrospectedTable introspectedTable, org.mybatis.generator.api.IntrospectedColumn introspectedColumn)  
      protected String getDateString()
      Returns a formated date string to include in the Javadoc tag and XML comments.

      • 从接口继承的方法 org.mybatis.generator.api.CommentGenerator

        addFileComment, addGeneralFunctionComment, addGeneralPropertyComment, addModelClassComment

    • 字段详细资料

      • suppressDate

        protected boolean suppressDate

      • suppressAllComments

        protected boolean suppressAllComments

      • addRemarkComments

        protected boolean addRemarkComments
        If suppressAllComments is true, this option is ignored.

    • 构造器详细资料

      • DefaultCommentGenerator

        public DefaultCommentGenerator()

    • 方法详细资料

      • addJavaFileComment

        public void addJavaFileComment​(org.mybatis.generator.api.dom.java.CompilationUnit compilationUnit)
        指定者:
        addJavaFileComment 在接口中 org.mybatis.generator.api.CommentGenerator

      • addComment

        public void addComment​(org.mybatis.generator.api.dom.xml.XmlElement xmlElement)
        Adds a suitable comment to warn users that the element was generated, and when it was generated.
        指定者:
        addComment 在接口中 org.mybatis.generator.api.CommentGenerator
        参数:
        xmlElement - the xml element

      • addRootComment

        public void addRootComment​(org.mybatis.generator.api.dom.xml.XmlElement rootElement)
        指定者:
        addRootComment 在接口中 org.mybatis.generator.api.CommentGenerator

      • addConfigurationProperties

        public void addConfigurationProperties​(Properties properties)
        指定者:
        addConfigurationProperties 在接口中 org.mybatis.generator.api.CommentGenerator

      • addJavadocTag

        protected void addJavadocTag​(org.mybatis.generator.api.dom.java.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
        markAsDoNotDelete - the mark as do not delete

      • getDateString

        protected String getDateString()
        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​(org.mybatis.generator.api.dom.java.InnerClass innerClass,
                            org.mybatis.generator.api.IntrospectedTable introspectedTable)
        指定者:
        addClassComment 在接口中 org.mybatis.generator.api.CommentGenerator

      • addClassComment

        public void addClassComment​(org.mybatis.generator.api.dom.java.InnerClass innerClass,
                            org.mybatis.generator.api.IntrospectedTable introspectedTable,
                            boolean markAsDoNotDelete)
        指定者:
        addClassComment 在接口中 org.mybatis.generator.api.CommentGenerator

      • addModelClassComment

        public void addModelClassComment​(org.mybatis.generator.api.dom.java.TopLevelClass topLevelClass,
                                 org.mybatis.generator.api.IntrospectedTable introspectedTable)
        指定者:
        addModelClassComment 在接口中 org.mybatis.generator.api.CommentGenerator

      • addEnumComment

        public void addEnumComment​(org.mybatis.generator.api.dom.java.InnerEnum innerEnum,
                           org.mybatis.generator.api.IntrospectedTable introspectedTable)
        指定者:
        addEnumComment 在接口中 org.mybatis.generator.api.CommentGenerator

      • addFieldComment

        public void addFieldComment​(org.mybatis.generator.api.dom.java.Field field,
                            org.mybatis.generator.api.IntrospectedTable introspectedTable,
                            org.mybatis.generator.api.IntrospectedColumn introspectedColumn)
        指定者:
        addFieldComment 在接口中 org.mybatis.generator.api.CommentGenerator

      • addFieldComment

        public void addFieldComment​(org.mybatis.generator.api.dom.java.Field field,
                            org.mybatis.generator.api.IntrospectedTable introspectedTable)
        指定者:
        addFieldComment 在接口中 org.mybatis.generator.api.CommentGenerator

      • addGeneralMethodComment

        public void addGeneralMethodComment​(org.mybatis.generator.api.dom.java.Method method,
                                    org.mybatis.generator.api.IntrospectedTable introspectedTable)
        指定者:
        addGeneralMethodComment 在接口中 org.mybatis.generator.api.CommentGenerator

      • addGetterComment

        public void addGetterComment​(org.mybatis.generator.api.dom.java.Method method,
                             org.mybatis.generator.api.IntrospectedTable introspectedTable,
                             org.mybatis.generator.api.IntrospectedColumn introspectedColumn)
        指定者:
        addGetterComment 在接口中 org.mybatis.generator.api.CommentGenerator

      • addSetterComment

        public void addSetterComment​(org.mybatis.generator.api.dom.java.Method method,
                             org.mybatis.generator.api.IntrospectedTable introspectedTable,
                             org.mybatis.generator.api.IntrospectedColumn introspectedColumn)
        指定者:
        addSetterComment 在接口中 org.mybatis.generator.api.CommentGenerator

      • addGeneralMethodAnnotation

        public void addGeneralMethodAnnotation​(org.mybatis.generator.api.dom.java.Method method,
                                       org.mybatis.generator.api.IntrospectedTable introspectedTable,
                                       Set<org.mybatis.generator.api.dom.java.FullyQualifiedJavaType> imports)
        指定者:
        addGeneralMethodAnnotation 在接口中 org.mybatis.generator.api.CommentGenerator

      • addGeneralMethodAnnotation

        public void addGeneralMethodAnnotation​(org.mybatis.generator.api.dom.java.Method method,
                                       org.mybatis.generator.api.IntrospectedTable introspectedTable,
                                       org.mybatis.generator.api.IntrospectedColumn introspectedColumn,
                                       Set<org.mybatis.generator.api.dom.java.FullyQualifiedJavaType> imports)
        指定者:
        addGeneralMethodAnnotation 在接口中 org.mybatis.generator.api.CommentGenerator

      • addFieldAnnotation

        public void addFieldAnnotation​(org.mybatis.generator.api.dom.java.Field field,
                               org.mybatis.generator.api.IntrospectedTable introspectedTable,
                               Set<org.mybatis.generator.api.dom.java.FullyQualifiedJavaType> imports)
        指定者:
        addFieldAnnotation 在接口中 org.mybatis.generator.api.CommentGenerator

      • addFieldAnnotation

        public void addFieldAnnotation​(org.mybatis.generator.api.dom.java.Field field,
                               org.mybatis.generator.api.IntrospectedTable introspectedTable,
                               org.mybatis.generator.api.IntrospectedColumn introspectedColumn,
                               Set<org.mybatis.generator.api.dom.java.FullyQualifiedJavaType> imports)
        指定者:
        addFieldAnnotation 在接口中 org.mybatis.generator.api.CommentGenerator

      • addClassAnnotation

        public void addClassAnnotation​(org.mybatis.generator.api.dom.java.InnerClass innerClass,
                               org.mybatis.generator.api.IntrospectedTable introspectedTable,
                               Set<org.mybatis.generator.api.dom.java.FullyQualifiedJavaType> imports)
        指定者:
        addClassAnnotation 在接口中 org.mybatis.generator.api.CommentGenerator