Checkstyle Results

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

Summary

Files  Info  Warnings  Errors
22 0 0 129

Files

File  I  W  E
org/apache/rat/anttasks/All.java 0 0 5
org/apache/rat/anttasks/Any.java 0 0 5
org/apache/rat/anttasks/Copyright.java 0 0 9
org/apache/rat/anttasks/Family.java 0 0 5
org/apache/rat/anttasks/License.java 0 0 22
org/apache/rat/anttasks/Not.java 0 0 5
org/apache/rat/anttasks/Regex.java 0 0 5
org/apache/rat/anttasks/Report.java 0 0 51
org/apache/rat/anttasks/ResourceCollectionContainer.java 0 0 8
org/apache/rat/anttasks/Spdx.java 0 0 7
org/apache/rat/anttasks/Text.java 0 0 7

Rules

Category Rule Violations Severity
blocks LeftCurly 1  Error
coding HiddenField 6  Error
design DesignForExtension 49  Error
FinalClass 1  Error
imports AvoidStarImport 1  Error
misc FinalParameters 51  Error
regexp RegexpSingleline
  • format: "\s+$"
  • maximum: "0"
  • message: "Line has trailing spaces."
  • minimum: "0"
18  Error
whitespace NoWhitespaceAfter 1  Error
OperatorWrap 1  Error

Details

org/apache/rat/anttasks/All.java

Severity Category Rule Message Line
 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. 29
 Error regexp RegexpSingleline Line has trailing spaces. 33
 Error design DesignForExtension Class 'All' looks like designed for extension (can be subclassed), but the method 'add' 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 'add' static/final/abstract/empty, or adding allowed annotation for the method. 34
 Error misc FinalParameters Parameter builder should be final. 34
 Error coding HiddenField 'builder' hides a field. 34

org/apache/rat/anttasks/Any.java

Severity Category Rule Message Line
 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. 29
 Error regexp RegexpSingleline Line has trailing spaces. 33
 Error design DesignForExtension Class 'Any' looks like designed for extension (can be subclassed), but the method 'add' 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 'add' static/final/abstract/empty, or adding allowed annotation for the method. 34
 Error misc FinalParameters Parameter builder should be final. 34
 Error coding HiddenField 'builder' hides a field. 34

org/apache/rat/anttasks/Copyright.java

Severity Category Rule Message Line
 Error regexp RegexpSingleline Line has trailing spaces. 27
 Error design DesignForExtension Class 'Copyright' looks like designed for extension (can be subclassed), but the method 'setStart' 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 'setStart' static/final/abstract/empty, or adding allowed annotation for the method. 28
 Error misc FinalParameters Parameter start should be final. 28
 Error design DesignForExtension Class 'Copyright' looks like designed for extension (can be subclassed), but the method 'setEnd' 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 'setEnd' static/final/abstract/empty, or adding allowed annotation for the method. 32
 Error misc FinalParameters Parameter end should be final. 32
 Error design DesignForExtension Class 'Copyright' looks like designed for extension (can be subclassed), but the method 'setOwner' 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 'setOwner' static/final/abstract/empty, or adding allowed annotation for the method. 36
 Error misc FinalParameters Parameter owner should be final. 36
 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. 40
 Error regexp RegexpSingleline Line has trailing spaces. 44

org/apache/rat/anttasks/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. 27
 Error design DesignForExtension Class 'Family' looks like designed for extension (can be subclassed), but the method 'setId' 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 'setId' static/final/abstract/empty, or adding allowed annotation for the method. 31
 Error misc FinalParameters Parameter id should be final. 31
 Error design DesignForExtension Class 'Family' looks like designed for extension (can be subclassed), but the method 'setName' 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 'setName' static/final/abstract/empty, or adding allowed annotation for the method. 35
 Error misc FinalParameters Parameter name should be final. 35

org/apache/rat/anttasks/License.java

Severity Category Rule Message Line
 Error regexp RegexpSingleline Line has trailing spaces. 31
 Error design DesignForExtension Class 'License' looks like designed for extension (can be subclassed), but the method 'asBuilder' 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 'asBuilder' static/final/abstract/empty, or adding allowed annotation for the method. 32
 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. 36
 Error misc FinalParameters Parameter context should be final. 36
 Error design DesignForExtension Class 'License' looks like designed for extension (can be subclassed), but the method 'setNotes' 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 'setNotes' static/final/abstract/empty, or adding allowed annotation for the method. 40
 Error misc FinalParameters Parameter notes should be final. 40
 Error design DesignForExtension Class 'License' looks like designed for extension (can be subclassed), but the method 'addNotes' 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 'addNotes' static/final/abstract/empty, or adding allowed annotation for the method. 44
 Error misc FinalParameters Parameter notes should be final. 44
 Error regexp RegexpSingleline Line has trailing spaces. 47
 Error design DesignForExtension Class 'License' looks like designed for extension (can be subclassed), but the method 'setFamily' 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 'setFamily' static/final/abstract/empty, or adding allowed annotation for the method. 49
 Error misc FinalParameters Parameter licenseFamilyCategory should be final. 49
 Error regexp RegexpSingleline Line has trailing spaces. 52
 Error design DesignForExtension Class 'License' looks like designed for extension (can be subclassed), but the method 'setId' 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 'setId' static/final/abstract/empty, or adding allowed annotation for the method. 53
 Error misc FinalParameters Parameter id should be final. 53
 Error design DesignForExtension Class 'License' looks like designed for extension (can be subclassed), but the method 'setName' 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 'setName' static/final/abstract/empty, or adding allowed annotation for the method. 57
 Error misc FinalParameters Parameter name should be final. 57
 Error design DesignForExtension Class 'License' looks like designed for extension (can be subclassed), but the method 'add' 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 'add' static/final/abstract/empty, or adding allowed annotation for the method. 61
 Error misc FinalParameters Parameter builder should be final. 61
 Error coding HiddenField 'builder' hides a field. 61
 Error regexp RegexpSingleline Line has trailing spaces. 64
 Error design DesignForExtension Class 'License' looks like designed for extension (can be subclassed), but the method 'add' 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 'add' static/final/abstract/empty, or adding allowed annotation for the method. 65
 Error misc FinalParameters Parameter matcher should be final. 65

org/apache/rat/anttasks/Not.java

Severity Category Rule Message Line
 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. 29
 Error regexp RegexpSingleline Line has trailing spaces. 33
 Error design DesignForExtension Class 'Not' looks like designed for extension (can be subclassed), but the method 'add' 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 'add' static/final/abstract/empty, or adding allowed annotation for the method. 34
 Error misc FinalParameters Parameter builder should be final. 34
 Error coding HiddenField 'builder' hides a field. 34

org/apache/rat/anttasks/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. 29
 Error misc FinalParameters Parameter pattern should be final. 29
 Error design DesignForExtension Class 'Regex' looks like designed for extension (can be subclassed), but the method 'addText' 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 'addText' static/final/abstract/empty, or adding allowed annotation for the method. 33
 Error misc FinalParameters Parameter pattern should be final. 33
 Error design DesignForExtension Class 'Regex' 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 'Regex' final or making the method 'build' static/final/abstract/empty, or adding allowed annotation for the method. 37

org/apache/rat/anttasks/Report.java

Severity Category Rule Message Line
 Error imports AvoidStarImport Using the '.*' form of import should be avoided - java.io.*. 21
 Error regexp RegexpSingleline Line has trailing spaces. 86
 Error misc FinalParameters Parameter rc should be final. 89
 Error design DesignForExtension Class 'Report' looks like designed for extension (can be subclassed), but the method 'setInputFileFilter' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'Report' final or making the method 'setInputFileFilter' static/final/abstract/empty, or adding allowed annotation for the method. 96
 Error misc FinalParameters Parameter inputFileFilter should be final. 96
 Error design DesignForExtension Class 'Report' looks like designed for extension (can be subclassed), but the method 'setReportFile' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'Report' final or making the method 'setReportFile' static/final/abstract/empty, or adding allowed annotation for the method. 100
 Error misc FinalParameters Parameter reportFile should be final. 100
 Error design DesignForExtension Class 'Report' looks like designed for extension (can be subclassed), but the method 'addLicense' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'Report' final or making the method 'addLicense' static/final/abstract/empty, or adding allowed annotation for the method. 104
 Error misc FinalParameters Parameter lic should be final. 104
 Error design DesignForExtension Class 'Report' looks like designed for extension (can be subclassed), but the method 'addFamily' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'Report' final or making the method 'addFamily' static/final/abstract/empty, or adding allowed annotation for the method. 108
 Error misc FinalParameters Parameter family should be final. 108
 Error regexp RegexpSingleline Line has trailing spaces. 113
 Error misc FinalParameters Parameter styleSheet should be final. 118
 Error misc FinalParameters Parameter styleSheet should be final. 126
 Error design DesignForExtension Class 'Report' looks like designed for extension (can be subclassed), but the method 'setStyleReport' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'Report' final or making the method 'setStyleReport' static/final/abstract/empty, or adding allowed annotation for the method. 131
 Error misc FinalParameters Parameter styleReport should be final. 131
 Error regexp RegexpSingleline Line has trailing spaces. 136
 Error misc FinalParameters Parameter style should be final. 141
 Error design DesignForExtension Class 'Report' looks like designed for extension (can be subclassed), but the method 'setLicenses' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'Report' final or making the method 'setLicenses' static/final/abstract/empty, or adding allowed annotation for the method. 146
 Error misc FinalParameters Parameter fileName should be final. 146
 Error misc FinalParameters Parameter useDefaultLicenses should be final. 169
 Error design DesignForExtension Class 'Report' looks like designed for extension (can be subclassed), but the method 'setAddApprovedLicense' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'Report' final or making the method 'setAddApprovedLicense' static/final/abstract/empty, or adding allowed annotation for the method. 175
 Error misc FinalParameters Parameter familyCategory should be final. 175
 Error design DesignForExtension Class 'Report' looks like designed for extension (can be subclassed), but the method 'addAddApprovedLicense' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'Report' final or making the method 'addAddApprovedLicense' static/final/abstract/empty, or adding allowed annotation for the method. 179
 Error misc FinalParameters Parameter familyCategory should be final. 179
 Error design DesignForExtension Class 'Report' looks like designed for extension (can be subclassed), but the method 'setRemoveApprovedLicense' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'Report' final or making the method 'setRemoveApprovedLicense' static/final/abstract/empty, or adding allowed annotation for the method. 183
 Error misc FinalParameters Parameter familyCategory should be final. 183
 Error design DesignForExtension Class 'Report' looks like designed for extension (can be subclassed), but the method 'setRemoveApprovedLicense' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'Report' final or making the method 'setRemoveApprovedLicense' static/final/abstract/empty, or adding allowed annotation for the method. 187
 Error misc FinalParameters Parameter familyCategory should be final. 187
 Error design DesignForExtension Class 'Report' looks like designed for extension (can be subclassed), but the method 'setCopyrightMessage' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'Report' final or making the method 'setCopyrightMessage' static/final/abstract/empty, or adding allowed annotation for the method. 191
 Error misc FinalParameters Parameter copyrightMessage should be final. 191
 Error design DesignForExtension Class 'Report' looks like designed for extension (can be subclassed), but the method 'setAddLicenseHeaders' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'Report' final or making the method 'setAddLicenseHeaders' static/final/abstract/empty, or adding allowed annotation for the method. 195
 Error misc FinalParameters Parameter setting should be final. 195
 Error design DesignForExtension Class 'Report' looks like designed for extension (can be subclassed), but the method 'setAddDefaultDefinitions' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'Report' final or making the method 'setAddDefaultDefinitions' static/final/abstract/empty, or adding allowed annotation for the method. 199
 Error misc FinalParameters Parameter fileName should be final. 199
 Error design DesignForExtension Class 'Report' 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 'Report' final or making the method 'getConfiguration' static/final/abstract/empty, or adding allowed annotation for the method. 207
 Error misc FinalParameters Parameter cfg should be final. 241
 Error misc FinalParameters Parameter s should be final. 264
 Error design DesignForExtension Class 'AddLicenseHeaders' looks like designed for extension (can be subclassed), but the method 'getValues' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'AddLicenseHeaders' final or making the method 'getValues' static/final/abstract/empty, or adding allowed annotation for the method. 268
 Error whitespace NoWhitespaceAfter '{' is followed by whitespace. 270
 Error design DesignForExtension Class 'AddLicenseHeaders' looks like designed for extension (can be subclassed), but the method 'getNative' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'AddLicenseHeaders' final or making the method 'getNative' static/final/abstract/empty, or adding allowed annotation for the method. 273
 Error misc FinalParameters Parameter s should be final. 286
 Error design DesignForExtension Class 'ApprovalFilter' looks like designed for extension (can be subclassed), but the method 'getValues' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'ApprovalFilter' final or making the method 'getValues' static/final/abstract/empty, or adding allowed annotation for the method. 290
 Error design DesignForExtension Class 'ApprovalFilter' looks like designed for extension (can be subclassed), but the method 'internalFilter' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'ApprovalFilter' final or making the method 'internalFilter' static/final/abstract/empty, or adding allowed annotation for the method. 296
 Error regexp RegexpSingleline Line has trailing spaces. 300
 Error misc FinalParameters Parameter level should be final. 303
 Error misc FinalParameters Parameter msg should be final. 303
 Error blocks LeftCurly '{' at column 13 should be on the previous line. 305
 Error misc FinalParameters Parameter level should be final. 311
 Error misc FinalParameters Parameter msg should be final. 311
 Error regexp RegexpSingleline Line has trailing spaces. 330

org/apache/rat/anttasks/ResourceCollectionContainer.java

Severity Category Rule Message Line
 Error misc FinalParameters Parameter rc should be final. 46
 Error coding HiddenField 'rc' hides a field. 46
 Error misc FinalParameters Parameter report should be final. 51
 Error design FinalClass Class ResourceDocument should be declared as final. 61
 Error misc FinalParameters Parameter resource should be final. 65
 Error whitespace OperatorWrap '?' should be on a new line. 66
 Error misc FinalParameters Parameter resource should be final. 72
 Error coding HiddenField 'resource' hides a field. 72

org/apache/rat/anttasks/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 'setName' 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 'setName' static/final/abstract/empty, or adding allowed annotation for the method. 28
 Error misc FinalParameters Parameter spdxId should be final. 28
 Error regexp RegexpSingleline Line has trailing spaces. 31
 Error design DesignForExtension Class 'Spdx' looks like designed for extension (can be subclassed), but the method 'addText' 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 'addText' static/final/abstract/empty, or adding allowed annotation for the method. 32
 Error misc FinalParameters Parameter spdxId should be final. 32
 Error design DesignForExtension Class 'Spdx' 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 'Spdx' final or making the method 'build' static/final/abstract/empty, or adding allowed annotation for the method. 36

org/apache/rat/anttasks/Text.java

Severity Category Rule Message Line
 Error regexp RegexpSingleline Line has trailing spaces. 25
 Error regexp RegexpSingleline Line has trailing spaces. 27
 Error design DesignForExtension Class 'Text' looks like designed for extension (can be subclassed), but the method 'addText' 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 'addText' static/final/abstract/empty, or adding allowed annotation for the method. 28
 Error misc FinalParameters Parameter text should be final. 28
 Error design DesignForExtension Class 'Text' looks like designed for extension (can be subclassed), but the method 'setText' 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 'setText' static/final/abstract/empty, or adding allowed annotation for the method. 32
 Error misc FinalParameters Parameter text should be final. 32
 Error design DesignForExtension Class 'Text' 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 'Text' final or making the method 'build' static/final/abstract/empty, or adding allowed annotation for the method. 35