Checkstyle Results

The following document contains the results of Checkstyle. rss feed

Summary

FilesInfos InfosWarnings WarningsErrors Errors
160098

Files

FilesI InfosW WarningsE Errors
uk/ac/cam/spectra/CMLType.java009
uk/ac/cam/spectra/Combine.java001
uk/ac/cam/spectra/Constants.java006
uk/ac/cam/spectra/DataFileException.java004
uk/ac/cam/spectra/DataFileType.java005
uk/ac/cam/spectra/DataProcess.java0010
uk/ac/cam/spectra/DateProperty.java005
uk/ac/cam/spectra/EmbargoMetadataEncoder.java004
uk/ac/cam/spectra/IntegerProperty.java004
uk/ac/cam/spectra/LiteralProperty.java0018
uk/ac/cam/spectra/MetadataProperty.java0010
uk/ac/cam/spectra/SpectraMetadata.java0013
uk/ac/cam/spectra/Util.java003
uk/ac/cam/spectra/Validation.java005
uk/ac/cam/spectra/package.html001

Rules

RulesViolationsSeverity
PackageHtml1Errors Error
JavadocType0Errors Error
JavadocMethod
  • allowThrowsTagsForSubclasses: "true"
  • allowUndeclaredRTE: "false"
  • scope: "package"
  • allowMissingPropertyJavadoc: "true"
60Errors Error
JavadocVariable
  • scope: "package"
21Errors Error
JavadocStyle
  • checkEmptyJavadoc: "true"
9Errors Error
PackageName
  • format: "^uk\.ac\.cam\..*$"
0Errors Error
AvoidStarImport0Errors Error
RedundantImport0Errors Error
UnusedImports0Errors Error
ParameterNumber0Errors Error
NeedBraces4Errors Error
CovariantEquals0Errors Error
DoubleCheckedLocking0Errors Error
EqualsHashCode0Errors Error
HiddenField
  • ignoreConstructorParameter: "true"
  • ignoreSetter: "true"
0Errors Error
IllegalInstantiation
  • classes: "java.lang.Boolean"
0Errors Error
InnerAssignment0Errors Error
MagicNumber
  • ignoreNumbers: "0, -1, 1"
2Errors Error
StringLiteralEquality0Errors Error
PackageDeclaration0Errors Error
MultipleStringLiterals
  • allowedDuplicates: "2"
1Errors Error
HideUtilityClassConstructor0Errors Error

Details

uk/ac/cam/spectra/CMLType.java

ViolationMessageLine
ErrorsExpected @param tag for 'process'.41
Errors'200' is a magic number.97
ErrorsExpected an @return tag.108
ErrorsExpected @param tag for 'doc'.108
ErrorsExpected an @return tag.132
ErrorsExpected @param tag for 'mol'.132
ErrorsFirst sentence should end with a period.169
ErrorsFirst sentence should end with a period.178
ErrorsExpected @param tag for 'fileName'.183

uk/ac/cam/spectra/Combine.java

ViolationMessageLine
ErrorsFirst sentence should end with a period.3

uk/ac/cam/spectra/Constants.java

ViolationMessageLine
ErrorsMissing a Javadoc comment.45
ErrorsMissing a Javadoc comment.47
ErrorsMissing a Javadoc comment.86
ErrorsMissing a Javadoc comment.88
ErrorsMissing a Javadoc comment.90
ErrorsMissing a Javadoc comment.92

uk/ac/cam/spectra/DataFileException.java

ViolationMessageLine
ErrorsMissing a Javadoc comment.14
ErrorsMissing a Javadoc comment.18
ErrorsMissing a Javadoc comment.22
ErrorsMissing a Javadoc comment.26

uk/ac/cam/spectra/DataFileType.java

ViolationMessageLine
ErrorsExpected @param tag for 'process'.24
ErrorsFirst sentence should end with a period.26
ErrorsExpected an @return tag.34
ErrorsExpected @param tag for 'fileName'.34
ErrorsExpected an @return tag.41

uk/ac/cam/spectra/DataProcess.java

ViolationMessageLine
ErrorsJavadoc has empty description section.45
ErrorsExpected an @return tag.59
ErrorsExpected an @return tag.88
ErrorsExpected an @return tag.97
ErrorsExpected an @return tag.106
ErrorsExpected @param tag for 'convertedCml'.118
ErrorsExpected @param tag for 'extractedMetadata'.128
ErrorsExpected @param tag for 'metadataPackageUri'.138
ErrorsExpected @param tag for 'performConversion'.146
ErrorsExpected @param tag for 'performExtraction'.154

uk/ac/cam/spectra/DateProperty.java

ViolationMessageLine
ErrorsJavadoc has empty description section.21
ErrorsMissing a Javadoc comment.27
ErrorsMissing a Javadoc comment.36
ErrorsMissing a Javadoc comment.49
ErrorsMissing a Javadoc comment.59

uk/ac/cam/spectra/EmbargoMetadataEncoder.java

ViolationMessageLine
ErrorsExpected an @return tag.56
ErrorsExpected @param tag for 'm'.56
ErrorsExpected @param tag for 'uri'.56
ErrorsThe String "Could not parse configured machine readable license as XML: " appears 6 times in the file.111

uk/ac/cam/spectra/IntegerProperty.java

ViolationMessageLine
ErrorsMissing a Javadoc comment.21
ErrorsMissing a Javadoc comment.30
ErrorsMissing a Javadoc comment.46
ErrorsMissing a Javadoc comment.51

uk/ac/cam/spectra/LiteralProperty.java

ViolationMessageLine
ErrorsJavadoc has empty description section.21
ErrorsMissing a Javadoc comment.28
ErrorsMissing a Javadoc comment.30
ErrorsMissing a Javadoc comment.32
ErrorsExpected an @return tag.48
ErrorsMissing a Javadoc comment.52
ErrorsMissing a Javadoc comment.63
ErrorsJavadoc has empty description section.71
ErrorsExpected an @return tag.77
ErrorsMissing a Javadoc comment.97
ErrorsMissing a Javadoc comment.101
ErrorsMissing a Javadoc comment.106
ErrorsMissing a Javadoc comment.110
ErrorsMissing a Javadoc comment.120
Errors'if' construct must use '{}'s.133
Errors'if' construct must use '{}'s.135
Errors'if' construct must use '{}'s.138
Errors'if' construct must use '{}'s.140

uk/ac/cam/spectra/MetadataProperty.java

ViolationMessageLine
ErrorsExpected an @return tag.25
ErrorsExpected an @return tag.32
ErrorsExpected an @return tag.39
ErrorsExpected an @return tag.47
ErrorsMissing a Javadoc comment.49
ErrorsMissing a Javadoc comment.51
ErrorsMissing a Javadoc comment.53
ErrorsMissing a Javadoc comment.55
ErrorsMissing a Javadoc comment.57
ErrorsMissing a Javadoc comment.59

uk/ac/cam/spectra/SpectraMetadata.java

ViolationMessageLine
ErrorsMissing a Javadoc comment.16
ErrorsMissing a Javadoc comment.19
ErrorsMissing a Javadoc comment.22
ErrorsMissing a Javadoc comment.25
ErrorsMissing a Javadoc comment.28
ErrorsMissing a Javadoc comment.31
ErrorsMissing a Javadoc comment.34
ErrorsMissing a Javadoc comment.37
ErrorsMissing a Javadoc comment.40
ErrorsMissing a Javadoc comment.43
ErrorsMissing a Javadoc comment.46
ErrorsMissing a Javadoc comment.49
ErrorsMissing a Javadoc comment.52

uk/ac/cam/spectra/Util.java

ViolationMessageLine
ErrorsUnused @throws tag for 'RuntimeException'.154
ErrorsUnused @throws tag for 'IOException'.184
ErrorsMissing a Javadoc comment.236

uk/ac/cam/spectra/Validation.java

ViolationMessageLine
ErrorsJavadoc has empty description section.15
ErrorsMissing a Javadoc comment.24
ErrorsMissing a Javadoc comment.28
ErrorsMissing a Javadoc comment.40
Errors'250' is a magic number.41

uk/ac/cam/spectra/package.html

ViolationMessageLine
ErrorsMissing package documentation file.0