Checkstyle Results

The following document contains the results of Checkstyle 10.17.0 with checkstyle.xml ruleset.

Summary

Files  Info  Warnings  Errors
27 0 41 0

Files

File  I  W  E
org/mybatis/scripting/velocity/Driver.java 0 1 0
org/mybatis/scripting/velocity/FastLinkedList.java 0 3 0
org/mybatis/scripting/velocity/InDirective.java 0 2 0
org/mybatis/scripting/velocity/ParameterMappingCollector.java 0 5 0
org/mybatis/scripting/velocity/ParameterMappingSourceParser.java 0 4 0
org/mybatis/scripting/velocity/RepeatDirective.java 0 4 0
org/mybatis/scripting/velocity/SQLScriptSource.java 0 4 0
org/mybatis/scripting/velocity/SetDirective.java 0 2 0
org/mybatis/scripting/velocity/TrimDirective.java 0 6 0
org/mybatis/scripting/velocity/VelocityFacade.java 0 4 0
org/mybatis/scripting/velocity/VelocityLanguageDriverConfig.java 0 4 0
org/mybatis/scripting/velocity/WhereDirective.java 0 2 0

Rules

Category Rule Violations Severity
imports CustomImportOrder
  • separateLineBetweenGroups: "true"
  • sortImportsInGroupAlphabetically: "true"
  • customImportOrderRules: "STATIC###THIRD_PARTY_PACKAGE"
  • tokens: "IMPORT, STATIC_IMPORT, PACKAGE_DEF"
10  Warning
javadoc MissingJavadocMethod
  • scope: "public"
  • tokens: "METHOD_DEF, CTOR_DEF, ANNOTATION_FIELD_DEF, COMPACT_CTOR_DEF"
  • minLineCount: "2"
  • allowedAnnotations: "Override, Test"
8  Warning
MissingJavadocType
  • scope: "protected"
  • excludeScope: "nothing"
  • tokens: "CLASS_DEF, INTERFACE_DEF, ENUM_DEF, RECORD_DEF, ANNOTATION_DEF"
11  Warning
SummaryJavadoc
  • forbiddenSummaryFragments: "^@return the *|^This method returns |^A [{]@code [a-zA-Z0-9]+[}]( is a )"
4  Warning
naming AbbreviationAsWordInName
  • tokens: "CLASS_DEF, INTERFACE_DEF, ENUM_DEF, ANNOTATION_DEF, ANNOTATION_FIELD_DEF, PARAMETER_DEF, VARIABLE_DEF, METHOD_DEF, PATTERN_VARIABLE_DEF, RECORD_DEF, RECORD_COMPONENT_DEF"
  • ignoreFinal: "false"
  • allowedAbbreviations: "XML,URL"
  • allowedAbbreviationLength: "0"
3  Warning
MethodName
  • format: "^[a-z][a-z0-9]\w*$"
1  Warning
sizes LineLength
  • fileExtensions: "java"
  • max: "120"
  • ignorePattern: "^package.*|^import.*|a href|href|http://|https://|ftp://"
2  Error
whitespace EmptyLineSeparator
  • allowNoEmptyLineBetweenFields: "true"
  • tokens: "IMPORT, STATIC_IMPORT, CLASS_DEF, INTERFACE_DEF, ENUM_DEF, STATIC_INIT, INSTANCE_INIT, METHOD_DEF, CTOR_DEF, VARIABLE_DEF, RECORD_DEF, COMPACT_CTOR_DEF"
2  Warning

Details

org/mybatis/scripting/velocity/Driver.java

Severity Category Rule Message Line
 Warning javadoc SummaryJavadoc Summary javadoc is missing. 18

org/mybatis/scripting/velocity/FastLinkedList.java

Severity Category Rule Message Line
 Warning javadoc SummaryJavadoc First sentence of Javadoc is missing an ending period. 20
 Warning javadoc MissingJavadocMethod Missing a Javadoc comment. 43
 Warning javadoc MissingJavadocType Missing a Javadoc comment. 54

org/mybatis/scripting/velocity/InDirective.java

Severity Category Rule Message Line
 Warning imports CustomImportOrder Extra separation in import group before 'org.apache.velocity.context.InternalContextAdapter' 23
 Warning javadoc SummaryJavadoc First sentence of Javadoc is missing an ending period. 39

org/mybatis/scripting/velocity/ParameterMappingCollector.java

Severity Category Rule Message Line
 Warning imports CustomImportOrder Extra separation in import group before 'org.apache.ibatis.mapping.ParameterMapping' 22
 Warning javadoc MissingJavadocType Missing a Javadoc comment. 25
 Warning javadoc MissingJavadocMethod Missing a Javadoc comment. 35
 Warning javadoc MissingJavadocMethod Missing a Javadoc comment. 50
 Warning naming MethodName Method name 'g' must match pattern '^[a-z][a-z0-9]\w*$'. 50

org/mybatis/scripting/velocity/ParameterMappingSourceParser.java

Severity Category Rule Message Line
 Warning imports CustomImportOrder Extra separation in import group before 'org.apache.ibatis.builder.BaseBuilder' 22
 Warning javadoc MissingJavadocType Missing a Javadoc comment. 34
 Warning sizes LineLength Line is longer than 120 characters (found 122). 36
 Warning javadoc MissingJavadocMethod Missing a Javadoc comment. 42

org/mybatis/scripting/velocity/RepeatDirective.java

Severity Category Rule Message Line
 Warning imports CustomImportOrder Extra separation in import group before 'org.apache.velocity.context.ChainedInternalContextAdapter' 23
 Warning javadoc SummaryJavadoc First sentence of Javadoc is missing an ending period. 44
 Warning javadoc MissingJavadocType Missing a Javadoc comment. 193
 Warning javadoc MissingJavadocType Missing a Javadoc comment. 242

org/mybatis/scripting/velocity/SQLScriptSource.java

Severity Category Rule Message Line
 Warning imports CustomImportOrder Extra separation in import group before 'org.apache.ibatis.mapping.BoundSql' 21
 Warning javadoc MissingJavadocType Missing a Javadoc comment. 26
 Warning naming AbbreviationAsWordInName Abbreviation in name 'SQLScriptSource' must contain no more than '1' consecutive capital letters. 26
 Warning javadoc MissingJavadocMethod Missing a Javadoc comment. 39

org/mybatis/scripting/velocity/SetDirective.java

Severity Category Rule Message Line
 Warning imports CustomImportOrder Extra separation in import group before 'org.apache.velocity.context.InternalContextAdapter' 21
 Warning javadoc MissingJavadocType Missing a Javadoc comment. 25

org/mybatis/scripting/velocity/TrimDirective.java

Severity Category Rule Message Line
 Warning imports CustomImportOrder Extra separation in import group before 'org.apache.velocity.context.InternalContextAdapter' 23
 Warning javadoc MissingJavadocType Missing a Javadoc comment. 28
 Warning javadoc MissingJavadocMethod Missing a Javadoc comment. 49
 Warning naming AbbreviationAsWordInName Abbreviation in name 'LEFT' must contain no more than '1' consecutive capital letters. 56
 Warning naming AbbreviationAsWordInName Abbreviation in name 'RIGHT' must contain no more than '1' consecutive capital letters. 69
 Warning javadoc MissingJavadocType Missing a Javadoc comment. 92

org/mybatis/scripting/velocity/VelocityFacade.java

Severity Category Rule Message Line
 Warning imports CustomImportOrder Extra separation in import group before 'org.apache.ibatis.builder.BuilderException' 25
 Warning javadoc MissingJavadocType Missing a Javadoc comment. 34
 Warning javadoc MissingJavadocMethod Missing a Javadoc comment. 76
 Warning javadoc MissingJavadocMethod Missing a Javadoc comment. 91

org/mybatis/scripting/velocity/VelocityLanguageDriverConfig.java

Severity Category Rule Message Line
 Warning imports CustomImportOrder Extra separation in import group before 'org.apache.commons.text.WordUtils' 37
 Warning whitespace EmptyLineSeparator 'STATIC_INIT' should be separated from previous line. 68
 Warning whitespace EmptyLineSeparator 'INSTANCE_INIT' should be separated from previous line. 83
 Warning sizes LineLength Line is longer than 120 characters (found 157). 134

org/mybatis/scripting/velocity/WhereDirective.java

Severity Category Rule Message Line
 Warning imports CustomImportOrder Extra separation in import group before 'org.apache.velocity.context.InternalContextAdapter' 21
 Warning javadoc MissingJavadocType Missing a Javadoc comment. 25