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
2 0 0 140

Files

File  I  W  E
org/apache/streams/mongo/MongoPersistReader.java 0 0 75
org/apache/streams/mongo/MongoPersistWriter.java 0 0 65

Rules

Category Rule Violations Severity
coding HiddenField 6  Error
MagicNumber 5  Error
design DesignForExtension 26  Error
VisibilityModifier 12  Error
javadoc JavadocMethod 17  Error
JavadocPackage 1  Error
JavadocType 2  Error
JavadocVariable 26  Error
misc FinalParameters 16  Error
sizes LineLength 25  Error
whitespace ParenPad 4  Error

Details

org/apache/streams/mongo/MongoPersistReader.java

Severity Category Rule Message Line
 Error javadoc JavadocPackage Missing package-info.java file.
 Error javadoc JavadocVariable Missing a Javadoc comment. 62
 Error sizes LineLength Line is longer than 80 characters (found 89). 64
 Error javadoc JavadocVariable Missing a Javadoc comment. 64
 Error javadoc JavadocVariable Missing a Javadoc comment. 66
 Error design VisibilityModifier Variable 'persistQueue' 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 85). 69
 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 javadoc JavadocVariable Missing a Javadoc comment. 75
 Error design VisibilityModifier Variable 'client' must be private and have accessor methods. 75
 Error javadoc JavadocVariable Missing a Javadoc comment. 76
 Error design VisibilityModifier Variable 'db' must be private and have accessor methods. 76
 Error javadoc JavadocVariable Missing a Javadoc comment. 77
 Error design VisibilityModifier Variable 'collection' must be private and have accessor methods. 77
 Error javadoc JavadocVariable Missing a Javadoc comment. 79
 Error design VisibilityModifier Variable 'cursor' must be private and have accessor methods. 79
 Error javadoc JavadocVariable Missing a Javadoc comment. 81
 Error design VisibilityModifier Variable 'lock' must be private and have accessor methods. 81
 Error sizes LineLength Line is longer than 80 characters (found 83). 84
 Error sizes LineLength Line is longer than 80 characters (found 81). 88
 Error misc FinalParameters Parameter config should be final. 95
 Error coding HiddenField 'config' hides a field. 95
 Error misc FinalParameters Parameter persistQueue should be final. 103
 Error coding HiddenField 'persistQueue' hides a field. 103
 Error sizes LineLength Line is longer than 80 characters (found 81). 105
 Error design DesignForExtension Class 'MongoPersistReader' 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 'MongoPersistReader' final or making the method 'setPersistQueue' static/final/abstract/empty, or adding allowed annotation for the method. 109
 Error javadoc JavadocMethod Missing a Javadoc comment. 109
 Error misc FinalParameters Parameter persistQueue should be final. 109
 Error coding HiddenField 'persistQueue' hides a field. 109
 Error design DesignForExtension Class 'MongoPersistReader' 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 'MongoPersistReader' final or making the method 'getPersistQueue' static/final/abstract/empty, or adding allowed annotation for the method. 113
 Error javadoc JavadocMethod Missing a Javadoc comment. 113
 Error javadoc JavadocMethod Missing a Javadoc comment. 117
 Error design DesignForExtension Class 'MongoPersistReader' 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 'MongoPersistReader' final or making the method 'getId' static/final/abstract/empty, or adding allowed annotation for the method. 120
 Error design DesignForExtension Class 'MongoPersistReader' 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 'MongoPersistReader' final or making the method 'prepare' static/final/abstract/empty, or adding allowed annotation for the method. 125
 Error misc FinalParameters Parameter configurationObject should be final. 126
 Error whitespace ParenPad '(' is followed by whitespace. 130
 Error whitespace ParenPad ')' is preceded with whitespace. 131
 Error whitespace ParenPad '(' is followed by whitespace. 136
 Error design DesignForExtension Class 'MongoPersistReader' 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 'MongoPersistReader' final or making the method 'cleanUp' static/final/abstract/empty, or adding allowed annotation for the method. 147
 Error design DesignForExtension Class 'MongoPersistReader' looks like designed for extension (can be subclassed), but the method 'prepareDatum' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'MongoPersistReader' final or making the method 'prepareDatum' static/final/abstract/empty, or adding allowed annotation for the method. 152
 Error javadoc JavadocMethod Missing a Javadoc comment. 152
 Error misc FinalParameters Parameter dbObject should be final. 152
 Error javadoc JavadocMethod Missing a Javadoc comment. 169
 Error sizes LineLength Line is longer than 80 characters (found 99). 171
 Error sizes LineLength Line is longer than 80 characters (found 99). 173
 Error sizes LineLength Line is longer than 80 characters (found 113). 175
 Error sizes LineLength Line is longer than 80 characters (found 98). 176
 Error design DesignForExtension Class 'MongoPersistReader' 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 'MongoPersistReader' final or making the method 'readAll' static/final/abstract/empty, or adding allowed annotation for the method. 190
 Error design DesignForExtension Class 'MongoPersistReader' 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 'MongoPersistReader' final or making the method 'startStream' static/final/abstract/empty, or adding allowed annotation for the method. 204
 Error whitespace ParenPad '(' is followed by whitespace. 212
 Error coding MagicNumber '1000' is a magic number. 214
 Error design DesignForExtension Class 'MongoPersistReader' 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 'MongoPersistReader' final or making the method 'readCurrent' static/final/abstract/empty, or adding allowed annotation for the method. 224
 Error sizes LineLength Line is longer than 80 characters (found 114). 241
 Error sizes LineLength Line is longer than 80 characters (found 119). 242
 Error design DesignForExtension Class 'MongoPersistReader' 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 'MongoPersistReader' final or making the method 'write' static/final/abstract/empty, or adding allowed annotation for the method. 244
 Error javadoc JavadocMethod Missing a Javadoc comment. 244
 Error misc FinalParameters Parameter entry should be final. 244
 Error design DesignForExtension Class 'MongoPersistReader' 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 'MongoPersistReader' final or making the method 'readNew' static/final/abstract/empty, or adding allowed annotation for the method. 258
 Error misc FinalParameters Parameter sequence should be final. 259
 Error design DesignForExtension Class 'MongoPersistReader' 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 'MongoPersistReader' final or making the method 'readRange' static/final/abstract/empty, or adding allowed annotation for the method. 263
 Error misc FinalParameters Parameter start should be final. 264
 Error misc FinalParameters Parameter end should be final. 264
 Error design DesignForExtension Class 'MongoPersistReader' 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 'MongoPersistReader' final or making the method 'isRunning' static/final/abstract/empty, or adding allowed annotation for the method. 268
 Error javadoc JavadocMethod Missing a Javadoc comment. 273
 Error sizes LineLength Line is longer than 80 characters (found 82). 274
 Error coding MagicNumber '10000' is a magic number. 274
 Error javadoc JavadocType Missing a Javadoc comment. 277
 Error javadoc JavadocVariable Missing a Javadoc comment. 279
 Error javadoc JavadocMethod Missing a Javadoc comment. 281
 Error misc FinalParameters Parameter reader should be final. 281
 Error coding HiddenField 'reader' hides a field. 281
 Error design DesignForExtension Class 'MongoPersistReaderTask' 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 'MongoPersistReaderTask' final or making the method 'run' static/final/abstract/empty, or adding allowed annotation for the method. 285

org/apache/streams/mongo/MongoPersistWriter.java

Severity Category Rule Message Line
 Error sizes LineLength Line is longer than 80 characters (found 97). 57
 Error javadoc JavadocType Missing a Javadoc comment. 57
 Error javadoc JavadocVariable Missing a Javadoc comment. 59
 Error sizes LineLength Line is longer than 80 characters (found 89). 61
 Error javadoc JavadocVariable Missing a Javadoc comment. 61
 Error javadoc JavadocVariable Missing a Javadoc comment. 63
 Error javadoc JavadocVariable Missing a Javadoc comment. 65
 Error design VisibilityModifier Variable 'persistQueue' must be private and have accessor methods. 65
 Error javadoc JavadocVariable Missing a Javadoc comment. 67
 Error sizes LineLength Line is longer than 80 characters (found 85). 68
 Error javadoc JavadocVariable Missing a Javadoc comment. 68
 Error sizes LineLength Line is longer than 80 characters (found 102). 69
 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 javadoc JavadocVariable Missing a Javadoc comment. 74
 Error design VisibilityModifier Variable 'db' must be private and have accessor methods. 74
 Error javadoc JavadocVariable Missing a Javadoc comment. 75
 Error design VisibilityModifier Variable 'collection' must be private and have accessor methods. 75
 Error javadoc JavadocVariable Missing a Javadoc comment. 77
 Error design VisibilityModifier Variable 'insertBatch' must be private and have accessor methods. 77
 Error javadoc JavadocVariable Missing a Javadoc comment. 79
 Error design VisibilityModifier Variable 'lock' must be private and have accessor methods. 79
 Error javadoc JavadocMethod Missing a Javadoc comment. 81
 Error sizes LineLength Line is longer than 80 characters (found 82). 83
 Error javadoc JavadocMethod Missing a Javadoc comment. 86
 Error misc FinalParameters Parameter config should be final. 86
 Error coding HiddenField 'config' hides a field. 86
 Error design DesignForExtension Class 'MongoPersistWriter' 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 'MongoPersistWriter' final or making the method 'setPersistQueue' static/final/abstract/empty, or adding allowed annotation for the method. 90
 Error javadoc JavadocMethod Missing a Javadoc comment. 90
 Error misc FinalParameters Parameter persistQueue should be final. 90
 Error coding HiddenField 'persistQueue' hides a field. 90
 Error design DesignForExtension Class 'MongoPersistWriter' 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 'MongoPersistWriter' final or making the method 'getPersistQueue' static/final/abstract/empty, or adding allowed annotation for the method. 94
 Error javadoc JavadocMethod Missing a Javadoc comment. 94
 Error design DesignForExtension Class 'MongoPersistWriter' 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 'MongoPersistWriter' final or making the method 'getId' static/final/abstract/empty, or adding allowed annotation for the method. 98
 Error design DesignForExtension Class 'MongoPersistWriter' 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 'MongoPersistWriter' final or making the method 'write' static/final/abstract/empty, or adding allowed annotation for the method. 103
 Error misc FinalParameters Parameter streamsDatum should be final. 104
 Error design DesignForExtension Class 'MongoPersistWriter' looks like designed for extension (can be subclassed), but the method 'flush' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'MongoPersistWriter' final or making the method 'flush' static/final/abstract/empty, or adding allowed annotation for the method. 113
 Error design DesignForExtension Class 'MongoPersistWriter' looks like designed for extension (can be subclassed), but the method 'close' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'MongoPersistWriter' final or making the method 'close' static/final/abstract/empty, or adding allowed annotation for the method. 127
 Error javadoc JavadocMethod Missing a Javadoc comment. 127
 Error sizes LineLength Line is longer than 80 characters (found 117). 137
 Error coding MagicNumber '15' is a magic number. 158
 Error coding MagicNumber '15' is a magic number. 161
 Error design DesignForExtension Class 'MongoPersistWriter' 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 'MongoPersistWriter' final or making the method 'run' static/final/abstract/empty, or adding allowed annotation for the method. 174
 Error design DesignForExtension Class 'MongoPersistWriter' 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 'MongoPersistWriter' final or making the method 'prepare' static/final/abstract/empty, or adding allowed annotation for the method. 195
 Error misc FinalParameters Parameter configurationObject should be final. 196
 Error design DesignForExtension Class 'MongoPersistWriter' 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 'MongoPersistWriter' final or making the method 'cleanUp' static/final/abstract/empty, or adding allowed annotation for the method. 201
 Error design DesignForExtension Class 'MongoPersistWriter' looks like designed for extension (can be subclassed), but the method 'flushIfNecessary' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'MongoPersistWriter' final or making the method 'flushIfNecessary' static/final/abstract/empty, or adding allowed annotation for the method. 206
 Error javadoc JavadocMethod Missing a Javadoc comment. 206
 Error sizes LineLength Line is longer than 80 characters (found 115). 208
 Error sizes LineLength Line is longer than 80 characters (found 103). 210
 Error coding MagicNumber '100' is a magic number. 210
 Error design DesignForExtension Class 'MongoPersistWriter' looks like designed for extension (can be subclassed), but the method 'addToBatch' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'MongoPersistWriter' final or making the method 'addToBatch' static/final/abstract/empty, or adding allowed annotation for the method. 219
 Error javadoc JavadocMethod Missing a Javadoc comment. 219
 Error misc FinalParameters Parameter dbObject should be final. 219
 Error design DesignForExtension Class 'MongoPersistWriter' looks like designed for extension (can be subclassed), but the method 'prepareObject' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'MongoPersistWriter' final or making the method 'prepareObject' static/final/abstract/empty, or adding allowed annotation for the method. 228
 Error javadoc JavadocMethod Missing a Javadoc comment. 228
 Error misc FinalParameters Parameter streamsDatum should be final. 228
 Error sizes LineLength Line is longer than 80 characters (found 87). 237
 Error javadoc JavadocMethod Missing a Javadoc comment. 243
 Error sizes LineLength Line is longer than 80 characters (found 99). 245
 Error sizes LineLength Line is longer than 80 characters (found 99). 247
 Error sizes LineLength Line is longer than 80 characters (found 113). 249
 Error sizes LineLength Line is longer than 80 characters (found 98). 250