Checkstyle Results

The following document contains the results of Checkstyle 9.3 with sun_checks.xml ruleset.

Summary

Files  Info  Warnings  Errors
34 0 0 176

Files

File  I  W  E
org/apache/rat/mp/AbstractRatMojo.java 0 0 46
org/apache/rat/mp/All.java 0 0 5
org/apache/rat/mp/Any.java 0 0 5
org/apache/rat/mp/Copyright.java 0 0 1
org/apache/rat/mp/EnclosingMatcher.java 0 0 8
org/apache/rat/mp/Family.java 0 0 2
org/apache/rat/mp/FilesReportable.java 0 0 5
org/apache/rat/mp/HeaderMatcherSpecification.java 0 0 8
org/apache/rat/mp/License.java 0 0 8
org/apache/rat/mp/Not.java 0 0 5
org/apache/rat/mp/RatCheckException.java 0 0 7
org/apache/rat/mp/RatCheckMojo.java 0 0 2
org/apache/rat/mp/RatReportMojo.java 0 0 30
org/apache/rat/mp/Regex.java 0 0 4
org/apache/rat/mp/Spdx.java 0 0 5
org/apache/rat/mp/Text.java 0 0 2
org/apache/rat/mp/util/ExclusionHelper.java 0 0 11
org/apache/rat/mp/util/ignore/GitIgnoreMatcher.java 0 0 4
org/apache/rat/mp/util/ignore/GlobIgnoreMatcher.java 0 0 6
org/apache/rat/mp/util/ignore/IgnoringDirectoryScanner.java 0 0 12

Rules

Category Rule Violations Severity
blocks LeftCurly 9  Error
coding EmptyStatement 1  Error
HiddenField 16  Error
MissingSwitchDefault 1  Error
design DesignForExtension 36  Error
HideUtilityClassConstructor 1  Error
VisibilityModifier 13  Error
imports UnusedImports
  • processJavadoc: "false"
 1  Error
misc FinalParameters 58  Error
regexp RegexpSingleline
  • format: "\s+$"
  • maximum: "0"
  • message: "Line has trailing spaces."
  • minimum: "0"
 15  Error
whitespace NoWhitespaceBefore 1  Error
ParenPad 9  Error
WhitespaceAfter 5  Error
WhitespaceAround 10  Error

Details

org/apache/rat/mp/AbstractRatMojo.java

Severity Category Rule Message Line
 Error imports UnusedImports Unused import - org.apache.rat.config.SourceCodeManagementSystems. 58
 Error regexp RegexpSingleline Line has trailing spaces. 113
 Error regexp RegexpSingleline Line has trailing spaces. 123
 Error regexp RegexpSingleline Line has trailing spaces. 130
 Error design VisibilityModifier Variable 'skip' must be private and have accessor methods. 244
 Error design VisibilityModifier Variable 'project' must be private and have accessor methods. 251
 Error design DesignForExtension Class 'AbstractRatMojo' looks like designed for extension (can be subclassed), but the method 'getDefaultsBuilder' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'AbstractRatMojo' final or making the method 'getDefaultsBuilder' static/final/abstract/empty, or adding allowed annotation for the method. 260
 Error regexp RegexpSingleline Line has trailing spaces. 273
 Error whitespace ParenPad '(' is followed by whitespace. 279
 Error blocks LeftCurly '{' at column 53 should have line break after. 279
 Error whitespace WhitespaceAround '{' is not followed by whitespace. 279
 Error whitespace WhitespaceAround 'return' is not preceded with whitespace. 279
 Error whitespace WhitespaceAfter ';' is not followed by whitespace. 279
 Error whitespace WhitespaceAround '}' is not preceded with whitespace. 279
 Error whitespace ParenPad '(' is followed by whitespace. 287
 Error blocks LeftCurly '{' at column 53 should have line break after. 287
 Error whitespace WhitespaceAround '{' is not followed by whitespace. 287
 Error whitespace WhitespaceAround 'return' is not preceded with whitespace. 287
 Error whitespace WhitespaceAfter ';' is not followed by whitespace. 287
 Error whitespace WhitespaceAround '}' is not preceded with whitespace. 287
 Error regexp RegexpSingleline Line has trailing spaces. 289
 Error blocks LeftCurly '{' at column 5 should be on the previous line. 292
 Error regexp RegexpSingleline Line has trailing spaces. 298
 Error misc FinalParameters Parameter config should be final. 300
 Error coding HiddenField 'families' hides a field. 301
 Error whitespace ParenPad '(' is followed by whitespace. 305
 Error regexp RegexpSingleline Line has trailing spaces. 315
 Error design VisibilityModifier Variable 'log' must be private and have accessor methods. 318
 Error misc FinalParameters Parameter level should be final. 320
 Error misc FinalParameters Parameter msg should be final. 320
 Error coding MissingSwitchDefault switch without "default" clause. 321
 Error blocks LeftCurly '{' at column 17 should be on the previous line. 322
 Error coding EmptyStatement Empty statement. 327
 Error whitespace WhitespaceAround '}' is not followed by whitespace. 338
 Error whitespace WhitespaceAround '}' is not preceded with whitespace. 338
 Error regexp RegexpSingleline Line has trailing spaces. 340
 Error design DesignForExtension Class 'AbstractRatMojo' looks like designed for extension (can be subclassed), but the method 'getConfiguration' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'AbstractRatMojo' final or making the method 'getConfiguration' static/final/abstract/empty, or adding allowed annotation for the method. 341
 Error regexp RegexpSingleline Line has trailing spaces. 388
 Error coding HiddenField 'families' hides a field. 407
 Error design DesignForExtension Class 'AbstractRatMojo' looks like designed for extension (can be subclassed), but the method 'logLicenses' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'AbstractRatMojo' final or making the method 'logLicenses' static/final/abstract/empty, or adding allowed annotation for the method. 417
 Error misc FinalParameters Parameter licenses should be final. 417
 Error coding HiddenField 'licenses' hides a field. 417
 Error misc FinalParameters Parameter ds should be final. 476
 Error misc FinalParameters Parameter pFile should be final. 496
 Error misc FinalParameters Parameter pCharset should be final. 496
 Error misc FinalParameters Parameter ds should be final. 575

org/apache/rat/mp/All.java

Severity Category Rule Message Line
 Error design VisibilityModifier Variable 'builder' must be private and have accessor methods. 27
 Error design DesignForExtension Class 'All' looks like designed for extension (can be subclassed), but the method 'setMatcher' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'All' final or making the method 'setMatcher' static/final/abstract/empty, or adding allowed annotation for the method. 32
 Error misc FinalParameters Parameter builder should be final. 33
 Error coding HiddenField 'builder' hides a field. 33
 Error design DesignForExtension Class 'All' looks like designed for extension (can be subclassed), but the method 'build' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'All' final or making the method 'build' static/final/abstract/empty, or adding allowed annotation for the method. 37

org/apache/rat/mp/Any.java

Severity Category Rule Message Line
 Error design VisibilityModifier Variable 'builder' must be private and have accessor methods. 27
 Error design DesignForExtension Class 'Any' looks like designed for extension (can be subclassed), but the method 'setMatcher' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'Any' final or making the method 'setMatcher' static/final/abstract/empty, or adding allowed annotation for the method. 32
 Error misc FinalParameters Parameter builder should be final. 33
 Error coding HiddenField 'builder' hides a field. 33
 Error design DesignForExtension Class 'Any' looks like designed for extension (can be subclassed), but the method 'build' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'Any' final or making the method 'build' static/final/abstract/empty, or adding allowed annotation for the method. 37

org/apache/rat/mp/Copyright.java

Severity Category Rule Message Line
 Error design DesignForExtension Class 'Copyright' looks like designed for extension (can be subclassed), but the method 'build' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'Copyright' final or making the method 'build' static/final/abstract/empty, or adding allowed annotation for the method. 39

org/apache/rat/mp/EnclosingMatcher.java

Severity Category Rule Message Line
 Error misc FinalParameters Parameter all should be final. 29
 Error misc FinalParameters Parameter any should be final. 34
 Error misc FinalParameters Parameter text should be final. 39
 Error misc FinalParameters Parameter copyright should be final. 44
 Error misc FinalParameters Parameter regex should be final. 49
 Error misc FinalParameters Parameter spdx should be final. 54
 Error regexp RegexpSingleline Line has trailing spaces. 57
 Error misc FinalParameters Parameter not should be final. 59

org/apache/rat/mp/Family.java

Severity Category Rule Message Line
 Error design DesignForExtension Class 'Family' looks like designed for extension (can be subclassed), but the method 'build' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'Family' final or making the method 'build' static/final/abstract/empty, or adding allowed annotation for the method. 37
 Error design DesignForExtension Class 'Family' looks like designed for extension (can be subclassed), but the method 'toString' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'Family' final or making the method 'toString' static/final/abstract/empty, or adding allowed annotation for the method. 41

org/apache/rat/mp/FilesReportable.java

Severity Category Rule Message Line
 Error misc FinalParameters Parameter basedir should be final. 37
 Error coding HiddenField 'basedir' hides a field. 37
 Error misc FinalParameters Parameter files should be final. 37
 Error coding HiddenField 'files' hides a field. 37
 Error misc FinalParameters Parameter report should be final. 49

org/apache/rat/mp/HeaderMatcherSpecification.java

Severity Category Rule Message Line
 Error blocks LeftCurly '{' at column 1 should be on the previous line. 27
 Error regexp RegexpSingleline Line has trailing spaces. 35
 Error blocks LeftCurly '{' at column 5 should be on the previous line. 39
 Error regexp RegexpSingleline Line has trailing spaces. 45
 Error whitespace ParenPad '(' is followed by whitespace. 49
 Error misc FinalParameters Parameter pClassName should be final. 49
 Error whitespace ParenPad ')' is preceded with whitespace. 49
 Error blocks LeftCurly '{' at column 5 should be on the previous line. 50

org/apache/rat/mp/License.java

Severity Category Rule Message Line
 Error regexp RegexpSingleline Line has trailing spaces. 37
 Error design DesignForExtension Class 'License' looks like designed for extension (can be subclassed), but the method 'setMatcher' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'License' final or making the method 'setMatcher' static/final/abstract/empty, or adding allowed annotation for the method. 47
 Error misc FinalParameters Parameter builder should be final. 48
 Error coding HiddenField 'builder' hides a field. 48
 Error design DesignForExtension Class 'License' looks like designed for extension (can be subclassed), but the method 'build' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'License' final or making the method 'build' static/final/abstract/empty, or adding allowed annotation for the method. 52
 Error misc FinalParameters Parameter context should be final. 52
 Error regexp RegexpSingleline Line has trailing spaces. 53
 Error design DesignForExtension Class 'License' looks like designed for extension (can be subclassed), but the method 'toString' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'License' final or making the method 'toString' static/final/abstract/empty, or adding allowed annotation for the method. 59

org/apache/rat/mp/Not.java

Severity Category Rule Message Line
 Error design VisibilityModifier Variable 'builder' must be private and have accessor methods. 27
 Error design DesignForExtension Class 'Not' looks like designed for extension (can be subclassed), but the method 'setMatcher' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'Not' final or making the method 'setMatcher' static/final/abstract/empty, or adding allowed annotation for the method. 32
 Error misc FinalParameters Parameter builder should be final. 33
 Error coding HiddenField 'builder' hides a field. 33
 Error design DesignForExtension Class 'Not' looks like designed for extension (can be subclassed), but the method 'build' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'Not' final or making the method 'build' static/final/abstract/empty, or adding allowed annotation for the method. 37

org/apache/rat/mp/RatCheckException.java

Severity Category Rule Message Line
 Error blocks LeftCurly '{' at column 1 should be on the previous line. 25
 Error whitespace ParenPad '(' is followed by whitespace. 28
 Error misc FinalParameters Parameter message should be final. 28
 Error whitespace ParenPad ')' is preceded with whitespace. 28
 Error blocks LeftCurly '{' at column 5 should be on the previous line. 29
 Error whitespace ParenPad '(' is followed by whitespace. 30
 Error whitespace ParenPad ')' is preceded with whitespace. 30

org/apache/rat/mp/RatCheckMojo.java

Severity Category Rule Message Line
 Error design DesignForExtension Class 'RatCheckMojo' looks like designed for extension (can be subclassed), but the method 'check' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'RatCheckMojo' final or making the method 'check' static/final/abstract/empty, or adding allowed annotation for the method. 135
 Error design DesignForExtension Class 'RatCheckMojo' looks like designed for extension (can be subclassed), but the method 'getConfiguration' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'RatCheckMojo' final or making the method 'getConfiguration' static/final/abstract/empty, or adding allowed annotation for the method. 170

org/apache/rat/mp/RatReportMojo.java

Severity Category Rule Message Line
 Error design VisibilityModifier Variable 'outputDirectory' must be private and have accessor methods. 75
 Error design VisibilityModifier Variable 'session' must be private and have accessor methods. 93
 Error design VisibilityModifier Variable 'remoteRepositories' must be private and have accessor methods. 99
 Error design VisibilityModifier Variable 'siteTool' must be private and have accessor methods. 105
 Error design VisibilityModifier Variable 'siteRenderer' must be private and have accessor methods. 111
 Error coding HiddenField 'outputDirectory' hides a field. 141
 Error coding HiddenField 'sink' hides a field. 156
 Error misc FinalParameters Parameter locale should be final. 179
 Error misc FinalParameters Parameter sink should be final. 224
 Error coding HiddenField 'sink' hides a field. 224
 Error misc FinalParameters Parameter locale should be final. 224
 Error misc FinalParameters Parameter sink should be final. 237
 Error coding HiddenField 'sink' hides a field. 237
 Error misc FinalParameters Parameter locale should be final. 237
 Error misc FinalParameters Parameter sink should be final. 251
 Error coding HiddenField 'sink' hides a field. 251
 Error misc FinalParameters Parameter sinkFactory should be final. 251
 Error coding HiddenField 'sinkFactory' hides a field. 251
 Error misc FinalParameters Parameter locale should be final. 251
 Error design DesignForExtension Class 'RatReportMojo' looks like designed for extension (can be subclassed), but the method 'getReportOutputDirectory' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'RatReportMojo' final or making the method 'getReportOutputDirectory' static/final/abstract/empty, or adding allowed annotation for the method. 275
 Error design DesignForExtension Class 'RatReportMojo' looks like designed for extension (can be subclassed), but the method 'setReportOutputDirectory' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'RatReportMojo' final or making the method 'setReportOutputDirectory' static/final/abstract/empty, or adding allowed annotation for the method. 284
 Error misc FinalParameters Parameter reportOutputDirectory should be final. 285
 Error coding HiddenField 'reportOutputDirectory' hides a field. 285
 Error design DesignForExtension Class 'RatReportMojo' looks like designed for extension (can be subclassed), but the method 'getOutputDirectory' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'RatReportMojo' final or making the method 'getOutputDirectory' static/final/abstract/empty, or adding allowed annotation for the method. 290
 Error design DesignForExtension Class 'RatReportMojo' looks like designed for extension (can be subclassed), but the method 'getSiteRenderer' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'RatReportMojo' final or making the method 'getSiteRenderer' static/final/abstract/empty, or adding allowed annotation for the method. 294
 Error design DesignForExtension Class 'RatReportMojo' looks like designed for extension (can be subclassed), but the method 'canGenerateReport' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'RatReportMojo' final or making the method 'canGenerateReport' static/final/abstract/empty, or adding allowed annotation for the method. 347
 Error misc FinalParameters Parameter locale should be final. 375
 Error misc FinalParameters Parameter locale should be final. 428
 Error misc FinalParameters Parameter locale should be final. 440
 Error misc FinalParameters Parameter locale should be final. 451

org/apache/rat/mp/Regex.java

Severity Category Rule Message Line
 Error design DesignForExtension Class 'Regex' looks like designed for extension (can be subclassed), but the method 'setExpr' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'Regex' final or making the method 'setExpr' static/final/abstract/empty, or adding allowed annotation for the method. 27
 Error misc FinalParameters Parameter exp should be final. 28
 Error design DesignForExtension Class 'Regex' looks like designed for extension (can be subclassed), but the method 'set' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'Regex' final or making the method 'set' static/final/abstract/empty, or adding allowed annotation for the method. 32
 Error misc FinalParameters Parameter exp should be final. 32

org/apache/rat/mp/Spdx.java

Severity Category Rule Message Line
 Error regexp RegexpSingleline Line has trailing spaces. 25
 Error design DesignForExtension Class 'Spdx' looks like designed for extension (can be subclassed), but the method 'set' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'Spdx' final or making the method 'set' static/final/abstract/empty, or adding allowed annotation for the method. 26
 Error whitespace WhitespaceAround '=' is not followed by whitespace. 26
 Error whitespace WhitespaceAround '=' is not preceded with whitespace. 26
 Error misc FinalParameters Parameter name should be final. 27

org/apache/rat/mp/Text.java

Severity Category Rule Message Line
 Error design DesignForExtension Class 'Text' looks like designed for extension (can be subclassed), but the method 'set' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'Text' final or making the method 'set' static/final/abstract/empty, or adding allowed annotation for the method. 24
 Error misc FinalParameters Parameter text should be final. 24

org/apache/rat/mp/util/ExclusionHelper.java

Severity Category Rule Message Line
 Error design HideUtilityClassConstructor Utility classes should not have a public or default constructor. 37
 Error whitespace WhitespaceAfter ',' is not followed by whitespace. 57
 Error whitespace WhitespaceAfter ',' is not followed by whitespace. 58
 Error whitespace WhitespaceAfter ',' is not followed by whitespace. 59
 Error misc FinalParameters Parameter log should be final. 73
 Error misc FinalParameters Parameter log should be final. 87
 Error misc FinalParameters Parameter useMavenDefaultExcludes should be final. 87
 Error misc FinalParameters Parameter log should be final. 99
 Error misc FinalParameters Parameter useEclipseDefaultExcludes should be final. 99
 Error misc FinalParameters Parameter log should be final. 113
 Error misc FinalParameters Parameter useIdeaDefaultExcludes should be final. 113

org/apache/rat/mp/util/ignore/GitIgnoreMatcher.java

Severity Category Rule Message Line
 Error design DesignForExtension Class 'GitIgnoreMatcher' looks like designed for extension (can be subclassed), but the method 'isEmpty' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'GitIgnoreMatcher' final or making the method 'isEmpty' static/final/abstract/empty, or adding allowed annotation for the method. 39
 Error design DesignForExtension Class 'GitIgnoreMatcher' looks like designed for extension (can be subclassed), but the method 'isIgnoredFile' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'GitIgnoreMatcher' final or making the method 'isIgnoredFile' static/final/abstract/empty, or adding allowed annotation for the method. 44
 Error misc FinalParameters Parameter filename should be final. 45
 Error design DesignForExtension Class 'GitIgnoreMatcher' looks like designed for extension (can be subclassed), but the method 'toString' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'GitIgnoreMatcher' final or making the method 'toString' static/final/abstract/empty, or adding allowed annotation for the method. 53

org/apache/rat/mp/util/ignore/GlobIgnoreMatcher.java

Severity Category Rule Message Line
 Error design VisibilityModifier Variable 'exclusionLines' must be private and have accessor methods. 37
 Error design DesignForExtension Class 'GlobIgnoreMatcher' looks like designed for extension (can be subclassed), but the method 'getExclusionLines' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'GlobIgnoreMatcher' final or making the method 'getExclusionLines' static/final/abstract/empty, or adding allowed annotation for the method. 118
 Error design DesignForExtension Class 'GlobIgnoreMatcher' looks like designed for extension (can be subclassed), but the method 'isEmpty' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'GlobIgnoreMatcher' final or making the method 'isEmpty' static/final/abstract/empty, or adding allowed annotation for the method. 122
 Error design DesignForExtension Class 'GlobIgnoreMatcher' looks like designed for extension (can be subclassed), but the method 'isIgnoredFile' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'GlobIgnoreMatcher' final or making the method 'isIgnoredFile' static/final/abstract/empty, or adding allowed annotation for the method. 127
 Error misc FinalParameters Parameter filename should be final. 128
 Error whitespace NoWhitespaceBefore ';' is preceded with whitespace. 131

org/apache/rat/mp/util/ignore/IgnoringDirectoryScanner.java

Severity Category Rule Message Line
 Error design VisibilityModifier Variable 'ignoreMatcherList' must be private and have accessor methods. 36
 Error design DesignForExtension Class 'IgnoringDirectoryScanner' looks like designed for extension (can be subclassed), but the method 'addIgnoreMatcher' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'IgnoringDirectoryScanner' final or making the method 'addIgnoreMatcher' static/final/abstract/empty, or adding allowed annotation for the method. 38
 Error misc FinalParameters Parameter ignoreMatcher should be final. 38
 Error misc FinalParameters Parameter name should be final. 42
 Error design DesignForExtension Class 'IgnoringDirectoryScanner' looks like designed for extension (can be subclassed), but the method 'isExcluded' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'IgnoringDirectoryScanner' final or making the method 'isExcluded' static/final/abstract/empty, or adding allowed annotation for the method. 51
 Error misc FinalParameters Parameter name should be final. 52
 Error design DesignForExtension Class 'IgnoringDirectoryScanner' looks like designed for extension (can be subclassed), but the method 'isExcluded' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'IgnoringDirectoryScanner' final or making the method 'isExcluded' static/final/abstract/empty, or adding allowed annotation for the method. 59
 Error misc FinalParameters Parameter name should be final. 60
 Error misc FinalParameters Parameter tokenizedName should be final. 60
 Error design DesignForExtension Class 'IgnoringDirectoryScanner' looks like designed for extension (can be subclassed), but the method 'isExcluded' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'IgnoringDirectoryScanner' final or making the method 'isExcluded' static/final/abstract/empty, or adding allowed annotation for the method. 67
 Error misc FinalParameters Parameter name should be final. 68
 Error misc FinalParameters Parameter tokenizedName should be final. 68