Fork me on GitHub

Checkstyle Results

The following document contains the results of Checkstyle 7.2 with sun_checks.xml ruleset. rss feed

Summary

Files  Info  Warnings  Errors
3 0 0 119

Files

File  I  W  E
org/apache/streams/amazon/kinesis/KinesisPersistReader.java 0 0 60
org/apache/streams/amazon/kinesis/KinesisPersistReaderTask.java 0 0 25
org/apache/streams/amazon/kinesis/KinesisPersistWriter.java 0 0 34

Rules

Category Rule Violations Severity
blocks NeedBraces 1  Error
coding HiddenField 9  Error
MagicNumber 2  Error
design DesignForExtension 16  Error
VisibilityModifier 5  Error
javadoc JavadocMethod 8  Error
JavadocPackage 1  Error
JavadocStyle 1  Error
JavadocVariable 23  Error
misc FinalParameters 13  Error
sizes LineLength 25  Error
whitespace ParenPad 8  Error
WhitespaceAfter 1  Error
WhitespaceAround 6  Error

Details

org/apache/streams/amazon/kinesis/KinesisPersistReader.java

Severity Category Rule Message Line
 Error sizes LineLength Line is longer than 80 characters (found 81). 55
 Error javadoc JavadocVariable Missing a Javadoc comment. 57
 Error sizes LineLength Line is longer than 80 characters (found 91). 59
 Error javadoc JavadocVariable Missing a Javadoc comment. 59
 Error javadoc JavadocVariable Missing a Javadoc comment. 61
 Error design VisibilityModifier Variable 'persistQueue' must be private and have accessor methods. 61
 Error javadoc JavadocVariable Missing a Javadoc comment. 63
 Error javadoc JavadocVariable Missing a Javadoc comment. 65
 Error sizes LineLength Line is longer than 80 characters (found 96). 67
 Error javadoc JavadocVariable Missing a Javadoc comment. 67
 Error design VisibilityModifier Variable 'pollInterval' must be private and have accessor methods. 67
 Error javadoc JavadocVariable Missing a Javadoc comment. 69
 Error javadoc JavadocVariable Missing a Javadoc comment. 71
 Error javadoc JavadocVariable Missing a Javadoc comment. 73
 Error design VisibilityModifier Variable 'client' must be private and have accessor methods. 73
 Error sizes LineLength Line is longer than 80 characters (found 95). 76
 Error coding HiddenField 'config' hides a field. 79
 Error sizes LineLength Line is longer than 80 characters (found 108). 80
 Error sizes LineLength Line is longer than 80 characters (found 81). 85
 Error misc FinalParameters Parameter config should be final. 87
 Error coding HiddenField 'config' hides a field. 87
 Error javadoc JavadocMethod Expected @param tag for 'config'. 87
 Error design DesignForExtension Class 'KinesisPersistReader' 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 'KinesisPersistReader' final or making the method 'setConfig' static/final/abstract/empty, or adding allowed annotation for the method. 92
 Error javadoc JavadocMethod Missing a Javadoc comment. 92
 Error misc FinalParameters Parameter config should be final. 92
 Error coding HiddenField 'config' hides a field. 92
 Error design DesignForExtension Class 'KinesisPersistReader' 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 'KinesisPersistReader' final or making the method 'getId' static/final/abstract/empty, or adding allowed annotation for the method. 96
 Error design DesignForExtension Class 'KinesisPersistReader' 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 'KinesisPersistReader' final or making the method 'startStream' static/final/abstract/empty, or adding allowed annotation for the method. 101
 Error sizes LineLength Line is longer than 80 characters (found 91). 110
 Error whitespace WhitespaceAround 'if' is not followed by whitespace. 110
 Error whitespace ParenPad '(' is followed by whitespace. 110
 Error sizes LineLength Line is longer than 80 characters (found 88). 112
 Error whitespace WhitespaceAround 'for' is not followed by whitespace. 114
 Error whitespace ParenPad '(' is followed by whitespace. 114
 Error whitespace ParenPad ')' is preceded with whitespace. 114
 Error sizes LineLength Line is longer than 80 characters (found 90). 115
 Error design DesignForExtension Class 'KinesisPersistReader' 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 'KinesisPersistReader' final or making the method 'readAll' static/final/abstract/empty, or adding allowed annotation for the method. 123
 Error design DesignForExtension Class 'KinesisPersistReader' 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 'KinesisPersistReader' final or making the method 'readCurrent' static/final/abstract/empty, or adding allowed annotation for the method. 128
 Error javadoc JavadocMethod Missing a Javadoc comment. 128
 Error whitespace WhitespaceAround 'synchronized' is not followed by whitespace. 131
 Error whitespace ParenPad '(' is followed by whitespace. 131
 Error whitespace ParenPad ')' is preceded with whitespace. 131
 Error design DesignForExtension Class 'KinesisPersistReader' 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 'KinesisPersistReader' final or making the method 'readNew' static/final/abstract/empty, or adding allowed annotation for the method. 138
 Error misc FinalParameters Parameter bigInteger should be final. 139
 Error design DesignForExtension Class 'KinesisPersistReader' 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 'KinesisPersistReader' final or making the method 'readRange' static/final/abstract/empty, or adding allowed annotation for the method. 143
 Error misc FinalParameters Parameter dateTime should be final. 144
 Error misc FinalParameters Parameter dateTime2 should be final. 144
 Error design DesignForExtension Class 'KinesisPersistReader' 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 'KinesisPersistReader' final or making the method 'isRunning' static/final/abstract/empty, or adding allowed annotation for the method. 148
 Error design DesignForExtension Class 'KinesisPersistReader' 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 'KinesisPersistReader' final or making the method 'prepare' static/final/abstract/empty, or adding allowed annotation for the method. 153
 Error misc FinalParameters Parameter configurationObject should be final. 154
 Error sizes LineLength Line is longer than 80 characters (found 99). 158
 Error sizes LineLength Line is longer than 80 characters (found 82). 161
 Error blocks NeedBraces 'if' construct must use '{}'s. 164
 Error sizes LineLength Line is longer than 80 characters (found 86). 165
 Error design DesignForExtension Class 'KinesisPersistReader' 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 'KinesisPersistReader' final or making the method 'cleanUp' static/final/abstract/empty, or adding allowed annotation for the method. 171
 Error whitespace WhitespaceAround 'while' is not followed by whitespace. 174
 Error whitespace ParenPad '(' is followed by whitespace. 174
 Error coding MagicNumber '5' is a magic number. 176
 Error whitespace WhitespaceAround '{' is not followed by whitespace. 177
 Error whitespace WhitespaceAround '}' is not preceded with whitespace. 177

org/apache/streams/amazon/kinesis/KinesisPersistReaderTask.java

Severity Category Rule Message Line
 Error javadoc JavadocStyle First sentence should end with a period. 39
 Error sizes LineLength Line is longer than 80 characters (found 95). 45
 Error javadoc JavadocVariable Missing a Javadoc comment. 45
 Error javadoc JavadocVariable Missing a Javadoc comment. 47
 Error javadoc JavadocVariable Missing a Javadoc comment. 48
 Error javadoc JavadocVariable Missing a Javadoc comment. 49
 Error javadoc JavadocVariable Missing a Javadoc comment. 51
 Error sizes LineLength Line is longer than 80 characters (found 94). 53
 Error javadoc JavadocVariable Missing a Javadoc comment. 53
 Error sizes LineLength Line is longer than 80 characters (found 99). 58
 Error misc FinalParameters Parameter reader should be final. 58
 Error coding HiddenField 'reader' hides a field. 58
 Error javadoc JavadocMethod Expected @param tag for 'reader'. 58
 Error misc FinalParameters Parameter streamName should be final. 58
 Error coding HiddenField 'streamName' hides a field. 58
 Error javadoc JavadocMethod Expected @param tag for 'streamName'. 58
 Error misc FinalParameters Parameter shardId should be final. 58
 Error coding HiddenField 'shardId' hides a field. 58
 Error javadoc JavadocMethod Expected @param tag for 'shardId'. 58
 Error design DesignForExtension Class 'KinesisPersistReaderTask' 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 'KinesisPersistReaderTask' final or making the method 'run' static/final/abstract/empty, or adding allowed annotation for the method. 64
 Error sizes LineLength Line is longer than 80 characters (found 102). 72
 Error whitespace WhitespaceAfter ',' is not followed by whitespace. 76
 Error sizes LineLength Line is longer than 80 characters (found 171). 87
 Error whitespace ParenPad '(' is followed by whitespace. 105
 Error whitespace ParenPad ')' is preceded with whitespace. 105

org/apache/streams/amazon/kinesis/KinesisPersistWriter.java

Severity Category Rule Message Line
 Error javadoc JavadocPackage Missing package-info.java file.
 Error javadoc JavadocVariable Missing a Javadoc comment. 57
 Error sizes LineLength Line is longer than 80 characters (found 91). 59
 Error javadoc JavadocVariable Missing a Javadoc comment. 59
 Error javadoc JavadocVariable Missing a Javadoc comment. 61
 Error design VisibilityModifier Variable 'persistQueue' must be private and have accessor methods. 61
 Error javadoc JavadocVariable Missing a Javadoc comment. 63
 Error javadoc JavadocVariable Missing a Javadoc comment. 65
 Error javadoc JavadocVariable Missing a Javadoc comment. 67
 Error javadoc JavadocVariable Missing a Javadoc comment. 69
 Error javadoc JavadocVariable Missing a Javadoc comment. 71
 Error design VisibilityModifier Variable 'client' must be private and have accessor methods. 71
 Error sizes LineLength Line is longer than 80 characters (found 95). 74
 Error coding HiddenField 'config' hides a field. 77
 Error sizes LineLength Line is longer than 80 characters (found 108). 78
 Error sizes LineLength Line is longer than 80 characters (found 81). 83
 Error misc FinalParameters Parameter config should be final. 85
 Error coding HiddenField 'config' hides a field. 85
 Error javadoc JavadocMethod Expected @param tag for 'config'. 85
 Error design DesignForExtension Class 'KinesisPersistWriter' 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 'KinesisPersistWriter' final or making the method 'setConfig' static/final/abstract/empty, or adding allowed annotation for the method. 90
 Error javadoc JavadocMethod Missing a Javadoc comment. 90
 Error misc FinalParameters Parameter config should be final. 90
 Error coding HiddenField 'config' hides a field. 90
 Error design DesignForExtension Class 'KinesisPersistWriter' 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 'KinesisPersistWriter' final or making the method 'getId' static/final/abstract/empty, or adding allowed annotation for the method. 94
 Error design DesignForExtension Class 'KinesisPersistWriter' 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 'KinesisPersistWriter' final or making the method 'write' static/final/abstract/empty, or adding allowed annotation for the method. 99
 Error misc FinalParameters Parameter entry should be final. 100
 Error sizes LineLength Line is longer than 80 characters (found 106). 102
 Error design DesignForExtension Class 'KinesisPersistWriter' 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 'KinesisPersistWriter' final or making the method 'prepare' static/final/abstract/empty, or adding allowed annotation for the method. 116
 Error misc FinalParameters Parameter configurationObject should be final. 117
 Error sizes LineLength Line is longer than 80 characters (found 99). 121
 Error sizes LineLength Line is longer than 80 characters (found 82). 124
 Error sizes LineLength Line is longer than 80 characters (found 86). 128
 Error design DesignForExtension Class 'KinesisPersistWriter' 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 'KinesisPersistWriter' final or making the method 'cleanUp' static/final/abstract/empty, or adding allowed annotation for the method. 135
 Error coding MagicNumber '5' is a magic number. 138