Built by Maven

Checkstyle Results

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

Summary

Files  Info  Warnings  Errors
16 0 26 0

Files

File  I  W  E
org/mybatis/caches/redis/DummyReadWriteLock.java 0 1 0
org/mybatis/caches/redis/JDKSerializer.java 0 3 0
org/mybatis/caches/redis/KryoSerializer.java 0 7 0
org/mybatis/caches/redis/RedisCache.java 0 3 0
org/mybatis/caches/redis/RedisCallback.java 0 1 0
org/mybatis/caches/redis/RedisConfig.java 0 5 0
org/mybatis/caches/redis/RedisConfigurationBuilder.java 0 1 0
org/mybatis/caches/redis/Serializer.java 0 5 0

Rules

Category Rule Violations Severity
imports CustomImportOrder
  • separateLineBetweenGroups: "true"
  • sortImportsInGroupAlphabetically: "true"
  • customImportOrderRules: "STATIC###THIRD_PARTY_PACKAGE"
  • tokens: "IMPORT, STATIC_IMPORT, PACKAGE_DEF"
 6  Warning
javadoc InvalidJavadocPosition 2  Warning
MissingJavadocMethod
  • scope: "public"
  • tokens: "METHOD_DEF, CTOR_DEF, ANNOTATION_FIELD_DEF, COMPACT_CTOR_DEF"
  • minLineCount: "2"
  • allowedAnnotations: "Override, Test"
 4  Warning
MissingJavadocType
  • scope: "protected"
  • excludeScope: "nothing"
  • tokens: "CLASS_DEF, INTERFACE_DEF, ENUM_DEF, RECORD_DEF, ANNOTATION_DEF"
 4  Warning
NonEmptyAtclauseDescription 2  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"
 1  Warning
whitespace WhitespaceAfter
  • tokens: "COMMA, SEMI, TYPECAST, LITERAL_IF, LITERAL_ELSE, LITERAL_RETURN, LITERAL_WHILE, LITERAL_DO, LITERAL_FOR, LITERAL_FINALLY, DO_WHILE, ELLIPSIS, LITERAL_SWITCH, LITERAL_SYNCHRONIZED, LITERAL_TRY, LITERAL_CATCH, LAMBDA, LITERAL_YIELD, LITERAL_CASE"
 3  Warning

Details

org/mybatis/caches/redis/DummyReadWriteLock.java

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

org/mybatis/caches/redis/JDKSerializer.java

Severity Category Rule Message Line
 Warning imports CustomImportOrder Extra separation in import group before 'org.apache.ibatis.cache.CacheException' 23
 Warning javadoc MissingJavadocType Missing a Javadoc comment. 25
 Warning naming AbbreviationAsWordInName Abbreviation in name 'JDKSerializer' must contain no more than '1' consecutive capital letters. 25

org/mybatis/caches/redis/KryoSerializer.java

Severity Category Rule Message Line
 Warning imports CustomImportOrder Extra separation in import group before 'java.util.Arrays' 22
 Warning javadoc SummaryJavadoc First sentence of Javadoc is missing an ending period. 47
 Warning whitespace WhitespaceAfter ';' is not followed by whitespace. 57
 Warning javadoc InvalidJavadocPosition Javadoc comment is placed in the wrong location. 67
 Warning whitespace WhitespaceAfter ';' is not followed by whitespace. 77
 Warning javadoc InvalidJavadocPosition Javadoc comment is placed in the wrong location. 92
 Warning whitespace WhitespaceAfter ';' is not followed by whitespace. 102

org/mybatis/caches/redis/RedisCache.java

Severity Category Rule Message Line
 Warning imports CustomImportOrder Extra separation in import group before 'org.apache.ibatis.cache.Cache' 21
 Warning imports CustomImportOrder Extra separation in import group before 'redis.clients.jedis.Jedis' 23
 Warning javadoc MissingJavadocMethod Missing a Javadoc comment. 43

org/mybatis/caches/redis/RedisCallback.java

Severity Category Rule Message Line
 Warning javadoc MissingJavadocType Missing a Javadoc comment. 20

org/mybatis/caches/redis/RedisConfig.java

Severity Category Rule Message Line
 Warning imports CustomImportOrder Extra separation in import group before 'redis.clients.jedis.JedisPoolConfig' 22
 Warning javadoc MissingJavadocType Missing a Javadoc comment. 25
 Warning javadoc MissingJavadocMethod Missing a Javadoc comment. 76
 Warning javadoc MissingJavadocMethod Missing a Javadoc comment. 95
 Warning javadoc MissingJavadocMethod Missing a Javadoc comment. 114

org/mybatis/caches/redis/RedisConfigurationBuilder.java

Severity Category Rule Message Line
 Warning imports CustomImportOrder Extra separation in import group before 'org.apache.ibatis.cache.CacheException' 24

org/mybatis/caches/redis/Serializer.java

Severity Category Rule Message Line
 Warning javadoc MissingJavadocType Missing a Javadoc comment. 18
 Warning javadoc SummaryJavadoc First sentence of Javadoc is missing an ending period. 20
 Warning javadoc NonEmptyAtclauseDescription At-clause should have a non-empty description. 23
 Warning javadoc SummaryJavadoc First sentence of Javadoc is missing an ending period. 29
 Warning javadoc NonEmptyAtclauseDescription At-clause should have a non-empty description. 32