The following document contains the results of Checkstyle. 
| Rules | Violations | Severity |
|---|---|---|
JavadocPackage
| 0 |  Error |
| NewlineAtEndOfFile | 2 | Error |
| Translation | 0 | Error |
| FileLength | 0 | Error |
FileTabCharacter
| 0 | Error |
RegexpSingleline
| 0 | Error |
| JavadocMethod | 3 | Error |
| JavadocType | 0 | Error |
| JavadocVariable | 0 | Error |
| JavadocStyle | 5 | Error |
| ConstantName | 0 | Error |
| LocalFinalVariableName | 0 | Error |
| LocalVariableName | 0 | Error |
| MemberName | 0 | Error |
| MethodName | 0 | Error |
| PackageName | 0 | Error |
| ParameterName | 0 | Error |
| StaticVariableName | 1 | Error |
| TypeName | 0 | Error |
| AvoidStarImport | 2 | Error |
| IllegalImport | 0 | Error |
| RedundantImport | 0 | Error |
| UnusedImports | 0 | Error |
| LineLength | 17 | Error |
| MethodLength | 0 | Error |
| ParameterNumber | 0 | Error |
| EmptyForIteratorPad | 0 | Error |
| MethodParamPad | 0 | Error |
| NoWhitespaceAfter | 0 | Error |
| NoWhitespaceBefore | 0 | Error |
| OperatorWrap | 2 | Error |
| ParenPad | 0 | Error |
| TypecastParenPad | 0 | Error |
| WhitespaceAfter | 0 | Error |
| WhitespaceAround | 0 | Error |
| ModifierOrder | 0 | Error |
| RedundantModifier | 0 | Error |
| AvoidNestedBlocks | 0 | Error |
| EmptyBlock | 3 | Error |
| LeftCurly | 0 | Error |
| NeedBraces | 0 | Error |
| RightCurly | 0 | Error |
| AvoidInlineConditionals | 2 | Error |
| DoubleCheckedLocking | 0 | Error |
| EmptyStatement | 0 | Error |
| EqualsHashCode | 0 | Error |
| HiddenField | 18 | Error |
| IllegalInstantiation | 0 | Error |
| InnerAssignment | 0 | Error |
| MagicNumber | 0 | Error |
| MissingSwitchDefault | 0 | Error |
| RedundantThrows | 0 | Error |
| SimplifyBooleanExpression | 0 | Error |
| SimplifyBooleanReturn | 0 | Error |
| DesignForExtension | 20 | Error |
| FinalClass | 1 | Error |
| HideUtilityClassConstructor | 0 | Error |
| InterfaceIsType | 0 | Error |
| VisibilityModifier | 1 | Error |
| ArrayTypeStyle | 0 | Error |
| FinalParameters | 4 | Error |
| TodoComment | 0 | Error |
| UpperEll | 0 | Error |
| Violation | Message | Line |
|---|---|---|
| Line is longer than 80 characters. | 42 |
| Line is longer than 80 characters. | 53 |
| Line is longer than 80 characters. | 65 |
| Line is longer than 80 characters. | 76 |
| Violation | Message | Line |
|---|---|---|
| 'includeSourceUrlsInLicense' hides a field. | 36 |
| Method 'includeSourceURLsInLicense' is not designed for extension - needs to be abstract, final or empty. | 44 |
| Expected an @return tag. | 52 |
| Method 'toString' is not designed for extension - needs to be abstract, final or empty. | 52 |
| Violation | Message | Line |
|---|---|---|
| Class ConfigurationBuilder should be declared as final. | 24 |
| Line is longer than 80 characters. | 79 |
| Line is longer than 80 characters. | 80 |
| Violation | Message | Line |
|---|---|---|
| First sentence should end with a period. | 21 |
| First sentence should end with a period. | 25 |
| Line is longer than 80 characters. | 33 |
| Name 'DEFAULT_LICENSE_CONFIGURATION' must match pattern '^[a-z][a-zA-Z0-9]*$'. | 33 |
| Variable 'DEFAULT_LICENSE_CONFIGURATION' must be private and have accessor methods. | 33 |
| Line is longer than 80 characters. | 40 |
| Violation | Message | Line |
|---|---|---|
| Using the '.*' form of import should be avoided - org.apache.creadur.whisker.app.LicenseConfiguration.*. | 21 |
| Using the '.*' form of import should be avoided - org.apache.creadur.whisker.app.ConfigurationBuilder.*. | 22 |
| First sentence should end with a period. | 50 |
| Line is longer than 80 characters. | 51 |
| Method 'getLicenseConfiguration' is not designed for extension - needs to be abstract, final or empty. | 57 |
| Line is longer than 80 characters. | 66 |
| Method 'setLicenseConfiguration' is not designed for extension - needs to be abstract, final or empty. | 66 |
| 'licenseConfiguration' hides a field. | 66 |
| Line is longer than 80 characters. | 84 |
| 'writerFactory' hides a field. | 84 |
| 'engine' hides a field. | 102 |
| First sentence should end with a period. | 115 |
| 'source' hides a field. | 120 |
| Line is longer than 80 characters. | 137 |
| Parameter licenseDescriptor should be final. | 137 |
| 'licenseDescriptor' hides a field. | 137 |
| Parameter act should be final. | 155 |
| 'act' hides a field. | 155 |
| Method 'act' is not designed for extension - needs to be abstract, final or empty. | 165 |
| Method 'configuration' is not designed for extension - needs to be abstract, final or empty. | 193 |
| Line is longer than 80 characters. | 213 |
| Line is longer than 80 characters. | 223 |
| Method 'toString' is not designed for extension - needs to be abstract, final or empty. | 240 |
| Line is longer than 80 characters. | 253 |
| Expected @throws tag for 'IOException'. | 253 |
| Line is longer than 80 characters. | 264 |
| Violation | Message | Line |
|---|---|---|
| File does not end with a newline. | 0 |
| ':' should be on a new line. | 48 |
| Parameter error should be final. | 64 |
| 'directories' hides a field. | 85 |
| Method 'analyse' is not designed for extension - needs to be abstract, final or empty. | 96 |
| Method 'isValid' is not designed for extension - needs to be abstract, final or empty. | 138 |
| ':' should be on a new line. | 139 |
| Method 'validate' is not designed for extension - needs to be abstract, final or empty. | 154 |
| Must have at least one statement. | 217 |
| Must have at least one statement. | 238 |
| Method 'getResourcesMissingSources' is not designed for extension - needs to be abstract, final or empty. | 253 |
| Method 'getExtraLicenses' is not designed for extension - needs to be abstract, final or empty. | 261 |
| Method 'getMissingLicenses' is not designed for extension - needs to be abstract, final or empty. | 269 |
| Method 'getDuplicates' is not designed for extension - needs to be abstract, final or empty. | 277 |
| Method 'getIssues' is not designed for extension - needs to be abstract, final or empty. | 286 |
| Parameter ofType should be final. | 287 |
| Method 'toString' is not designed for extension - needs to be abstract, final or empty. | 296 |
| Violation | Message | Line |
|---|---|---|
| First sentence should end with a period. | 27 |
| 'description' hides a field. | 41 |
| Violation | Message | Line |
|---|---|---|
| 'issues' hides a field. | 83 |
| Violation | Message | Line |
|---|---|---|
| File does not end with a newline. | 0 |
| Method 'hashCode' is not designed for extension - needs to be abstract, final or empty. | 63 |
| Avoid inline conditionals. | 68 |
| Avoid inline conditionals. | 70 |
| Method 'equals' is not designed for extension - needs to be abstract, final or empty. | 80 |
| Method 'toString' is not designed for extension - needs to be abstract, final or empty. | 114 |
| Method 'compareTo' is not designed for extension - needs to be abstract, final or empty. | 126 |
| Line is longer than 80 characters. | 128 |
| Violation | Message | Line |
|---|---|---|
| Must have at least one statement. | 123 |
| Violation | Message | Line |
|---|---|---|
| 'name' hides a field. | 44 |
| Violation | Message | Line |
|---|---|---|
| 'fileName' hides a field. | 46 |
| Violation | Message | Line |
|---|---|---|
| 'file' hides a field. | 41 |
| Violation | Message | Line |
|---|---|---|
| Expected @param tag for 'resourceName'. | 71 |
