The following document contains the results of Checkstyle. 
| Rules | Violations | Severity |
|---|---|---|
JavadocPackage
| 4 |  Error |
| NewlineAtEndOfFile | 5 | Error |
| Translation | 0 | Error |
| FileLength | 0 | Error |
FileTabCharacter
| 0 | Error |
RegexpSingleline
| 95 | Error |
| JavadocMethod | 81 | Error |
| JavadocType | 3 | Error |
| JavadocVariable | 32 | Error |
| JavadocStyle | 7 | Error |
| ConstantName | 0 | Error |
| LocalFinalVariableName | 0 | Error |
| LocalVariableName | 0 | Error |
| MemberName | 0 | Error |
| MethodName | 0 | Error |
| PackageName | 0 | Error |
| ParameterName | 0 | Error |
| StaticVariableName | 0 | Error |
| TypeName | 0 | Error |
| AvoidStarImport | 0 | Error |
| IllegalImport | 0 | Error |
| RedundantImport | 0 | Error |
| UnusedImports | 2 | Error |
| LineLength | 43 | Error |
| MethodLength | 0 | Error |
| ParameterNumber | 0 | Error |
| EmptyForIteratorPad | 0 | Error |
| MethodParamPad | 1 | Error |
| NoWhitespaceAfter | 0 | Error |
| NoWhitespaceBefore | 0 | Error |
| OperatorWrap | 0 | Error |
| ParenPad | 0 | Error |
| TypecastParenPad | 0 | Error |
| WhitespaceAfter | 0 | Error |
| WhitespaceAround | 0 | Error |
| ModifierOrder | 1 | Error |
| RedundantModifier | 2 | Error |
| AvoidNestedBlocks | 0 | Error |
| EmptyBlock | 3 | Error |
| LeftCurly | 0 | Error |
| NeedBraces | 7 | Error |
| RightCurly | 0 | Error |
| AvoidInlineConditionals | 2 | Error |
| DoubleCheckedLocking | 0 | Error |
| EmptyStatement | 0 | Error |
| EqualsHashCode | 0 | Error |
| HiddenField | 16 | Error |
| IllegalInstantiation | 0 | Error |
| InnerAssignment | 0 | Error |
| MagicNumber | 0 | Error |
| MissingSwitchDefault | 0 | Error |
| RedundantThrows | 0 | Error |
| SimplifyBooleanExpression | 0 | Error |
| SimplifyBooleanReturn | 0 | Error |
| DesignForExtension | 47 | Error |
| FinalClass | 0 | Error |
| HideUtilityClassConstructor | 0 | Error |
| InterfaceIsType | 0 | Error |
| VisibilityModifier | 0 | Error |
| ArrayTypeStyle | 0 | Error |
| FinalParameters | 28 | Error |
| TodoComment | 3 | Error |
| UpperEll | 0 | Error |
| Violation | Message | Line |
|---|---|---|
| Line has trailing spaces. | 17 |
| Line has trailing spaces. | 28 |
| Line has trailing spaces. | 32 |
| Line is longer than 80 characters. | 32 |
| Missing a Javadoc comment. | 32 |
| Line has trailing spaces. | 35 |
| Missing a Javadoc comment. | 35 |
| Line has trailing spaces. | 38 |
| Line is longer than 80 characters. | 38 |
| Missing a Javadoc comment. | 38 |
| Line has trailing spaces. | 40 |
| Line has trailing spaces. | 41 |
| Missing a Javadoc comment. | 41 |
| Violation | Message | Line |
|---|---|---|
| Line has trailing spaces. | 17 |
| Line has trailing spaces. | 22 |
| Line has trailing spaces. | 25 |
| Missing a Javadoc comment. | 26 |
| Missing a Javadoc comment. | 27 |
| Missing a Javadoc comment. | 28 |
| Missing a Javadoc comment. | 29 |
| Missing a Javadoc comment. | 31 |
| Missing a Javadoc comment. | 33 |
| Parameter isSourceRequired should be final. | 33 |
| 'isSourceRequired' hides a field. | 33 |
| Missing a Javadoc comment. | 37 |
| Violation | Message | Line |
|---|---|---|
| Line has trailing spaces. | 17 |
| Line has trailing spaces. | 24 |
| Line has trailing spaces. | 27 |
| Missing a Javadoc comment. | 27 |
| Missing a Javadoc comment. | 27 |
| Line has trailing spaces. | 28 |
| Missing a Javadoc comment. | 28 |
| Line has trailing spaces. | 29 |
| Missing a Javadoc comment. | 29 |
| Missing a Javadoc comment. | 30 |
| Line has trailing spaces. | 31 |
| First sentence should end with a period. | 32 |
| Missing a Javadoc comment. | 35 |
| Parameter name should be final. | 35 |
| 'name' hides a field. | 35 |
| Parameter directory should be final. | 52 |
| Violation | Message | Line |
|---|---|---|
| Missing package-info.java file. | 0 |
| Line has trailing spaces. | 17 |
| Line has trailing spaces. | 25 |
| Redundant 'public' modifier. | 35 |
| Violation | Message | Line |
|---|---|---|
| Line has trailing spaces. | 17 |
| First sentence should end with a period. | 29 |
| Expected @throws tag for 'IOException'. | 34 |
| Violation | Message | Line |
|---|---|---|
| Line has trailing spaces. | 17 |
| Unused import - java.io.Writer. | 23 |
| Unused import - org.jdom.JDOMException. | 31 |
| Line has trailing spaces. | 35 |
| Line has trailing spaces. | 38 |
| Missing a Javadoc comment. | 39 |
| Missing a Javadoc comment. | 40 |
| Missing a Javadoc comment. | 41 |
| Missing a Javadoc comment. | 42 |
| Line has trailing spaces. | 43 |
| Missing a Javadoc comment. | 44 |
| Method 'getWriterFactory' is not designed for extension - needs to be abstract, final or empty. | 50 |
| Expected an @return tag. | 58 |
| Method 'setWriterFactory' is not designed for extension - needs to be abstract, final or empty. | 58 |
| Parameter writerFactory should be final. | 58 |
| 'writerFactory' hides a field. | 58 |
| Method 'getEngine' is not designed for extension - needs to be abstract, final or empty. | 67 |
| Method 'setEngine' is not designed for extension - needs to be abstract, final or empty. | 76 |
| Parameter engine should be final. | 76 |
| 'engine' hides a field. | 76 |
| Method 'getSource' is not designed for extension - needs to be abstract, final or empty. | 84 |
| Expected an @return tag. | 91 |
| Method 'setSource' is not designed for extension - needs to be abstract, final or empty. | 91 |
| Parameter source should be final. | 91 |
| 'source' hides a field. | 91 |
| Method 'getLicenseDescriptor' is not designed for extension - needs to be abstract, final or empty. | 99 |
| Expected an @return tag. | 106 |
| Method 'setLicenseDescriptor' is not designed for extension - needs to be abstract, final or empty. | 106 |
| Parameter licenseDescriptor should be final. | 106 |
| 'licenseDescriptor' hides a field. | 106 |
| Method 'getAct' is not designed for extension - needs to be abstract, final or empty. | 114 |
| Expected an @return tag. | 121 |
| Method 'setAct' is not designed for extension - needs to be abstract, final or empty. | 121 |
| Parameter act should be final. | 121 |
| 'act' hides a field. | 121 |
| Line has trailing spaces. | 125 |
| Method 'act' is not designed for extension - needs to be abstract, final or empty. | 126 |
| Missing a Javadoc comment. | 126 |
| Line has trailing spaces. | 139 |
| Line has trailing spaces. | 140 |
| Line has trailing spaces. | 141 |
| Line has trailing spaces. | 144 |
| Expected an @return tag. | 146 |
| Expected an @return tag. | 154 |
| Expected @throws tag for 'Exception'. | 154 |
| Line has trailing spaces. | 158 |
| Line has trailing spaces. | 161 |
| Expected an @return tag. | 163 |
| Line is longer than 80 characters. | 164 |
| Line has trailing spaces. | 170 |
| Expected an @return tag. | 172 |
| Line is longer than 80 characters. | 173 |
| Expected an @return tag. | 181 |
| Expected @throws tag for 'IOException'. | 181 |
| Method 'toString' is not designed for extension - needs to be abstract, final or empty. | 185 |
| Line has trailing spaces. | 190 |
| Line has trailing spaces. | 195 |
| Expected an @return tag. | 197 |
| Line is longer than 80 characters. | 197 |
| Expected @param tag for 'resource'. | 197 |
| Line has trailing spaces. | 200 |
| Line has trailing spaces. | 201 |
| Expected an @return tag. | 208 |
| Line is longer than 80 characters. | 208 |
| Expected @param tag for 'resource'. | 208 |
| Expected @throws tag for 'Exception'. | 208 |
| Violation | Message | Line |
|---|---|---|
| Line has trailing spaces. | 17 |
| Line has trailing spaces. | 34 |
| Line has trailing spaces. | 37 |
| Expected an @return tag. | 41 |
| Line is longer than 80 characters. | 41 |
| Line is longer than 80 characters. | 42 |
| Line is longer than 80 characters. | 43 |
| Line is longer than 80 characters. | 54 |
| Expected @param tag for 'results'. | 54 |
| Parameter error should be final. | 55 |
| Expected @param tag for 'error'. | 55 |
| Line has trailing spaces. | 59 |
| Missing a Javadoc comment. | 60 |
| Line is longer than 80 characters. | 61 |
| Missing a Javadoc comment. | 61 |
| Line has trailing spaces. | 62 |
| Missing a Javadoc comment. | 63 |
| Line has trailing spaces. | 66 |
| Parameter directories should be final. | 71 |
| 'directories' hides a field. | 71 |
| Expected @param tag for 'directories'. | 71 |
| Method 'analyse' is not designed for extension - needs to be abstract, final or empty. | 77 |
| Missing a Javadoc comment. | 77 |
| Line has trailing spaces. | 82 |
| Line is longer than 80 characters. | 83 |
| Line is longer than 80 characters. | 88 |
| Line has trailing spaces. | 92 |
| Line is longer than 80 characters. | 93 |
| Parameter sourceAuditor should be final. | 104 |
| Expected @param tag for 'sourceAuditor'. | 104 |
| Line is longer than 80 characters. | 105 |
| Method 'isValid' is not designed for extension - needs to be abstract, final or empty. | 108 |
| Missing a Javadoc comment. | 108 |
| Line is longer than 80 characters. | 109 |
| Line has trailing spaces. | 116 |
| Line is longer than 80 characters. | 117 |
| Method 'validate' is not designed for extension - needs to be abstract, final or empty. | 117 |
| Missing a Javadoc comment. | 117 |
| Line has trailing spaces. | 124 |
| Line has trailing spaces. | 126 |
| Expected @param tag for 'collator'. | 130 |
| Line is longer than 80 characters. | 139 |
| Parameter resources should be final. | 139 |
| Expected @param tag for 'resources'. | 139 |
| Parameter error should be final. | 140 |
| Expected @param tag for 'error'. | 140 |
| Line is longer than 80 characters. | 141 |
| Line is longer than 80 characters. | 142 |
| Missing a Javadoc comment. | 146 |
| Line has trailing spaces. | 152 |
| Expected @param tag for 'directory'. | 157 |
| Expected @param tag for 'collator'. | 158 |
| Must have at least one statement. | 161 |
| Line is longer than 80 characters. | 164 |
| Line has trailing spaces. | 168 |
| Expected @param tag for 'directory'. | 173 |
| Expected @param tag for 'collator'. | 174 |
| Must have at least one statement. | 177 |
| Line is longer than 80 characters. | 180 |
| Method 'getResourcesMissingSources' is not designed for extension - needs to be abstract, final or empty. | 186 |
| Missing a Javadoc comment. | 186 |
| Line has trailing spaces. | 190 |
| Line has trailing spaces. | 191 |
| Method 'getExtraLicenses' is not designed for extension - needs to be abstract, final or empty. | 192 |
| Missing a Javadoc comment. | 192 |
| Line has trailing spaces. | 195 |
| Method 'getMissingLicenses' is not designed for extension - needs to be abstract, final or empty. | 196 |
| Missing a Javadoc comment. | 196 |
| Line has trailing spaces. | 199 |
| Method 'getDuplicates' is not designed for extension - needs to be abstract, final or empty. | 203 |
| Line is longer than 80 characters. | 207 |
| Method 'getIssues' is not designed for extension - needs to be abstract, final or empty. | 207 |
| Missing a Javadoc comment. | 207 |
| Parameter ofType should be final. | 207 |
| Line has trailing spaces. | 210 |
| Expected an @return tag. | 214 |
| Method 'toString' is not designed for extension - needs to be abstract, final or empty. | 214 |
| Violation | Message | Line |
|---|---|---|
| File does not end with a newline. | 0 |
| Line has trailing spaces. | 17 |
| Missing a Javadoc comment. | 21 |
| Missing a Javadoc comment. | 22 |
| Missing a Javadoc comment. | 23 |
| Missing a Javadoc comment. | 24 |
| Missing a Javadoc comment. | 25 |
| Line has trailing spaces. | 26 |
| Missing a Javadoc comment. | 27 |
| Line has trailing spaces. | 28 |
| Missing a Javadoc comment. | 29 |
| '(' is preceded with whitespace. | 29 |
| 'description' hides a field. | 29 |
| Line has trailing spaces. | 32 |
| Missing a Javadoc comment. | 33 |
| Violation | Message | Line |
|---|---|---|
| File does not end with a newline. | 0 |
| Line has trailing spaces. | 17 |
| Missing a Javadoc comment. | 25 |
| Line is longer than 80 characters. | 27 |
| Missing a Javadoc comment. | 27 |
| Redundant 'final' modifier. | 27 |
| 'static' modifier out of order with the JLS suggestions. | 27 |
| Line is longer than 80 characters. | 28 |
| Line is longer than 80 characters. | 39 |
| Missing a Javadoc comment. | 47 |
| Line has trailing spaces. | 48 |
| Line is longer than 80 characters. | 49 |
| Missing a Javadoc comment. | 49 |
| Line has trailing spaces. | 50 |
| Line is longer than 80 characters. | 54 |
| Parameter issues should be final. | 54 |
| 'issues' hides a field. | 54 |
| Expected @param tag for 'issues'. | 54 |
| Line is longer than 80 characters. | 62 |
| Violation | Message | Line |
|---|---|---|
| File does not end with a newline. | 0 |
| Missing package-info.java file. | 0 |
| Line has trailing spaces. | 17 |
| Missing a Javadoc comment. | 21 |
| Missing a Javadoc comment. | 22 |
| Missing a Javadoc comment. | 23 |
| Line has trailing spaces. | 24 |
| Parameter directoryName should be final. | 29 |
| Expected @param tag for 'directoryName'. | 29 |
| Parameter resourceName should be final. | 29 |
| Expected @param tag for 'resourceName'. | 29 |
| Method 'getDirectory' is not designed for extension - needs to be abstract, final or empty. | 38 |
| Method 'getResource' is not designed for extension - needs to be abstract, final or empty. | 45 |
| Expected an @return tag. | 52 |
| Method 'hashCode' is not designed for extension - needs to be abstract, final or empty. | 52 |
| Avoid inline conditionals. | 57 |
| Avoid inline conditionals. | 59 |
| Expected an @return tag. | 66 |
| Method 'equals' is not designed for extension - needs to be abstract, final or empty. | 66 |
| Parameter obj should be final. | 67 |
| Expected @param tag for 'obj'. | 67 |
| 'if' construct must use '{}'s. | 68 |
| 'if' construct must use '{}'s. | 70 |
| 'if' construct must use '{}'s. | 72 |
| 'if' construct must use '{}'s. | 76 |
| 'if' construct must use '{}'s. | 78 |
| 'if' construct must use '{}'s. | 81 |
| 'if' construct must use '{}'s. | 83 |
| Expected an @return tag. | 91 |
| Method 'toString' is not designed for extension - needs to be abstract, final or empty. | 91 |
| Expected an @return tag. | 100 |
| Method 'compareTo' is not designed for extension - needs to be abstract, final or empty. | 100 |
| Parameter other should be final. | 100 |
| Expected @param tag for 'other'. | 100 |
| Line is longer than 80 characters. | 102 |
| Line has trailing spaces. | 110 |
| Line has trailing spaces. | 111 |
| Violation | Message | Line |
|---|---|---|
| Line has trailing spaces. | 17 |
| Line has trailing spaces. | 33 |
| Missing a Javadoc comment. | 37 |
| Missing a Javadoc comment. | 38 |
| Line has trailing spaces. | 39 |
| Line has trailing spaces. | 40 |
| Line is longer than 80 characters. | 40 |
| Missing a Javadoc comment. | 40 |
| Line has trailing spaces. | 42 |
| Line has trailing spaces. | 43 |
| Line is longer than 80 characters. | 43 |
| Missing a Javadoc comment. | 43 |
| Line has trailing spaces. | 45 |
| Expected an @return tag. | 49 |
| Method 'traversePublicDomain' is not designed for extension - needs to be abstract, final or empty. | 49 |
| Comment matches to-do format 'TODO:'. | 51 |
| Line has trailing spaces. | 51 |
| Comment matches to-do format 'TODO:'. | 52 |
| Line has trailing spaces. | 52 |
| Line has trailing spaces. | 56 |
| Line is longer than 80 characters. | 60 |
| Method 'getResourcesWithSource' is not designed for extension - needs to be abstract, final or empty. | 60 |
| Line is longer than 80 characters. | 67 |
| Method 'getResourcesMissingSource' is not designed for extension - needs to be abstract, final or empty. | 67 |
| Method 'visit' is not designed for extension - needs to be abstract, final or empty. | 74 |
| Parameter directory should be final. | 75 |
| Expected @param tag for 'directory'. | 75 |
| Method 'visit' is not designed for extension - needs to be abstract, final or empty. | 84 |
| Parameter license should be final. | 85 |
| Expected @param tag for 'license'. | 85 |
| Method 'visit' is not designed for extension - needs to be abstract, final or empty. | 92 |
| Parameter resource should be final. | 93 |
| Expected @param tag for 'resource'. | 93 |
| Line is longer than 80 characters. | 95 |
| Comment matches to-do format 'TODO:'. | 97 |
| Line is longer than 80 characters. | 98 |
| Must have at least one statement. | 104 |
| Expected an @return tag. | 113 |
| Method 'getResourcesRequiringSourceLinks' is not designed for extension - needs to be abstract, final or empty. | 113 |
| Line has trailing spaces. | 120 |
| Violation | Message | Line |
|---|---|---|
| File does not end with a newline. | 0 |
| Line has trailing spaces. | 17 |
| First sentence should end with a period. | 31 |
| Line is longer than 80 characters. | 31 |
| Line has trailing spaces. | 33 |
| Line has trailing spaces. | 37 |
| Parameter name should be final. | 41 |
| 'name' hides a field. | 41 |
| Line has trailing spaces. | 46 |
| Method 'getName' is not designed for extension - needs to be abstract, final or empty. | 51 |
| Expected an @return tag. | 60 |
| Method 'open' is not designed for extension - needs to be abstract, final or empty. | 60 |
| Expected @throws tag for 'IOException'. | 61 |
| Line has trailing spaces. | 64 |
| Method 'toString' is not designed for extension - needs to be abstract, final or empty. | 65 |
| Violation | Message | Line |
|---|---|---|
| File does not end with a newline. | 0 |
| Line has trailing spaces. | 17 |
| Line has trailing spaces. | 29 |
| First sentence should end with a period. | 33 |
| First sentence should end with a period. | 36 |
| Line is longer than 80 characters. | 37 |
| Line is longer than 80 characters. | 38 |
| Unused @param tag for 'fileName,'. | 38 |
| Parameter fileName should be final. | 41 |
| 'fileName' hides a field. | 41 |
| Expected @param tag for 'fileName'. | 41 |
| Line has trailing spaces. | 46 |
| Method 'getFileName' is not designed for extension - needs to be abstract, final or empty. | 50 |
| Expected an @return tag. | 57 |
| Method 'open' is not designed for extension - needs to be abstract, final or empty. | 57 |
| Expected @throws tag for 'IOException'. | 58 |
| Method 'toString' is not designed for extension - needs to be abstract, final or empty. | 62 |
| Violation | Message | Line |
|---|---|---|
| Missing package-info.java file. | 0 |
| Line has trailing spaces. | 17 |
| First sentence should end with a period. | 34 |
| Line has trailing spaces. | 36 |
| Parameter file should be final. | 41 |
| 'file' hides a field. | 41 |
| Expected an @return tag. | 49 |
| Method 'open' is not designed for extension - needs to be abstract, final or empty. | 49 |
| Expected @throws tag for 'IOException'. | 50 |
| Method 'toString' is not designed for extension - needs to be abstract, final or empty. | 59 |
| Violation | Message | Line |
|---|---|---|
| Line has trailing spaces. | 17 |
| Line has trailing spaces. | 33 |
| Method 'streamFromClassPathResource' is not designed for extension - needs to be abstract, final or empty. | 36 |
| Line has trailing spaces. | 37 |
| Line has trailing spaces. | 39 |
| Line is longer than 80 characters. | 41 |
| Line has trailing spaces. | 43 |
| Method 'streamFromFileResource' is not designed for extension - needs to be abstract, final or empty. | 46 |
| Line has trailing spaces. | 49 |
| Line is longer than 80 characters. | 51 |
| Line has trailing spaces. | 53 |
| Method 'streamFromFileResource' is not designed for extension - needs to be abstract, final or empty. | 56 |
| Violation | Message | Line |
|---|---|---|
| Line has trailing spaces. | 17 |
| Missing a Javadoc comment. | 35 |
| Missing a Javadoc comment. | 36 |
| Line is longer than 80 characters. | 38 |
| Missing a Javadoc comment. | 38 |
| 'directory' hides a field. | 38 |
| 'encoding' hides a field. | 38 |
| Expected an @return tag. | 47 |
| Method 'writerFor' is not designed for extension - needs to be abstract, final or empty. | 47 |
| Parameter result should be final. | 47 |
| Expected @param tag for 'result'. | 47 |
| Expected @throws tag for 'IOException'. | 47 |
| Line is longer than 80 characters. | 48 |
| Violation | Message | Line |
|---|---|---|
| Missing package-info.java file. | 0 |
| Line has trailing spaces. | 17 |
| First sentence should end with a period. | 34 |
| Line has trailing spaces. | 36 |
| Missing a Javadoc comment. | 37 |
| Parameter encoding should be final. | 37 |
| 'encoding' hides a field. | 37 |
| Missing a Javadoc comment. | 42 |
| Expected an @return tag. | 49 |
| Method 'writerFor' is not designed for extension - needs to be abstract, final or empty. | 49 |
| Parameter result should be final. | 49 |
| Expected @param tag for 'result'. | 49 |
| Expected @throws tag for 'IOException'. | 49 |
