Checkstyle Results

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

rss feed

Summary

Files
 Info
 Warnings
 Errors
13 0 68 0

Files

File
 I
 W
 E
gov/nist/secauto/swid/client/Application.java 0 5 0
gov/nist/secauto/swid/client/service/Action.java 0 8 0
gov/nist/secauto/swid/client/service/HTTPService.java 0 2 0
gov/nist/secauto/swid/client/service/HTTPServiceImpl.java 0 7 0
gov/nist/secauto/swid/client/service/HttpClientFactory.java 0 2 0
gov/nist/secauto/swid/client/service/JWTException.java 0 5 0
gov/nist/secauto/swid/client/service/LoginService.java 0 1 0
gov/nist/secauto/swid/client/service/LoginServiceImpl.java 0 6 0
gov/nist/secauto/swid/client/service/PayloadBuilderService.java 0 1 0
gov/nist/secauto/swid/client/service/PayloadBuilderServiceImpl.java 0 9 0
gov/nist/secauto/swid/client/service/TagType.java 0 4 0
gov/nist/secauto/swid/client/totp/Hotp.java 0 11 0
gov/nist/secauto/swid/client/totp/Totp.java 0 7 0

Rules

Category Rule Violations Severity
imports ImportOrder
  • ordered: "true"
  • sortStaticImportsAlphabetically: "true"
  • groups: "com,gov,net,org,/^java\./,javax"
  • separated: "true"
  • separatedStaticGroups: "true"
  • option: "top"
1
 Warning
javadoc JavadocMethod
  • validateThrows: "true"
  • scope: "protected"
  • allowedAnnotations: "Override, Test"
2
 Warning
MissingJavadocMethod
  • scope: "protected"
5
 Warning
NonEmptyAtclauseDescription 11
 Warning
SummaryJavadoc
  • forbiddenSummaryFragments: "^@return the *|^This method returns |^A [{]@code [a-zA-Z0-9]+[}]( is a )"
43
 Warning
naming LocalVariableName
  • format: "^[a-z][a-z0-9][a-zA-Z0-9]*$"
  • allowOneCharVarInForLoop: "true"
  • tokens: "VARIABLE_DEF"
1
 Warning
MemberName
  • format: "^[a-z][a-z0-9][a-zA-Z0-9]*$"
1
 Warning
ParameterName
  • format: "^[a-z][a-z0-9][a-zA-Z0-9]*$"
4
 Warning

Details

gov/nist/secauto/swid/client/Application.java

Severity Category Rule Message Line
 Warning
javadoc SummaryJavadoc First sentence of Javadoc is missing an ending period. 57
 Warning
javadoc SummaryJavadoc First sentence of Javadoc is missing an ending period. 73
 Warning
javadoc NonEmptyAtclauseDescription Javadoc comment at column 0 has parse error. Details: no viable alternative at input ' *' while parsing JAVADOC_TAG 127
 Warning
javadoc SummaryJavadoc First sentence of Javadoc is missing an ending period. 175
 Warning
javadoc NonEmptyAtclauseDescription At-clause should have a non-empty description. 178

gov/nist/secauto/swid/client/service/Action.java

Severity Category Rule Message Line
 Warning
javadoc SummaryJavadoc First sentence of Javadoc is missing an ending period. 46
 Warning
javadoc SummaryJavadoc First sentence of Javadoc is missing an ending period. 55
 Warning
javadoc MissingJavadocMethod Missing a Javadoc comment. 86
 Warning
javadoc SummaryJavadoc First sentence of Javadoc is missing an ending period. 90
 Warning
javadoc SummaryJavadoc First sentence of Javadoc is missing an ending period. 100
 Warning
javadoc SummaryJavadoc First sentence of Javadoc is missing an ending period. 109
 Warning
javadoc SummaryJavadoc First sentence of Javadoc is missing an ending period. 119
 Warning
javadoc SummaryJavadoc First sentence of Javadoc is missing an ending period. 129

gov/nist/secauto/swid/client/service/HTTPService.java

Severity Category Rule Message Line
 Warning
javadoc SummaryJavadoc First sentence of Javadoc is missing an ending period. 43
 Warning
javadoc SummaryJavadoc Summary javadoc is missing. 76

gov/nist/secauto/swid/client/service/HTTPServiceImpl.java

Severity Category Rule Message Line
 Warning
imports ImportOrder Wrong order for 'org.apache.commons.lang.StringEscapeUtils' import. 34
 Warning
javadoc NonEmptyAtclauseDescription Javadoc comment at column 0 has parse error. Details: no viable alternative at input ' *' while parsing JAVADOC_TAG 146
 Warning
javadoc SummaryJavadoc First sentence of Javadoc is missing an ending period. 187
 Warning
javadoc SummaryJavadoc First sentence of Javadoc is missing an ending period. 216
 Warning
javadoc SummaryJavadoc First sentence of Javadoc is missing an ending period. 229
 Warning
javadoc SummaryJavadoc First sentence of Javadoc is missing an ending period. 281
 Warning
javadoc SummaryJavadoc First sentence of Javadoc is missing an ending period. 310

gov/nist/secauto/swid/client/service/HttpClientFactory.java

Severity Category Rule Message Line
 Warning
javadoc SummaryJavadoc First sentence of Javadoc is missing an ending period. 51
 Warning
javadoc SummaryJavadoc First sentence of Javadoc is missing an ending period. 89

gov/nist/secauto/swid/client/service/JWTException.java

Severity Category Rule Message Line
 Warning
javadoc SummaryJavadoc Summary javadoc is missing. 33
 Warning
javadoc MissingJavadocMethod Missing a Javadoc comment. 36
 Warning
javadoc MissingJavadocMethod Missing a Javadoc comment. 40
 Warning
naming ParameterName Parameter name 'e' must match pattern '^[a-z][a-z0-9][a-zA-Z0-9]*$'. 40
 Warning
javadoc MissingJavadocMethod Missing a Javadoc comment. 44

gov/nist/secauto/swid/client/service/LoginService.java

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

gov/nist/secauto/swid/client/service/LoginServiceImpl.java

Severity Category Rule Message Line
 Warning
javadoc SummaryJavadoc Summary javadoc is missing. 62
 Warning
javadoc SummaryJavadoc First sentence of Javadoc is missing an ending period. 106
 Warning
javadoc NonEmptyAtclauseDescription At-clause should have a non-empty description. 109
 Warning
javadoc SummaryJavadoc First sentence of Javadoc is missing an ending period. 119
 Warning
naming ParameterName Parameter name 'aHTTPClient' must match pattern '^[a-z][a-z0-9][a-zA-Z0-9]*$'. 130
 Warning
javadoc SummaryJavadoc First sentence of Javadoc is missing an ending period. 154

gov/nist/secauto/swid/client/service/PayloadBuilderService.java

Severity Category Rule Message Line
 Warning
javadoc SummaryJavadoc First sentence of Javadoc is missing an ending period. 35

gov/nist/secauto/swid/client/service/PayloadBuilderServiceImpl.java

Severity Category Rule Message Line
 Warning
javadoc SummaryJavadoc First sentence of Javadoc is missing an ending period. 46
 Warning
javadoc NonEmptyAtclauseDescription Javadoc comment at column 0 has parse error. Details: no viable alternative at input ' *' while parsing JAVADOC_TAG 68
 Warning
javadoc SummaryJavadoc First sentence of Javadoc is missing an ending period. 84
 Warning
javadoc NonEmptyAtclauseDescription At-clause should have a non-empty description. 87
 Warning
javadoc SummaryJavadoc First sentence of Javadoc is missing an ending period. 95
 Warning
javadoc NonEmptyAtclauseDescription At-clause should have a non-empty description. 98
 Warning
javadoc SummaryJavadoc First sentence of Javadoc is missing an ending period. 108
 Warning
javadoc NonEmptyAtclauseDescription At-clause should have a non-empty description. 111
 Warning
javadoc NonEmptyAtclauseDescription At-clause should have a non-empty description. 112

gov/nist/secauto/swid/client/service/TagType.java

Severity Category Rule Message Line
 Warning
javadoc SummaryJavadoc First sentence of Javadoc is missing an ending period. 46
 Warning
javadoc SummaryJavadoc First sentence of Javadoc is missing an ending period. 62
 Warning
javadoc SummaryJavadoc First sentence of Javadoc is missing an ending period. 72
 Warning
javadoc SummaryJavadoc First sentence of Javadoc is missing an ending period. 81

gov/nist/secauto/swid/client/totp/Hotp.java

Severity Category Rule Message Line
 Warning
javadoc MissingJavadocMethod Missing a Javadoc comment. 54
 Warning
javadoc SummaryJavadoc Summary javadoc is missing. 63
 Warning
javadoc SummaryJavadoc First sentence of Javadoc is missing an ending period. 91
 Warning
javadoc SummaryJavadoc First sentence of Javadoc is missing an ending period. 93
 Warning
javadoc SummaryJavadoc First sentence of Javadoc is missing an ending period. 96
 Warning
javadoc SummaryJavadoc First sentence of Javadoc is missing an ending period. 109
 Warning
javadoc JavadocMethod Expected @throws tag for 'RuntimeException'. 124
 Warning
javadoc SummaryJavadoc First sentence of Javadoc is missing an ending period. 130
 Warning
naming ParameterName Parameter name 's' must match pattern '^[a-z][a-z0-9][a-zA-Z0-9]*$'. 139
 Warning
javadoc NonEmptyAtclauseDescription At-clause should have a non-empty description. 176
 Warning
javadoc NonEmptyAtclauseDescription At-clause should have a non-empty description. 177

gov/nist/secauto/swid/client/totp/Totp.java

Severity Category Rule Message Line
 Warning
naming MemberName Member name 'T0' must match pattern '^[a-z][a-z0-9][a-zA-Z0-9]*$'. 44
 Warning
naming ParameterName Parameter name 'T0' must match pattern '^[a-z][a-z0-9][a-zA-Z0-9]*$'. 81
 Warning
javadoc JavadocMethod Expected @throws tag for 'IllegalArgumentException'. 83
 Warning
javadoc SummaryJavadoc First sentence of Javadoc is missing an ending period. 90
 Warning
javadoc SummaryJavadoc First sentence of Javadoc is missing an ending period. 101
 Warning
naming LocalVariableName Local variable name 'T' must match pattern '^[a-z][a-z0-9][a-zA-Z0-9]*$'. 111
 Warning
javadoc SummaryJavadoc Summary javadoc is missing. 115