Checkstyle Results

The following document contains the results of Checkstyle 10.4 with config/maven_checks.xml ruleset.

Summary

Files
 Info
 Warnings
 Errors
8 7 55 20

Files

File
 I
 W
 E
org/apache/maven/index/reader/ChunkReader.java 0 3 10
org/apache/maven/index/reader/ChunkWriter.java 0 5 10
org/apache/maven/index/reader/IndexReader.java 0 5 0
org/apache/maven/index/reader/IndexWriter.java 0 7 0
org/apache/maven/index/reader/Record.java 0 15 0
org/apache/maven/index/reader/ResourceHandler.java 0 2 0
org/apache/maven/index/reader/Utils.java 7 16 0
org/apache/maven/index/reader/WritableResourceHandler.java 0 2 0

Rules

Category Rule Violations Severity
coding HiddenField
  • ignoreConstructorParameter: "true"
  • ignoreSetter: "true"
1
 Warning
MagicNumber
  • ignoreNumbers: "-4, -3, -2, -1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 31, 32, 37, 64, 100, 128, 256, 512, 1000, 1024"
20
 Error
javadoc JavadocMethod
  • accessModifiers: "public, protected"
54
 Warning
JavadocVariable
  • scope: "protected"
7
 Info

Details

org/apache/maven/index/reader/ChunkReader.java

Severity Category Rule Message Line
 Error
coding MagicNumber '0xff' is a magic number. 60
 Warning
javadoc JavadocMethod @return tag should be present and have description. 67
 Warning
javadoc JavadocMethod @return tag should be present and have description. 75
 Warning
javadoc JavadocMethod @return tag should be present and have description. 83
 Error
coding MagicNumber '0xff' is a magic number. 227
 Error
coding MagicNumber '127' is a magic number. 228
 Error
coding MagicNumber '0xff' is a magic number. 238
 Error
coding MagicNumber '0xC0' is a magic number. 263
 Error
coding MagicNumber '0x3F' is a magic number. 267
 Error
coding MagicNumber '0xC0' is a magic number. 279
 Error
coding MagicNumber '0xC0' is a magic number. 279
 Error
coding MagicNumber '0x3F' is a magic number. 284
 Error
coding MagicNumber '0x3F' is a magic number. 284

org/apache/maven/index/reader/ChunkWriter.java

Severity Category Rule Message Line
 Warning
javadoc JavadocMethod @return tag should be present and have description. 74
 Warning
javadoc JavadocMethod @return tag should be present and have description. 82
 Warning
javadoc JavadocMethod @return tag should be present and have description. 90
 Warning
javadoc JavadocMethod @return tag should be present and have description. 98
 Warning
javadoc JavadocMethod Expected @param tag for 'iterator'. 98
 Error
coding MagicNumber '0x007F' is a magic number. 153
 Error
coding MagicNumber '0x07FF' is a magic number. 157
 Error
coding MagicNumber '0x007F' is a magic number. 173
 Error
coding MagicNumber '0x007F' is a magic number. 182
 Error
coding MagicNumber '0x07FF' is a magic number. 187
 Error
coding MagicNumber '0xE0' is a magic number. 189
 Error
coding MagicNumber '0x3F' is a magic number. 190
 Error
coding MagicNumber '0x3F' is a magic number. 191
 Error
coding MagicNumber '0xC0' is a magic number. 195
 Error
coding MagicNumber '0x3F' is a magic number. 196

org/apache/maven/index/reader/IndexReader.java

Severity Category Rule Message Line
 Warning
javadoc JavadocMethod @return tag should be present and have description. 131
 Warning
javadoc JavadocMethod @return tag should be present and have description. 139
 Warning
javadoc JavadocMethod @return tag should be present and have description. 148
 Warning
javadoc JavadocMethod @return tag should be present and have description. 158
 Warning
coding HiddenField 'chunkNames' hides a field. 220

org/apache/maven/index/reader/IndexWriter.java

Severity Category Rule Message Line
 Warning
javadoc JavadocMethod @return tag should be present and have description. 104
 Warning
javadoc JavadocMethod @return tag should be present and have description. 114
 Warning
javadoc JavadocMethod @return tag should be present and have description. 134
 Warning
javadoc JavadocMethod @return tag should be present and have description. 143
 Warning
javadoc JavadocMethod @return tag should be present and have description. 151
 Warning
javadoc JavadocMethod @return tag should be present and have description. 159
 Warning
javadoc JavadocMethod Expected @param tag for 'iterator'. 159

org/apache/maven/index/reader/Record.java

Severity Category Rule Message Line
 Warning
javadoc JavadocMethod @return tag should be present and have description. 382
 Warning
javadoc JavadocMethod @return tag should be present and have description. 390
 Warning
javadoc JavadocMethod @return tag should be present and have description. 406
 Warning
javadoc JavadocMethod Expected @param tag for 'entryKey'. 406
 Warning
javadoc JavadocMethod @return tag should be present and have description. 416
 Warning
javadoc JavadocMethod Expected @param tag for 'entryKey'. 416
 Warning
javadoc JavadocMethod @return tag should be present and have description. 431
 Warning
javadoc JavadocMethod Expected @param tag for 'entryKey'. 431
 Warning
javadoc JavadocMethod @return tag should be present and have description. 446
 Warning
javadoc JavadocMethod Expected @param tag for 'entryKey'. 446
 Warning
javadoc JavadocMethod @return tag should be present and have description. 461
 Warning
javadoc JavadocMethod Expected @param tag for 'entryKey'. 461
 Warning
javadoc JavadocMethod @return tag should be present and have description. 474
 Warning
javadoc JavadocMethod Expected @param tag for 'entryKey'. 474
 Warning
javadoc JavadocMethod Expected @param tag for 'value'. 474

org/apache/maven/index/reader/ResourceHandler.java

Severity Category Rule Message Line
 Warning
javadoc JavadocMethod @return tag should be present and have description. 46
 Warning
javadoc JavadocMethod @return tag should be present and have description. 64

org/apache/maven/index/reader/Utils.java

Severity Category Rule Message Line
 Info
javadoc JavadocVariable Missing a Javadoc comment. 50
 Info
javadoc JavadocVariable Missing a Javadoc comment. 52
 Info
javadoc JavadocVariable Missing a Javadoc comment. 60
 Info
javadoc JavadocVariable Missing a Javadoc comment. 62
 Info
javadoc JavadocVariable Missing a Javadoc comment. 64
 Info
javadoc JavadocVariable Missing a Javadoc comment. 66
 Info
javadoc JavadocVariable Missing a Javadoc comment. 68
 Warning
javadoc JavadocMethod @return tag should be present and have description. 74
 Warning
javadoc JavadocMethod Expected @param tag for 'resource'. 74
 Warning
javadoc JavadocMethod Expected @param tag for 'writableResource'. 92
 Warning
javadoc JavadocMethod Expected @param tag for 'properties'. 92
 Warning
javadoc JavadocMethod @return tag should be present and have description. 107
 Warning
javadoc JavadocMethod Expected @param tag for 'repoId'. 107
 Warning
javadoc JavadocMethod @return tag should be present and have description. 117
 Warning
javadoc JavadocMethod Expected @param tag for 'allGroups'. 117
 Warning
javadoc JavadocMethod @return tag should be present and have description. 127
 Warning
javadoc JavadocMethod Expected @param tag for 'rootGroups'. 127
 Warning
javadoc JavadocMethod @return tag should be present and have description. 137
 Warning
javadoc JavadocMethod Expected @param tag for 'v'. 137
 Warning
javadoc JavadocMethod @return tag should be present and have description. 145
 Warning
javadoc JavadocMethod Expected @param tag for 'v'. 145
 Warning
javadoc JavadocMethod @return tag should be present and have description. 153
 Warning
javadoc JavadocMethod Expected @param tag for 'groupId'. 153

org/apache/maven/index/reader/WritableResourceHandler.java

Severity Category Rule Message Line
 Warning
javadoc JavadocMethod @return tag should be present and have description. 50
 Warning
javadoc JavadocMethod @return tag should be present and have description. 59