The following document contains the results of Checkstyle 7.2 with sun_checks.xml ruleset. 
| Category | Rule | Violations | Severity |
|---|---|---|---|
| blocks | LeftCurly | 1 |  Error |
| coding | HiddenField | 17 | Error |
| MagicNumber | 3 | Error | |
| SimplifyBooleanExpression | 1 | Error | |
| design | DesignForExtension | 30 | Error |
| VisibilityModifier | 3 | Error | |
| javadoc | JavadocMethod | 17 | Error |
| JavadocPackage | 2 | Error | |
| JavadocStyle | 15 | Error | |
| JavadocType | 1 | Error | |
| JavadocVariable | 20 | Error | |
| misc | FinalParameters | 29 | Error |
| regexp | RegexpSingleline
|
12 | Error |
| sizes | LineLength | 20 | Error |
| whitespace | ParenPad | 3 | Error |
| WhitespaceAfter | 3 | Error |
| Severity | Category | Rule | Message | Line |
|---|---|---|---|---|
| Error |
javadoc | JavadocPackage | Missing package-info.java file. | |
| Error |
javadoc | JavadocType | Missing a Javadoc comment. | 18 |
| Error |
blocks | LeftCurly | '{' at column 1 should be on the previous line. | 27 |
| Error |
javadoc | JavadocStyle | First sentence should end with a period. | 29 |
| Error |
regexp | RegexpSingleline | Line has trailing spaces. | 31 |
| Error |
javadoc | JavadocStyle | First sentence should end with a period. | 35 |
| Error |
regexp | RegexpSingleline | Line has trailing spaces. | 37 |
| Error |
javadoc | JavadocStyle | First sentence should end with a period. | 41 |
| Error |
regexp | RegexpSingleline | Line has trailing spaces. | 43 |
| Error |
javadoc | JavadocStyle | First sentence should end with a period. | 47 |
| Error |
regexp | RegexpSingleline | Line has trailing spaces. | 49 |
| Error |
javadoc | JavadocVariable | Missing a Javadoc comment. | 53 |
| Error |
sizes | LineLength | Line is longer than 80 characters (found 85). | 54 |
| Error |
javadoc | JavadocStyle | First sentence should end with a period. | 56 |
| Error |
regexp | RegexpSingleline | Line has trailing spaces. | 58 |
| Error |
javadoc | JavadocStyle | First sentence should end with a period. | 67 |
| Error |
regexp | RegexpSingleline | Line has trailing spaces. | 69 |
| Error |
misc | FinalParameters | Parameter brokerlist should be final. | 74 |
| Error |
coding | HiddenField | 'brokerlist' hides a field. | 74 |
| Error |
design | DesignForExtension | Class 'KafkaConfiguration' looks like designed for extension (can be subclassed), but the method 'withBrokerlist' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'KafkaConfiguration' final or making the method 'withBrokerlist' static/final/abstract/empty, or adding allowed annotation for the method. | 78 |
| Error |
javadoc | JavadocMethod | Missing a Javadoc comment. | 78 |
| Error |
misc | FinalParameters | Parameter brokerlist should be final. | 78 |
| Error |
coding | HiddenField | 'brokerlist' hides a field. | 78 |
| Error |
javadoc | JavadocStyle | First sentence should end with a period. | 83 |
| Error |
regexp | RegexpSingleline | Line has trailing spaces. | 85 |
| Error |
javadoc | JavadocStyle | First sentence should end with a period. | 94 |
| Error |
regexp | RegexpSingleline | Line has trailing spaces. | 96 |
| Error |
misc | FinalParameters | Parameter zkconnect should be final. | 101 |
| Error |
coding | HiddenField | 'zkconnect' hides a field. | 101 |
| Error |
design | DesignForExtension | Class 'KafkaConfiguration' looks like designed for extension (can be subclassed), but the method 'withZkconnect' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'KafkaConfiguration' final or making the method 'withZkconnect' static/final/abstract/empty, or adding allowed annotation for the method. | 105 |
| Error |
javadoc | JavadocMethod | Missing a Javadoc comment. | 105 |
| Error |
misc | FinalParameters | Parameter zkconnect should be final. | 105 |
| Error |
coding | HiddenField | 'zkconnect' hides a field. | 105 |
| Error |
javadoc | JavadocStyle | First sentence should end with a period. | 110 |
| Error |
regexp | RegexpSingleline | Line has trailing spaces. | 112 |
| Error |
javadoc | JavadocStyle | First sentence should end with a period. | 121 |
| Error |
regexp | RegexpSingleline | Line has trailing spaces. | 123 |
| Error |
misc | FinalParameters | Parameter topic should be final. | 128 |
| Error |
coding | HiddenField | 'topic' hides a field. | 128 |
| Error |
design | DesignForExtension | Class 'KafkaConfiguration' looks like designed for extension (can be subclassed), but the method 'withTopic' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'KafkaConfiguration' final or making the method 'withTopic' static/final/abstract/empty, or adding allowed annotation for the method. | 132 |
| Error |
javadoc | JavadocMethod | Missing a Javadoc comment. | 132 |
| Error |
misc | FinalParameters | Parameter topic should be final. | 132 |
| Error |
coding | HiddenField | 'topic' hides a field. | 132 |
| Error |
javadoc | JavadocStyle | First sentence should end with a period. | 137 |
| Error |
regexp | RegexpSingleline | Line has trailing spaces. | 139 |
| Error |
javadoc | JavadocStyle | First sentence should end with a period. | 148 |
| Error |
regexp | RegexpSingleline | Line has trailing spaces. | 150 |
| Error |
misc | FinalParameters | Parameter groupId should be final. | 155 |
| Error |
coding | HiddenField | 'groupId' hides a field. | 155 |
| Error |
design | DesignForExtension | Class 'KafkaConfiguration' looks like designed for extension (can be subclassed), but the method 'withGroupId' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'KafkaConfiguration' final or making the method 'withGroupId' static/final/abstract/empty, or adding allowed annotation for the method. | 159 |
| Error |
javadoc | JavadocMethod | Missing a Javadoc comment. | 159 |
| Error |
misc | FinalParameters | Parameter groupId should be final. | 159 |
| Error |
coding | HiddenField | 'groupId' hides a field. | 159 |
| Error |
design | DesignForExtension | Class 'KafkaConfiguration' looks like designed for extension (can be subclassed), but the method 'toString' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'KafkaConfiguration' final or making the method 'toString' static/final/abstract/empty, or adding allowed annotation for the method. | 164 |
| Error |
design | DesignForExtension | Class 'KafkaConfiguration' looks like designed for extension (can be subclassed), but the method 'getAdditionalProperties' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'KafkaConfiguration' final or making the method 'getAdditionalProperties' static/final/abstract/empty, or adding allowed annotation for the method. | 169 |
| Error |
javadoc | JavadocMethod | Missing a Javadoc comment. | 169 |
| Error |
design | DesignForExtension | Class 'KafkaConfiguration' looks like designed for extension (can be subclassed), but the method 'setAdditionalProperty' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'KafkaConfiguration' final or making the method 'setAdditionalProperty' static/final/abstract/empty, or adding allowed annotation for the method. | 174 |
| Error |
javadoc | JavadocMethod | Missing a Javadoc comment. | 174 |
| Error |
misc | FinalParameters | Parameter name should be final. | 175 |
| Error |
misc | FinalParameters | Parameter value should be final. | 175 |
| Error |
sizes | LineLength | Line is longer than 80 characters (found 81). | 179 |
| Error |
design | DesignForExtension | Class 'KafkaConfiguration' looks like designed for extension (can be subclassed), but the method 'withAdditionalProperty' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'KafkaConfiguration' final or making the method 'withAdditionalProperty' static/final/abstract/empty, or adding allowed annotation for the method. | 179 |
| Error |
javadoc | JavadocMethod | Missing a Javadoc comment. | 179 |
| Error |
misc | FinalParameters | Parameter name should be final. | 179 |
| Error |
misc | FinalParameters | Parameter value should be final. | 179 |
| Error |
design | DesignForExtension | Class 'KafkaConfiguration' looks like designed for extension (can be subclassed), but the method 'hashCode' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'KafkaConfiguration' final or making the method 'hashCode' static/final/abstract/empty, or adding allowed annotation for the method. | 184 |
| Error |
sizes | LineLength | Line is longer than 80 characters (found 146). | 186 |
| Error |
design | DesignForExtension | Class 'KafkaConfiguration' looks like designed for extension (can be subclassed), but the method 'equals' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'KafkaConfiguration' final or making the method 'equals' static/final/abstract/empty, or adding allowed annotation for the method. | 189 |
| Error |
misc | FinalParameters | Parameter other should be final. | 190 |
| Error |
coding | SimplifyBooleanExpression | Expression can be simplified. | 194 |
| Error |
sizes | LineLength | Line is longer than 80 characters (found 223). | 198 |
| Severity | Category | Rule | Message | Line |
|---|---|---|---|---|
| Error |
javadoc | JavadocPackage | Missing package-info.java file. | |
| Error |
javadoc | JavadocVariable | Missing a Javadoc comment. | 54 |
| Error |
sizes | LineLength | Line is longer than 80 characters (found 89). | 56 |
| Error |
javadoc | JavadocVariable | Missing a Javadoc comment. | 56 |
| Error |
javadoc | JavadocVariable | Missing a Javadoc comment. | 58 |
| Error |
design | VisibilityModifier | Variable 'persistQueue' must be private and have accessor methods. | 58 |
| Error |
javadoc | JavadocVariable | Missing a Javadoc comment. | 60 |
| Error |
javadoc | JavadocVariable | Missing a Javadoc comment. | 62 |
| Error |
javadoc | JavadocVariable | Missing a Javadoc comment. | 64 |
| Error |
javadoc | JavadocVariable | Missing a Javadoc comment. | 66 |
| Error |
design | VisibilityModifier | Variable 'inStreams' must be private and have accessor methods. | 66 |
| Error |
javadoc | JavadocVariable | Missing a Javadoc comment. | 68 |
| Error |
sizes | LineLength | Line is longer than 80 characters (found 83). | 71 |
| Error |
sizes | LineLength | Line is longer than 80 characters (found 81). | 75 |
| Error |
misc | FinalParameters | Parameter persistQueue should be final. | 82 |
| Error |
coding | HiddenField | 'persistQueue' hides a field. | 82 |
| Error |
javadoc | JavadocMethod | Expected @param tag for 'persistQueue'. | 82 |
| Error |
sizes | LineLength | Line is longer than 80 characters (found 81). | 84 |
| Error |
design | DesignForExtension | Class 'KafkaPersistReader' looks like designed for extension (can be subclassed), but the method 'setConfig' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'KafkaPersistReader' final or making the method 'setConfig' static/final/abstract/empty, or adding allowed annotation for the method. | 88 |
| Error |
javadoc | JavadocMethod | Missing a Javadoc comment. | 88 |
| Error |
misc | FinalParameters | Parameter config should be final. | 88 |
| Error |
coding | HiddenField | 'config' hides a field. | 88 |
| Error |
design | DesignForExtension | Class 'KafkaPersistReader' 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 'KafkaPersistReader' final or making the method 'getId' static/final/abstract/empty, or adding allowed annotation for the method. | 92 |
| Error |
design | DesignForExtension | Class 'KafkaPersistReader' looks like designed for extension (can be subclassed), but the method 'startStream' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'KafkaPersistReader' final or making the method 'startStream' static/final/abstract/empty, or adding allowed annotation for the method. | 97 |
| Error |
sizes | LineLength | Line is longer than 80 characters (found 128). | 110 |
| Error |
design | DesignForExtension | Class 'KafkaPersistReader' 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 'KafkaPersistReader' final or making the method 'readAll' static/final/abstract/empty, or adding allowed annotation for the method. | 118 |
| Error |
design | DesignForExtension | Class 'KafkaPersistReader' 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 'KafkaPersistReader' final or making the method 'readCurrent' static/final/abstract/empty, or adding allowed annotation for the method. | 123 |
| Error |
design | DesignForExtension | Class 'KafkaPersistReader' 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 'KafkaPersistReader' final or making the method 'readNew' static/final/abstract/empty, or adding allowed annotation for the method. | 128 |
| Error |
misc | FinalParameters | Parameter bigInteger should be final. | 129 |
| Error |
design | DesignForExtension | Class 'KafkaPersistReader' 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 'KafkaPersistReader' final or making the method 'readRange' static/final/abstract/empty, or adding allowed annotation for the method. | 133 |
| Error |
misc | FinalParameters | Parameter dateTime should be final. | 134 |
| Error |
misc | FinalParameters | Parameter dateTime2 should be final. | 134 |
| Error |
design | DesignForExtension | Class 'KafkaPersistReader' 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 'KafkaPersistReader' final or making the method 'isRunning' static/final/abstract/empty, or adding allowed annotation for the method. | 138 |
| Error |
sizes | LineLength | Line is longer than 80 characters (found 88). | 143 |
| Error |
javadoc | JavadocMethod | Missing a Javadoc comment. | 143 |
| Error |
misc | FinalParameters | Parameter zookeeper should be final. | 143 |
| Error |
misc | FinalParameters | Parameter groupId should be final. | 143 |
| Error |
misc | FinalParameters | Parameter configurationObject should be final. | 154 |
| Error |
design | DesignForExtension | Class 'KafkaPersistReader' looks like designed for extension (can be subclassed), but the method 'cleanUp' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'KafkaPersistReader' final or making the method 'cleanUp' static/final/abstract/empty, or adding allowed annotation for the method. | 158 |
| Error |
whitespace | ParenPad | '(' is followed by whitespace. | 161 |
| Error |
coding | MagicNumber | '5' is a magic number. | 163 |
| Severity | Category | Rule | Message | Line |
|---|---|---|---|---|
| Error |
javadoc | JavadocStyle | First sentence should end with a period. | 30 |
| Error |
sizes | LineLength | Line is longer than 80 characters (found 93). | 36 |
| Error |
javadoc | JavadocVariable | Missing a Javadoc comment. | 36 |
| Error |
javadoc | JavadocVariable | Missing a Javadoc comment. | 38 |
| Error |
javadoc | JavadocVariable | Missing a Javadoc comment. | 39 |
| Error |
whitespace | WhitespaceAfter | ',' is not followed by whitespace. | 39 |
| Error |
sizes | LineLength | Line is longer than 80 characters (found 95). | 41 |
| Error |
javadoc | JavadocMethod | Missing a Javadoc comment. | 41 |
| Error |
misc | FinalParameters | Parameter reader should be final. | 41 |
| Error |
coding | HiddenField | 'reader' hides a field. | 41 |
| Error |
misc | FinalParameters | Parameter stream should be final. | 41 |
| Error |
whitespace | WhitespaceAfter | ',' is not followed by whitespace. | 41 |
| Error |
coding | HiddenField | 'stream' hides a field. | 41 |
| Error |
design | DesignForExtension | Class 'KafkaPersistReaderTask' 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 'KafkaPersistReaderTask' final or making the method 'run' static/final/abstract/empty, or adding allowed annotation for the method. | 46 |
| Error |
whitespace | WhitespaceAfter | ',' is not followed by whitespace. | 49 |
| Error |
coding | MagicNumber | '100' is a magic number. | 57 |
| Severity | Category | Rule | Message | Line |
|---|---|---|---|---|
| Error |
sizes | LineLength | Line is longer than 80 characters (found 89). | 43 |
| Error |
javadoc | JavadocVariable | Missing a Javadoc comment. | 45 |
| Error |
sizes | LineLength | Line is longer than 80 characters (found 89). | 47 |
| Error |
javadoc | JavadocVariable | Missing a Javadoc comment. | 47 |
| Error |
javadoc | JavadocVariable | Missing a Javadoc comment. | 49 |
| Error |
design | VisibilityModifier | Variable 'persistQueue' must be private and have accessor methods. | 49 |
| Error |
javadoc | JavadocVariable | Missing a Javadoc comment. | 51 |
| Error |
javadoc | JavadocVariable | Missing a Javadoc comment. | 53 |
| Error |
javadoc | JavadocVariable | Missing a Javadoc comment. | 55 |
| Error |
sizes | LineLength | Line is longer than 80 characters (found 83). | 58 |
| Error |
sizes | LineLength | Line is longer than 80 characters (found 81). | 62 |
| Error |
misc | FinalParameters | Parameter persistQueue should be final. | 69 |
| Error |
coding | HiddenField | 'persistQueue' hides a field. | 69 |
| Error |
javadoc | JavadocMethod | Expected @param tag for 'persistQueue'. | 69 |
| Error |
sizes | LineLength | Line is longer than 80 characters (found 81). | 71 |
| Error |
design | DesignForExtension | Class 'KafkaPersistWriter' looks like designed for extension (can be subclassed), but the method 'setConfig' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'KafkaPersistWriter' final or making the method 'setConfig' static/final/abstract/empty, or adding allowed annotation for the method. | 75 |
| Error |
javadoc | JavadocMethod | Missing a Javadoc comment. | 75 |
| Error |
misc | FinalParameters | Parameter config should be final. | 75 |
| Error |
coding | HiddenField | 'config' hides a field. | 75 |
| Error |
javadoc | JavadocStyle | First sentence should end with a period. | 79 |
| Error |
sizes | LineLength | Line is longer than 80 characters (found 82). | 87 |
| Error |
coding | HiddenField | 'config' hides a field. | 90 |
| Error |
design | DesignForExtension | Class 'KafkaPersistWriter' looks like designed for extension (can be subclassed), but the method 'stop' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'KafkaPersistWriter' final or making the method 'stop' static/final/abstract/empty, or adding allowed annotation for the method. | 97 |
| Error |
javadoc | JavadocMethod | Missing a Javadoc comment. | 97 |
| Error |
design | DesignForExtension | Class 'KafkaPersistWriter' looks like designed for extension (can be subclassed), but the method 'setPersistQueue' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'KafkaPersistWriter' final or making the method 'setPersistQueue' static/final/abstract/empty, or adding allowed annotation for the method. | 101 |
| Error |
javadoc | JavadocMethod | Missing a Javadoc comment. | 101 |
| Error |
misc | FinalParameters | Parameter persistQueue should be final. | 101 |
| Error |
coding | HiddenField | 'persistQueue' hides a field. | 101 |
| Error |
design | DesignForExtension | Class 'KafkaPersistWriter' looks like designed for extension (can be subclassed), but the method 'getPersistQueue' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'KafkaPersistWriter' final or making the method 'getPersistQueue' static/final/abstract/empty, or adding allowed annotation for the method. | 105 |
| Error |
javadoc | JavadocMethod | Missing a Javadoc comment. | 105 |
| Error |
design | DesignForExtension | Class 'KafkaPersistWriter' 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 'KafkaPersistWriter' final or making the method 'getId' static/final/abstract/empty, or adding allowed annotation for the method. | 109 |
| Error |
design | DesignForExtension | Class 'KafkaPersistWriter' 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 'KafkaPersistWriter' final or making the method 'write' static/final/abstract/empty, or adding allowed annotation for the method. | 114 |
| Error |
misc | FinalParameters | Parameter entry should be final. | 115 |
| Error |
sizes | LineLength | Line is longer than 80 characters (found 92). | 123 |
| Error |
design | DesignForExtension | Class 'KafkaPersistWriter' 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 'KafkaPersistWriter' final or making the method 'run' static/final/abstract/empty, or adding allowed annotation for the method. | 132 |
| Error |
design | DesignForExtension | Class 'KafkaPersistWriter' 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 'KafkaPersistWriter' final or making the method 'prepare' static/final/abstract/empty, or adding allowed annotation for the method. | 137 |
| Error |
misc | FinalParameters | Parameter configurationObject should be final. | 138 |
| Error |
design | DesignForExtension | Class 'KafkaPersistWriter' looks like designed for extension (can be subclassed), but the method 'cleanUp' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'KafkaPersistWriter' final or making the method 'cleanUp' static/final/abstract/empty, or adding allowed annotation for the method. | 142 |
| 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 93). | 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 'KafkaPersistWriterTask' 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 'KafkaPersistWriterTask' 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. | 46 |
| Error |
whitespace | ParenPad | ')' is preceded with whitespace. | 46 |
| Error |
coding | MagicNumber | '100' is a magic number. | 55 |
Info
Warnings