类 MapperCommentGenerator

  • 所有已实现的接口:
    org.mybatis.generator.api.CommentGenerator

    public class MapperCommentGenerator
    extends Object
    implements org.mybatis.generator.api.CommentGenerator
    • 方法概要

      所有方法 实例方法 具体方法 
      修饰符和类型 方法 说明
      void addClassAnnotation​(org.mybatis.generator.api.dom.java.InnerClass innerClass, org.mybatis.generator.api.IntrospectedTable introspectedTable, Set<org.mybatis.generator.api.dom.java.FullyQualifiedJavaType> set)  
      void addClassComment​(org.mybatis.generator.api.dom.java.InnerClass innerClass, org.mybatis.generator.api.IntrospectedTable introspectedTable)
      Example使用
      void addClassComment​(org.mybatis.generator.api.dom.java.InnerClass innerClass, org.mybatis.generator.api.IntrospectedTable introspectedTable, boolean markAsDoNotDelete)
      Example使用
      void addComment​(org.mybatis.generator.api.dom.xml.XmlElement xmlElement)
      xml中的注释
      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> set)  
      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> set)  
      void addFieldComment​(org.mybatis.generator.api.dom.java.Field field, org.mybatis.generator.api.IntrospectedTable introspectedTable)
      Example使用
      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> set)  
      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> set)  
      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)
      getter方法注释
      protected void addJavadocTag​(org.mybatis.generator.api.dom.java.JavaElement javaElement, boolean markAsDoNotDelete)
      删除标记
      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)
      setter方法注释
      String getDelimiterName​(String name)  
    • 构造器详细资料

      • MapperCommentGenerator

        public MapperCommentGenerator()
    • 方法详细资料

      • 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)
        xml中的注释
        指定者:
        addComment 在接口中 org.mybatis.generator.api.CommentGenerator
        参数:
        xmlElement -
      • 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
      • getDelimiterName

        public String getDelimiterName​(String name)
      • addJavadocTag

        protected void addJavadocTag​(org.mybatis.generator.api.dom.java.JavaElement javaElement,
                                     boolean markAsDoNotDelete)
        删除标记
        参数:
        javaElement -
        markAsDoNotDelete -
      • addClassComment

        public void addClassComment​(org.mybatis.generator.api.dom.java.InnerClass innerClass,
                                    org.mybatis.generator.api.IntrospectedTable introspectedTable)
        Example使用
        指定者:
        addClassComment 在接口中 org.mybatis.generator.api.CommentGenerator
        参数:
        innerClass -
        introspectedTable -
      • 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
        参数:
        field -
        introspectedTable -
        introspectedColumn -
      • addFieldComment

        public void addFieldComment​(org.mybatis.generator.api.dom.java.Field field,
                                    org.mybatis.generator.api.IntrospectedTable introspectedTable)
        Example使用
        指定者:
        addFieldComment 在接口中 org.mybatis.generator.api.CommentGenerator
        参数:
        field -
        introspectedTable -
      • addModelClassComment

        public void addModelClassComment​(org.mybatis.generator.api.dom.java.TopLevelClass topLevelClass,
                                         org.mybatis.generator.api.IntrospectedTable introspectedTable)
        指定者:
        addModelClassComment 在接口中 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
        参数:
        method -
        introspectedTable -
      • addGetterComment

        public void addGetterComment​(org.mybatis.generator.api.dom.java.Method method,
                                     org.mybatis.generator.api.IntrospectedTable introspectedTable,
                                     org.mybatis.generator.api.IntrospectedColumn introspectedColumn)
        getter方法注释
        指定者:
        addGetterComment 在接口中 org.mybatis.generator.api.CommentGenerator
        参数:
        method -
        introspectedTable -
        introspectedColumn -
      • addSetterComment

        public void addSetterComment​(org.mybatis.generator.api.dom.java.Method method,
                                     org.mybatis.generator.api.IntrospectedTable introspectedTable,
                                     org.mybatis.generator.api.IntrospectedColumn introspectedColumn)
        setter方法注释
        指定者:
        addSetterComment 在接口中 org.mybatis.generator.api.CommentGenerator
        参数:
        method -
        introspectedTable -
        introspectedColumn -
      • addClassComment

        public void addClassComment​(org.mybatis.generator.api.dom.java.InnerClass innerClass,
                                    org.mybatis.generator.api.IntrospectedTable introspectedTable,
                                    boolean markAsDoNotDelete)
        Example使用
        指定者:
        addClassComment 在接口中 org.mybatis.generator.api.CommentGenerator
        参数:
        innerClass -
        introspectedTable -
        markAsDoNotDelete -
      • 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> set)
        指定者:
        addGeneralMethodAnnotation 在接口中 org.mybatis.generator.api.CommentGenerator
        从以下版本开始:
        mbg 1.3.6
      • 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> set)
        指定者:
        addGeneralMethodAnnotation 在接口中 org.mybatis.generator.api.CommentGenerator
        从以下版本开始:
        mbg 1.3.6
      • 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> set)
        指定者:
        addFieldAnnotation 在接口中 org.mybatis.generator.api.CommentGenerator
        从以下版本开始:
        mbg 1.3.6
      • 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> set)
        指定者:
        addFieldAnnotation 在接口中 org.mybatis.generator.api.CommentGenerator
        从以下版本开始:
        mbg 1.3.6
      • 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> set)
        指定者:
        addClassAnnotation 在接口中 org.mybatis.generator.api.CommentGenerator
        从以下版本开始:
        mbg 1.3.6