Checkstyle Results
The following document contains the results of Checkstyle 9.3 with sun_checks.xml ruleset.
Summary
| Files |  Info |
 Warnings |
 Errors |
|---|---|---|---|
| 4 | 0 | 0 | 14 |
Files
Rules
| Category | Rule | Violations | Severity |
|---|---|---|---|
| design | DesignForExtension | 1 | Error |
| HideUtilityClassConstructor | 1 | Error | |
| javadoc | JavadocPackage | 3 | Error |
| JavadocVariable | 2 | Error | |
| MissingJavadocMethod | 2 | Error | |
| misc | FinalParameters | 2 | Error |
| NewlineAtEndOfFile | 1 | Error | |
| naming | ConstantName | 1 | Error |
| sizes | LineLength
|
1 | Error |
Details
com/lucidtech/puttingalltogether/PuttingAllTogetherApplication.java
| Severity | Category | Rule | Message | Line |
|---|---|---|---|---|
| Error |
javadoc | JavadocPackage | Missing package-info.java file. | 1 |
| Error |
design | HideUtilityClassConstructor | Utility classes should not have a public or default constructor. | 6 |
| Error |
javadoc | MissingJavadocMethod | Missing a Javadoc comment. | 8 |
| Error |
misc | FinalParameters | Parameter args should be final. | 8 |
com/lucidtech/puttingalltogether/controller/GreetingController.java
| Severity | Category | Rule | Message | Line |
|---|---|---|---|---|
| Error |
javadoc | JavadocPackage | Missing package-info.java file. | 1 |
| Error |
javadoc | JavadocVariable | Missing a Javadoc comment. | 15 |
| Error |
naming | ConstantName | Name 'template' must match pattern '^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$'. | 15 |
| Error |
javadoc | JavadocVariable | Missing a Javadoc comment. | 16 |
| Error |
design | DesignForExtension | Class 'GreetingController' looks like designed for extension (can be subclassed), but the method 'greeting' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'GreetingController' final or making the method 'greeting' static/final/abstract/empty, or adding allowed annotation for the method. | 18 |
| Error |
javadoc | MissingJavadocMethod | Missing a Javadoc comment. | 18 |
| Error |
sizes | LineLength | Line is longer than 80 characters (found 97). | 19 |
| Error |
misc | FinalParameters | Parameter name should be final. | 19 |
com/lucidtech/puttingalltogether/model/Greeting.java
| Severity | Category | Rule | Message | Line |
|---|---|---|---|---|
| Error |
misc | NewlineAtEndOfFile | File does not end with a newline. | 1 |
| Error |
javadoc | JavadocPackage | Missing package-info.java file. | 1 |