The following document contains the results of Checkstyle 7.2 with sun_checks.xml ruleset. 
| File |  I |
 W |
 E |
|---|---|---|---|
| org/apache/streams/console/ConsolePersistReader.java | 0 | 0 | 26 |
| org/apache/streams/console/ConsolePersistWriter.java | 0 | 0 | 18 |
| org/apache/streams/console/ConsolePersistWriterTask.java | 0 | 0 | 11 |
| Category | Rule | Violations | Severity |
|---|---|---|---|
| coding | HiddenField | 3 | Error |
| MagicNumber | 1 | Error | |
| design | DesignForExtension | 10 | Error |
| VisibilityModifier | 3 | Error | |
| javadoc | JavadocMethod | 9 | Error |
| JavadocPackage | 1 | Error | |
| JavadocStyle | 1 | Error | |
| JavadocVariable | 11 | Error | |
| misc | FinalParameters | 9 | Error |
| sizes | LineLength | 3 | Error |
| whitespace | ParenPad | 4 | Error |
| Severity | Category | Rule | Message | Line |
|---|---|---|---|---|
| Error |
javadoc | JavadocPackage | Missing package-info.java file. | |
| Error |
javadoc | JavadocVariable | Missing a Javadoc comment. | 40 |
| Error |
sizes | LineLength | Line is longer than 80 characters (found 91). | 42 |
| Error |
javadoc | JavadocVariable | Missing a Javadoc comment. | 42 |
| Error |
javadoc | JavadocVariable | Missing a Javadoc comment. | 44 |
| Error |
design | VisibilityModifier | Variable 'persistQueue' must be private and have accessor methods. | 44 |
| Error |
javadoc | JavadocVariable | Missing a Javadoc comment. | 46 |
| Error |
design | VisibilityModifier | Variable 'inputStream' must be private and have accessor methods. | 46 |
| Error |
javadoc | JavadocMethod | Missing a Javadoc comment. | 48 |
| Error |
javadoc | JavadocMethod | Missing a Javadoc comment. | 52 |
| Error |
misc | FinalParameters | Parameter inputStream should be final. | 52 |
| Error |
coding | HiddenField | 'inputStream' hides a field. | 52 |
| Error |
design | DesignForExtension | Class 'ConsolePersistReader' looks like designed for extension (can be subclassed), but the method 'getId' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'ConsolePersistReader' final or making the method 'getId' static/final/abstract/empty, or adding allowed annotation for the method. | 57 |
| Error |
javadoc | JavadocMethod | Missing a Javadoc comment. | 62 |
| Error |
misc | FinalParameters | Parameter configuration should be final. | 62 |
| Error |
javadoc | JavadocMethod | Missing a Javadoc comment. | 66 |
| Error |
design | DesignForExtension | Class 'ConsolePersistReader' looks like designed for extension (can be subclassed), but the method 'readAll' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'ConsolePersistReader' final or making the method 'readAll' static/final/abstract/empty, or adding allowed annotation for the method. | 75 |
| Error |
design | DesignForExtension | Class 'ConsolePersistReader' looks like designed for extension (can be subclassed), but the method 'readCurrent' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'ConsolePersistReader' final or making the method 'readCurrent' static/final/abstract/empty, or adding allowed annotation for the method. | 80 |
| Error |
whitespace | ParenPad | '(' is followed by whitespace. | 87 |
| Error |
whitespace | ParenPad | ')' is preceded with whitespace. | 87 |
| Error |
design | DesignForExtension | Class 'ConsolePersistReader' looks like designed for extension (can be subclassed), but the method 'readNew' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'ConsolePersistReader' final or making the method 'readNew' static/final/abstract/empty, or adding allowed annotation for the method. | 103 |
| Error |
misc | FinalParameters | Parameter sequence should be final. | 104 |
| Error |
design | DesignForExtension | Class 'ConsolePersistReader' looks like designed for extension (can be subclassed), but the method 'readRange' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'ConsolePersistReader' final or making the method 'readRange' static/final/abstract/empty, or adding allowed annotation for the method. | 108 |
| Error |
misc | FinalParameters | Parameter start should be final. | 109 |
| Error |
misc | FinalParameters | Parameter end should be final. | 109 |
| Error |
design | DesignForExtension | Class 'ConsolePersistReader' looks like designed for extension (can be subclassed), but the method 'isRunning' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'ConsolePersistReader' final or making the method 'isRunning' static/final/abstract/empty, or adding allowed annotation for the method. | 113 |
| Severity | Category | Rule | Message | Line |
|---|---|---|---|---|
| Error |
javadoc | JavadocVariable | Missing a Javadoc comment. | 40 |
| Error |
sizes | LineLength | Line is longer than 80 characters (found 91). | 42 |
| Error |
javadoc | JavadocVariable | Missing a Javadoc comment. | 42 |
| Error |
javadoc | JavadocVariable | Missing a Javadoc comment. | 44 |
| Error |
javadoc | JavadocVariable | Missing a Javadoc comment. | 46 |
| Error |
design | VisibilityModifier | Variable 'persistQueue' must be private and have accessor methods. | 46 |
| Error |
javadoc | JavadocVariable | Missing a Javadoc comment. | 48 |
| Error |
javadoc | JavadocMethod | Missing a Javadoc comment. | 50 |
| Error |
javadoc | JavadocMethod | Missing a Javadoc comment. | 54 |
| Error |
misc | FinalParameters | Parameter printStream should be final. | 54 |
| Error |
coding | HiddenField | 'printStream' hides a field. | 54 |
| Error |
design | DesignForExtension | Class 'ConsolePersistWriter' looks like designed for extension (can be subclassed), but the method 'getId' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'ConsolePersistWriter' final or making the method 'getId' static/final/abstract/empty, or adding allowed annotation for the method. | 59 |
| Error |
design | DesignForExtension | Class 'ConsolePersistWriter' looks like designed for extension (can be subclassed), but the method 'prepare' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'ConsolePersistWriter' final or making the method 'prepare' static/final/abstract/empty, or adding allowed annotation for the method. | 64 |
| Error |
javadoc | JavadocMethod | Missing a Javadoc comment. | 64 |
| Error |
misc | FinalParameters | Parameter configuration should be final. | 64 |
| Error |
javadoc | JavadocMethod | Missing a Javadoc comment. | 68 |
| Error |
design | DesignForExtension | Class 'ConsolePersistWriter' looks like designed for extension (can be subclassed), but the method 'write' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'ConsolePersistWriter' final or making the method 'write' static/final/abstract/empty, or adding allowed annotation for the method. | 72 |
| Error |
misc | FinalParameters | Parameter entry should be final. | 73 |
| Severity | Category | Rule | Message | Line |
|---|---|---|---|---|
| Error |
javadoc | JavadocStyle | First sentence should end with a period. | 28 |
| Error |
sizes | LineLength | Line is longer than 80 characters (found 95). | 34 |
| Error |
javadoc | JavadocVariable | Missing a Javadoc comment. | 34 |
| Error |
javadoc | JavadocVariable | Missing a Javadoc comment. | 36 |
| Error |
javadoc | JavadocMethod | Missing a Javadoc comment. | 38 |
| Error |
misc | FinalParameters | Parameter writer should be final. | 38 |
| Error |
coding | HiddenField | 'writer' hides a field. | 38 |
| Error |
design | DesignForExtension | Class 'ConsolePersistWriterTask' looks like designed for extension (can be subclassed), but the method 'run' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'ConsolePersistWriterTask' final or making the method 'run' static/final/abstract/empty, or adding allowed annotation for the method. | 42 |
| Error |
whitespace | ParenPad | '(' is followed by whitespace. | 45 |
| Error |
whitespace | ParenPad | ')' is preceded with whitespace. | 45 |
| Error |
coding | MagicNumber | '100' is a magic number. | 54 |