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 62

Files

File  I  W  E
org/apache/streams/filebuffer/FileBufferPersistReader.java 0 0 37
org/apache/streams/filebuffer/FileBufferPersistWriter.java 0 0 25

Rules

Category Rule Violations Severity
coding AvoidInlineConditionals 1  Error
HiddenField 2  Error
MagicNumber 1  Error
design DesignForExtension 13  Error
javadoc JavadocMethod 5  Error
JavadocPackage 1  Error
JavadocVariable 15  Error
misc FinalParameters 9  Error
sizes LineLength 8  Error
whitespace ParenPad 6  Error
WhitespaceAfter 1  Error

Details

org/apache/streams/filebuffer/FileBufferPersistReader.java

Severity Category Rule Message Line
 Error sizes LineLength Line is longer than 80 characters (found 84). 50
 Error javadoc JavadocVariable Missing a Javadoc comment. 52
 Error sizes LineLength Line is longer than 80 characters (found 94). 54
 Error javadoc JavadocVariable Missing a Javadoc comment. 54
 Error javadoc JavadocVariable Missing a Javadoc comment. 56
 Error javadoc JavadocVariable Missing a Javadoc comment. 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. 65
 Error javadoc JavadocVariable Missing a Javadoc comment. 67
 Error javadoc JavadocMethod Missing a Javadoc comment. 69
 Error sizes LineLength Line is longer than 80 characters (found 87). 71
 Error javadoc JavadocMethod Missing a Javadoc comment. 74
 Error misc FinalParameters Parameter config should be final. 74
 Error coding HiddenField 'config' hides a field. 74
 Error design DesignForExtension Class 'FileBufferPersistReader' 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 'FileBufferPersistReader' final or making the method 'getId' static/final/abstract/empty, or adding allowed annotation for the method. 78
 Error design DesignForExtension Class 'FileBufferPersistReader' 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 'FileBufferPersistReader' final or making the method 'readAll' static/final/abstract/empty, or adding allowed annotation for the method. 83
 Error design DesignForExtension Class 'FileBufferPersistReader' 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 'FileBufferPersistReader' final or making the method 'startStream' static/final/abstract/empty, or adding allowed annotation for the method. 88
 Error design DesignForExtension Class 'FileBufferPersistReader' 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 'FileBufferPersistReader' final or making the method 'readCurrent' static/final/abstract/empty, or adding allowed annotation for the method. 93
 Error javadoc JavadocMethod Missing a Javadoc comment. 117
 Error whitespace ParenPad '(' is followed by whitespace. 117
 Error misc FinalParameters Parameter entry should be final. 117
 Error whitespace ParenPad ')' is preceded with whitespace. 117
 Error design DesignForExtension Class 'FileBufferPersistReader' 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 'FileBufferPersistReader' final or making the method 'readNew' static/final/abstract/empty, or adding allowed annotation for the method. 121
 Error misc FinalParameters Parameter bigInteger should be final. 122
 Error design DesignForExtension Class 'FileBufferPersistReader' 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 'FileBufferPersistReader' final or making the method 'readRange' static/final/abstract/empty, or adding allowed annotation for the method. 126
 Error misc FinalParameters Parameter dateTime should be final. 127
 Error misc FinalParameters Parameter dateTime2 should be final. 127
 Error design DesignForExtension Class 'FileBufferPersistReader' 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 'FileBufferPersistReader' final or making the method 'isRunning' static/final/abstract/empty, or adding allowed annotation for the method. 131
 Error design DesignForExtension Class 'FileBufferPersistReader' 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 'FileBufferPersistReader' final or making the method 'prepare' static/final/abstract/empty, or adding allowed annotation for the method. 136
 Error misc FinalParameters Parameter configurationObject should be final. 137
 Error coding MagicNumber '1000' is a magic number. 140
 Error whitespace ParenPad '(' is followed by whitespace. 147
 Error whitespace ParenPad '(' is followed by whitespace. 149
 Error whitespace ParenPad ')' is preceded with whitespace. 149
 Error design DesignForExtension Class 'FileBufferPersistReader' 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 'FileBufferPersistReader' final or making the method 'cleanUp' static/final/abstract/empty, or adding allowed annotation for the method. 172

org/apache/streams/filebuffer/FileBufferPersistWriter.java

Severity Category Rule Message Line
 Error javadoc JavadocPackage Missing package-info.java file.
 Error sizes LineLength Line is longer than 80 characters (found 84). 44
 Error javadoc JavadocVariable Missing a Javadoc comment. 46
 Error sizes LineLength Line is longer than 80 characters (found 94). 48
 Error javadoc JavadocVariable Missing a Javadoc comment. 48
 Error javadoc JavadocVariable Missing a Javadoc comment. 50
 Error javadoc JavadocVariable Missing a Javadoc comment. 52
 Error javadoc JavadocVariable Missing a Javadoc comment. 54
 Error javadoc JavadocVariable Missing a Javadoc comment. 56
 Error javadoc JavadocMethod Missing a Javadoc comment. 58
 Error sizes LineLength Line is longer than 80 characters (found 87). 60
 Error javadoc JavadocMethod Missing a Javadoc comment. 63
 Error misc FinalParameters Parameter config should be final. 63
 Error coding HiddenField 'config' hides a field. 63
 Error design DesignForExtension Class 'FileBufferPersistWriter' 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 'FileBufferPersistWriter' final or making the method 'getId' static/final/abstract/empty, or adding allowed annotation for the method. 67
 Error design DesignForExtension Class 'FileBufferPersistWriter' 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 'FileBufferPersistWriter' 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
 Error sizes LineLength Line is longer than 80 characters (found 94). 75
 Error coding AvoidInlineConditionals Avoid inline conditionals. 75
 Error sizes LineLength Line is longer than 80 characters (found 86). 79
 Error whitespace WhitespaceAfter 'typecast' is not followed by whitespace. 81
 Error design DesignForExtension Class 'FileBufferPersistWriter' 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 'FileBufferPersistWriter' final or making the method 'prepare' static/final/abstract/empty, or adding allowed annotation for the method. 89
 Error misc FinalParameters Parameter configurationObject should be final. 90
 Error whitespace ParenPad '(' is followed by whitespace. 94
 Error design DesignForExtension Class 'FileBufferPersistWriter' 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 'FileBufferPersistWriter' final or making the method 'cleanUp' static/final/abstract/empty, or adding allowed annotation for the method. 111