Class CustomCommentGenerator

  • All Implemented Interfaces:
    org.mybatis.generator.api.CommentGenerator

    public class CustomCommentGenerator
    extends Object
    implements org.mybatis.generator.api.CommentGenerator
    The custom comment generator.
    Version:
    1.0.0
    Author:
    Gang Cheng
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      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)  
      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)  
      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)  
      • Methods inherited from interface org.mybatis.generator.api.CommentGenerator

        addFileComment, addGeneralFunctionComment, addGeneralPropertyComment, addModelClassComment
    • Constructor Detail

      • CustomCommentGenerator

        public CustomCommentGenerator()
    • Method Detail

      • addConfigurationProperties

        public void addConfigurationProperties​(Properties properties)
        Specified by:
        addConfigurationProperties in interface 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)
        Specified by:
        addFieldComment in interface org.mybatis.generator.api.CommentGenerator
      • addFieldComment

        public void addFieldComment​(org.mybatis.generator.api.dom.java.Field field,
                                    org.mybatis.generator.api.IntrospectedTable introspectedTable)
        Specified by:
        addFieldComment in interface org.mybatis.generator.api.CommentGenerator
      • addModelClassComment

        public void addModelClassComment​(org.mybatis.generator.api.dom.java.TopLevelClass topLevelClass,
                                         org.mybatis.generator.api.IntrospectedTable introspectedTable)
        Specified by:
        addModelClassComment in interface org.mybatis.generator.api.CommentGenerator
      • addClassComment

        public void addClassComment​(org.mybatis.generator.api.dom.java.InnerClass innerClass,
                                    org.mybatis.generator.api.IntrospectedTable introspectedTable)
        Specified by:
        addClassComment in interface 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)
        Specified by:
        addClassComment in interface org.mybatis.generator.api.CommentGenerator
      • addEnumComment

        public void addEnumComment​(org.mybatis.generator.api.dom.java.InnerEnum innerEnum,
                                   org.mybatis.generator.api.IntrospectedTable introspectedTable)
        Specified by:
        addEnumComment in interface 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)
        Specified by:
        addGetterComment in interface 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)
        Specified by:
        addSetterComment in interface org.mybatis.generator.api.CommentGenerator
      • addGeneralMethodComment

        public void addGeneralMethodComment​(org.mybatis.generator.api.dom.java.Method method,
                                            org.mybatis.generator.api.IntrospectedTable introspectedTable)
        Specified by:
        addGeneralMethodComment in interface org.mybatis.generator.api.CommentGenerator
      • addJavaFileComment

        public void addJavaFileComment​(org.mybatis.generator.api.dom.java.CompilationUnit compilationUnit)
        Specified by:
        addJavaFileComment in interface org.mybatis.generator.api.CommentGenerator
      • addComment

        public void addComment​(org.mybatis.generator.api.dom.xml.XmlElement xmlElement)
        Specified by:
        addComment in interface org.mybatis.generator.api.CommentGenerator
      • addRootComment

        public void addRootComment​(org.mybatis.generator.api.dom.xml.XmlElement rootElement)
        Specified by:
        addRootComment in interface 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)
        Specified by:
        addGeneralMethodAnnotation in interface 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)
        Specified by:
        addGeneralMethodAnnotation in interface 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)
        Specified by:
        addFieldAnnotation in interface 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)
        Specified by:
        addFieldAnnotation in interface 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)
        Specified by:
        addClassAnnotation in interface org.mybatis.generator.api.CommentGenerator