Checkstyle Results

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

Summary

Files  Info  Warnings  Errors
15 0 0 106

Files

File  I  W  E
org/apache/creadur/whisker/model/ByOrganisation.java 0 0 4
org/apache/creadur/whisker/model/Descriptor.java 0 0 22
org/apache/creadur/whisker/model/License.java 0 0 23
org/apache/creadur/whisker/model/LicenseTemplateException.java 0 0 14
org/apache/creadur/whisker/model/NoCopyrightNoticeVerifier.java 0 0 1
org/apache/creadur/whisker/model/NoticeCollator.java 0 0 8
org/apache/creadur/whisker/model/Organisation.java 0 0 18
org/apache/creadur/whisker/model/Resource.java 0 0 3
org/apache/creadur/whisker/model/ResourceNamesCollator.java 0 0 2
org/apache/creadur/whisker/model/WithLicense.java 0 0 4
org/apache/creadur/whisker/model/WithinDirectory.java 0 0 6
org/apache/creadur/whisker/model/package-info.java 0 0 1

Rules

Category Rule Violations Severity
coding HiddenField 38  Error
design DesignForExtension 5  Error
FinalClass 1  Error
javadoc JavadocMethod 6  Error
JavadocStyle 7  Error
JavadocVariable 1  Error
MissingJavadocMethod 1  Error
misc FinalParameters 1  Error
NewlineAtEndOfFile 1  Error
regexp RegexpSingleline
  • format: "\s+$"
  • maximum: "0"
  • message: "Line has trailing spaces."
  • minimum: "0"
 29  Error
sizes LineLength
  • fileExtensions: "java"
 14  Error
ParameterNumber 1  Error
whitespace ParenPad 1  Error

Details

org/apache/creadur/whisker/model/ByOrganisation.java

Severity Category Rule Message Line
 Error sizes LineLength Line is longer than 80 characters (found 83). 27
 Error coding HiddenField 'organisation' hides a field. 42
 Error coding HiddenField 'resources' hides a field. 43
 Error sizes LineLength Line is longer than 80 characters (found 81). 74

org/apache/creadur/whisker/model/Descriptor.java

Severity Category Rule Message Line
 Error javadoc JavadocStyle First sentence should end with a period. 32
 Error javadoc JavadocStyle First sentence should end with a period. 40
 Error coding HiddenField 'primaryLicense' hides a field. 67
 Error coding HiddenField 'primaryOrganisationId' hides a field. 68
 Error coding HiddenField 'primaryNotice' hides a field. 69
 Error coding HiddenField 'licenses' hides a field. 70
 Error coding HiddenField 'notices' hides a field. 71
 Error coding HiddenField 'organisations' hides a field. 72
 Error coding HiddenField 'contents' hides a field. 73
 Error whitespace ParenPad '(' is followed by whitespace. 74
 Error sizes ParameterNumber More than 7 parameters (found 8). 106
 Error coding HiddenField 'primaryLicense' hides a field. 106
 Error coding HiddenField 'primaryCopyrightNotice' hides a field. 107
 Error coding HiddenField 'primaryOrganisationId' hides a field. 108
 Error coding HiddenField 'primaryNotice' hides a field. 109
 Error coding HiddenField 'licenses' hides a field. 110
 Error coding HiddenField 'notices' hides a field. 111
 Error coding HiddenField 'organisations' hides a field. 112
 Error coding HiddenField 'contents' hides a field. 113
 Error sizes LineLength Line is longer than 80 characters (found 83). 246
 Error sizes LineLength Line is longer than 80 characters (found 93). 247
 Error sizes LineLength Line is longer than 80 characters (found 97). 323

org/apache/creadur/whisker/model/License.java

Severity Category Rule Message Line
 Error regexp RegexpSingleline Line has trailing spaces. 17
 Error regexp RegexpSingleline Line has trailing spaces. 32
 Error regexp RegexpSingleline Line has trailing spaces. 33
 Error javadoc JavadocStyle First sentence should end with a period. 44
 Error regexp RegexpSingleline Line has trailing spaces. 46
 Error coding HiddenField 'isSourceRequired' hides a field. 58
 Error coding HiddenField 'baseText' hides a field. 58
 Error coding HiddenField 'expectedParameters' hides a field. 59
 Error coding HiddenField 'id' hides a field. 59
 Error coding HiddenField 'url' hides a field. 60
 Error coding HiddenField 'name' hides a field. 60
 Error javadoc JavadocStyle First sentence should end with a period. 91
 Error regexp RegexpSingleline Line has trailing spaces. 93
 Error regexp RegexpSingleline Line has trailing spaces. 103
 Error regexp RegexpSingleline Line has trailing spaces. 143
 Error coding HiddenField 'expectedParameters' hides a field. 150
 Error javadoc JavadocStyle First sentence should end with a period. 156
 Error regexp RegexpSingleline Line has trailing spaces. 157
 Error regexp RegexpSingleline Line has trailing spaces. 168
 Error regexp RegexpSingleline Line has trailing spaces. 210
 Error javadoc JavadocMethod @return tag should be present and have description. 247
 Error javadoc JavadocMethod Expected @param tag for 'other'. 247
 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. 253

org/apache/creadur/whisker/model/LicenseTemplateException.java

Severity Category Rule Message Line
 Error misc NewlineAtEndOfFile File does not end with a newline. 1
 Error regexp RegexpSingleline Line has trailing spaces. 17
 Error design FinalClass Class LicenseTemplateException should be declared as final. 28
 Error javadoc JavadocStyle First sentence should end with a period. 32
 Error sizes LineLength Line is longer than 80 characters (found 92). 47
 Error sizes LineLength Line is longer than 80 characters (found 93). 50
 Error sizes LineLength Line is longer than 80 characters (found 96). 51
 Error regexp RegexpSingleline Line has trailing spaces. 82
 Error regexp RegexpSingleline Line has trailing spaces. 87
 Error sizes LineLength Line is longer than 80 characters (found 81). 93
 Error javadoc JavadocMethod Unused @param tag for 'parameters'. 110
 Error sizes LineLength Line is longer than 80 characters (found 86). 113
 Error coding HiddenField 'licenseName' hides a field. 113
 Error regexp RegexpSingleline Line has trailing spaces. 126

org/apache/creadur/whisker/model/NoCopyrightNoticeVerifier.java

Severity Category Rule Message Line
 Error misc FinalParameters Parameter license should be final. 37

org/apache/creadur/whisker/model/NoticeCollator.java

Severity Category Rule Message Line
 Error regexp RegexpSingleline Line has trailing spaces. 17
 Error regexp RegexpSingleline Line has trailing spaces. 29
 Error sizes LineLength Line is longer than 80 characters (found 118). 33
 Error javadoc JavadocVariable Missing a Javadoc comment. 33
 Error design DesignForExtension Class 'NoticeCollator' looks like designed for extension (can be subclassed), but the method 'resourceNotices' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'NoticeCollator' final or making the method 'resourceNotices' static/final/abstract/empty, or adding allowed annotation for the method. 56
 Error javadoc MissingJavadocMethod Missing a Javadoc comment. 56
 Error sizes LineLength Line is longer than 80 characters (found 102). 58
 Error sizes LineLength Line is longer than 80 characters (found 91). 59

org/apache/creadur/whisker/model/Organisation.java

Severity Category Rule Message Line
 Error regexp RegexpSingleline Line has trailing spaces. 17
 Error regexp RegexpSingleline Line has trailing spaces. 24
 Error regexp RegexpSingleline Line has trailing spaces. 38
 Error regexp RegexpSingleline Line has trailing spaces. 39
 Error regexp RegexpSingleline Line has trailing spaces. 41
 Error regexp RegexpSingleline Line has trailing spaces. 43
 Error coding HiddenField 'id' hides a field. 46
 Error coding HiddenField 'name' hides a field. 46
 Error coding HiddenField 'url' hides a field. 46
 Error regexp RegexpSingleline Line has trailing spaces. 65
 Error regexp RegexpSingleline Line has trailing spaces. 74
 Error regexp RegexpSingleline Line has trailing spaces. 83
 Error regexp RegexpSingleline Line has trailing spaces. 84
 Error design DesignForExtension Class 'Organisation' looks like designed for extension (can be subclassed), but the method 'hashCode' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'Organisation' final or making the method 'hashCode' static/final/abstract/empty, or adding allowed annotation for the method. 92
 Error design DesignForExtension Class 'Organisation' looks like designed for extension (can be subclassed), but the method 'equals' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'Organisation' final or making the method 'equals' static/final/abstract/empty, or adding allowed annotation for the method. 100
 Error javadoc JavadocMethod @return tag should be present and have description. 125
 Error javadoc JavadocMethod Expected @param tag for 'other'. 125
 Error design DesignForExtension Class 'Organisation' 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 'Organisation' final or making the method 'toString' static/final/abstract/empty, or adding allowed annotation for the method. 131

org/apache/creadur/whisker/model/Resource.java

Severity Category Rule Message Line
 Error coding HiddenField 'name' hides a field. 44
 Error coding HiddenField 'noticeId' hides a field. 44
 Error coding HiddenField 'source' hides a field. 45

org/apache/creadur/whisker/model/ResourceNamesCollator.java

Severity Category Rule Message Line
 Error regexp RegexpSingleline Line has trailing spaces. 34
 Error regexp RegexpSingleline Line has trailing spaces. 37

org/apache/creadur/whisker/model/WithLicense.java

Severity Category Rule Message Line
 Error coding HiddenField 'license' hides a field. 50
 Error coding HiddenField 'copyrightNotice' hides a field. 50
 Error coding HiddenField 'parameters' hides a field. 51
 Error coding HiddenField 'organisations' hides a field. 52

org/apache/creadur/whisker/model/WithinDirectory.java

Severity Category Rule Message Line
 Error sizes LineLength Line is longer than 80 characters (found 85). 27
 Error javadoc JavadocStyle First sentence should end with a period. 36
 Error coding HiddenField 'name' hides a field. 44
 Error coding HiddenField 'licenses' hides a field. 45
 Error coding HiddenField 'publicDomain' hides a field. 46
 Error javadoc JavadocMethod Expected @param tag for 'other'. 116

org/apache/creadur/whisker/model/package-info.java

Severity Category Rule Message Line
 Error regexp RegexpSingleline Line has trailing spaces. 20