Checkstyle Results

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

rss feed

Summary

Files
 Info
 Warnings
 Errors
43 0 156 0

Files

File
 I
 W
 E
gov/nist/secauto/swid/builder/AbstractBuilder.java 0 6 0
gov/nist/secauto/swid/builder/AbstractLanguageSpecificBuilder.java 0 2 0
gov/nist/secauto/swid/builder/Builder.java 0 3 0
gov/nist/secauto/swid/builder/EntityBuilder.java 0 7 0
gov/nist/secauto/swid/builder/LinkBuilder.java 0 9 0
gov/nist/secauto/swid/builder/MetaBuilder.java 0 2 0
gov/nist/secauto/swid/builder/Role.java 0 2 0
gov/nist/secauto/swid/builder/SWIDBuilder.java 0 15 0
gov/nist/secauto/swid/builder/UnknownRole.java 0 1 0
gov/nist/secauto/swid/builder/UnknownVersionScheme.java 0 1 0
gov/nist/secauto/swid/builder/ValidationException.java 0 3 0
gov/nist/secauto/swid/builder/VersionScheme.java 0 3 0
gov/nist/secauto/swid/builder/output/AbstractJsonOutputHandler.java 0 7 0
gov/nist/secauto/swid/builder/output/CBORFirmwareOutputHandler.java 0 1 0
gov/nist/secauto/swid/builder/output/CBOROutputHandler.java 0 2 0
gov/nist/secauto/swid/builder/output/JsonOutputHandler.java 0 2 0
gov/nist/secauto/swid/builder/output/JsonSupport.java 0 10 0
gov/nist/secauto/swid/builder/output/JsonWritable.java 0 1 0
gov/nist/secauto/swid/builder/output/OutputHandler.java 0 1 0
gov/nist/secauto/swid/builder/output/XMLOutputHandler.java 0 9 0
gov/nist/secauto/swid/builder/resource/AbstractObjectBasedResourceEntry.java 0 3 0
gov/nist/secauto/swid/builder/resource/AbstractResourceBuilder.java 0 1 0
gov/nist/secauto/swid/builder/resource/AbstractResourceCollectionBuilder.java 0 2 0
gov/nist/secauto/swid/builder/resource/EvidenceBuilder.java 0 4 0
gov/nist/secauto/swid/builder/resource/HashUtils.java 0 1 0
gov/nist/secauto/swid/builder/resource/PayloadBuilder.java 0 2 0
gov/nist/secauto/swid/builder/resource/ResourceBuilder.java 0 1 0
gov/nist/secauto/swid/builder/resource/ResourceCollection.java 0 1 0
gov/nist/secauto/swid/builder/resource/ResourceEntry.java 0 5 0
gov/nist/secauto/swid/builder/resource/file/AbstractFileSystemItemBuilder.java 0 5 0
gov/nist/secauto/swid/builder/resource/file/DirectoryBuilder.java 0 1 0
gov/nist/secauto/swid/builder/resource/file/FileBuilder.java 0 6 0
gov/nist/secauto/swid/builder/resource/firmware/DeviceIdentifier.java 0 4 0
gov/nist/secauto/swid/builder/resource/firmware/DigestType.java 0 1 0
gov/nist/secauto/swid/builder/resource/firmware/FirmwareBuilder.java 0 2 0
gov/nist/secauto/swid/builder/resource/firmware/FirmwareCondition.java 0 1 0
gov/nist/secauto/swid/builder/resource/firmware/FirmwareDirective.java 0 1 0
gov/nist/secauto/swid/builder/resource/firmware/FirmwareIdentifier.java 0 3 0
gov/nist/secauto/swid/builder/resource/firmware/FirmwarePayloadDigest.java 0 10 0
gov/nist/secauto/swid/builder/resource/firmware/FirmwarePayloadPackage.java 0 6 0
gov/nist/secauto/swid/builder/resource/firmware/FirmwareRequirement.java 0 4 0
gov/nist/secauto/swid/builder/resource/firmware/ResourceReference.java 0 4 0
gov/nist/secauto/swid/builder/resource/firmware/StringFirmwareIdentifier.java 0 1 0

Rules

Category Rule Violations Severity
javadoc JavadocMethod
  • validateThrows: "true"
  • scope: "protected"
  • allowedAnnotations: "Override, Test"
 2
 Warning
MissingJavadocMethod
  • scope: "protected"
 132
 Warning
SummaryJavadoc
  • forbiddenSummaryFragments: "^@return the *|^This method returns |^A [{]@code [a-zA-Z0-9]+[}]( is a )"
 22
 Warning

Details

gov/nist/secauto/swid/builder/AbstractBuilder.java

Severity Category Rule Message Line
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 33
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 39
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 48
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 57
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 66
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 75

gov/nist/secauto/swid/builder/AbstractLanguageSpecificBuilder.java

Severity Category Rule Message Line
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 36
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 45

gov/nist/secauto/swid/builder/Builder.java

Severity Category Rule Message Line
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 30
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 33
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 35

gov/nist/secauto/swid/builder/EntityBuilder.java

Severity Category Rule Message Line
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 41
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 54
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 58
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 62
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 66
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 70
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 103

gov/nist/secauto/swid/builder/LinkBuilder.java

Severity Category Rule Message Line
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 36
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 48
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 63
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 67
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 71
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 75
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 79
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 83
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 87

gov/nist/secauto/swid/builder/MetaBuilder.java

Severity Category Rule Message Line
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 32
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 52

gov/nist/secauto/swid/builder/Role.java

Severity Category Rule Message Line
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 33
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 35

gov/nist/secauto/swid/builder/SWIDBuilder.java

Severity Category Rule Message Line
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 54
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 81
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 85
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 89
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 93
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 97
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 101
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 105
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 109
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 113
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 117
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 134
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 138
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 155
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 198

gov/nist/secauto/swid/builder/UnknownRole.java

Severity Category Rule Message Line
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 33

gov/nist/secauto/swid/builder/UnknownVersionScheme.java

Severity Category Rule Message Line
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 33

gov/nist/secauto/swid/builder/ValidationException.java

Severity Category Rule Message Line
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 36
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 40
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 44

gov/nist/secauto/swid/builder/VersionScheme.java

Severity Category Rule Message Line
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 33
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 35
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 60

gov/nist/secauto/swid/builder/output/AbstractJsonOutputHandler.java

Severity Category Rule Message Line
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 159
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 163
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 165
 Warning		 javadoc SummaryJavadoc Summary javadoc is missing. 167
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 174
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 193
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 293

gov/nist/secauto/swid/builder/output/CBORFirmwareOutputHandler.java

Severity Category Rule Message Line
 Warning		 javadoc JavadocMethod Expected @throws tag for 'RuntimeException'. 170

gov/nist/secauto/swid/builder/output/CBOROutputHandler.java

Severity Category Rule Message Line
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 40
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 44

gov/nist/secauto/swid/builder/output/JsonOutputHandler.java

Severity Category Rule Message Line
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 107
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 111

gov/nist/secauto/swid/builder/output/JsonSupport.java

Severity Category Rule Message Line
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 41
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 45
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 51
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 56
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 62
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 67
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 72
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 77
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 82
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 91

gov/nist/secauto/swid/builder/output/JsonWritable.java

Severity Category Rule Message Line
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 34

gov/nist/secauto/swid/builder/output/OutputHandler.java

Severity Category Rule Message Line
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 37

gov/nist/secauto/swid/builder/output/XMLOutputHandler.java

Severity Category Rule Message Line
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 69
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 73
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 99
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 103
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 162
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 190
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 204
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 223
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 245

gov/nist/secauto/swid/builder/resource/AbstractObjectBasedResourceEntry.java

Severity Category Rule Message Line
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 40
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 45
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 48

gov/nist/secauto/swid/builder/resource/AbstractResourceBuilder.java

Severity Category Rule Message Line
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 34

gov/nist/secauto/swid/builder/resource/AbstractResourceCollectionBuilder.java

Severity Category Rule Message Line
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 47
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 134

gov/nist/secauto/swid/builder/resource/EvidenceBuilder.java

Severity Category Rule Message Line
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 40
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 44
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 55
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 59

gov/nist/secauto/swid/builder/resource/HashUtils.java

Severity Category Rule Message Line
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 120

gov/nist/secauto/swid/builder/resource/PayloadBuilder.java

Severity Category Rule Message Line
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 31
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 35

gov/nist/secauto/swid/builder/resource/ResourceBuilder.java

Severity Category Rule Message Line
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 32

gov/nist/secauto/swid/builder/resource/ResourceCollection.java

Severity Category Rule Message Line
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 62

gov/nist/secauto/swid/builder/resource/ResourceEntry.java

Severity Category Rule Message Line
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 34
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 36
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 38
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 40
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 42

gov/nist/secauto/swid/builder/resource/file/AbstractFileSystemItemBuilder.java

Severity Category Rule Message Line
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 45
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 59
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 63
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 67
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 71

gov/nist/secauto/swid/builder/resource/file/DirectoryBuilder.java

Severity Category Rule Message Line
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 48

gov/nist/secauto/swid/builder/resource/file/FileBuilder.java

Severity Category Rule Message Line
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 50
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 62
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 71
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 75
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 79
 Warning		 javadoc JavadocMethod Expected @throws tag for 'IllegalArgumentException'. 92

gov/nist/secauto/swid/builder/resource/firmware/DeviceIdentifier.java

Severity Category Rule Message Line
 Warning		 javadoc SummaryJavadoc Summary javadoc is missing. 115
 Warning		 javadoc SummaryJavadoc Summary javadoc is missing. 122
 Warning		 javadoc SummaryJavadoc Summary javadoc is missing. 131
 Warning		 javadoc SummaryJavadoc Summary javadoc is missing. 138

gov/nist/secauto/swid/builder/resource/firmware/DigestType.java

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

gov/nist/secauto/swid/builder/resource/firmware/FirmwareBuilder.java

Severity Category Rule Message Line
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 56
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 320

gov/nist/secauto/swid/builder/resource/firmware/FirmwareCondition.java

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

gov/nist/secauto/swid/builder/resource/firmware/FirmwareDirective.java

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

gov/nist/secauto/swid/builder/resource/firmware/FirmwareIdentifier.java

Severity Category Rule Message Line
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 34
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 36
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 38

gov/nist/secauto/swid/builder/resource/firmware/FirmwarePayloadDigest.java

Severity Category Rule Message Line
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 44
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 49
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 54
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 59
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 64
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 68
 Warning		 javadoc SummaryJavadoc Summary javadoc is missing. 79
 Warning		 javadoc SummaryJavadoc Summary javadoc is missing. 86
 Warning		 javadoc SummaryJavadoc Summary javadoc is missing. 93
 Warning		 javadoc SummaryJavadoc Summary javadoc is missing. 100

gov/nist/secauto/swid/builder/resource/firmware/FirmwarePayloadPackage.java

Severity Category Rule Message Line
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 34
 Warning		 javadoc SummaryJavadoc Summary javadoc is missing. 38
 Warning		 javadoc SummaryJavadoc Summary javadoc is missing. 45
 Warning		 javadoc SummaryJavadoc Summary javadoc is missing. 53
 Warning		 javadoc SummaryJavadoc Summary javadoc is missing. 60
 Warning		 javadoc SummaryJavadoc Summary javadoc is missing. 68

gov/nist/secauto/swid/builder/resource/firmware/FirmwareRequirement.java

Severity Category Rule Message Line
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 33
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 37
 Warning		 javadoc SummaryJavadoc Summary javadoc is missing. 43
 Warning		 javadoc SummaryJavadoc Summary javadoc is missing. 50

gov/nist/secauto/swid/builder/resource/firmware/ResourceReference.java

Severity Category Rule Message Line
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 39
 Warning		 javadoc SummaryJavadoc Summary javadoc is missing. 49
 Warning		 javadoc SummaryJavadoc Summary javadoc is missing. 56
 Warning		 javadoc SummaryJavadoc Summary javadoc is missing. 63

gov/nist/secauto/swid/builder/resource/firmware/StringFirmwareIdentifier.java

Severity Category Rule Message Line
 Warning		 javadoc MissingJavadocMethod Missing a Javadoc comment. 38