Checkstyle Results

The following document contains the results of Checkstyle 8.29 with sun_checks.xml ruleset. 

rss feed

Summary

Files
 Info
 Warnings
 Errors
4 0 0 75

Files

File
 I
 W
 E
ordertracker/rs/MyEventSource.java 0 0 10
ordertracker/rs/MyEventSourceServlet.java 0 0 3
ordertracker/rs/Service.java 0 0 55
ordertracker/web/ContextListener.java 0 0 7

Rules

Category Rule Violations Severity
blocks NeedBraces 2
 Error
design DesignForExtension 17
 Error
javadoc JavadocPackage 2
 Error
JavadocVariable 2
 Error
MissingJavadocMethod 12
 Error
misc FinalParameters 25
 Error
NewlineAtEndOfFile 1
 Error
sizes LineLength
  • fileExtensions: "java"
7
 Error
ParameterNumber 1
 Error
whitespace FileTabCharacter 4
 Error
WhitespaceAround 2
 Error

Details

ordertracker/rs/MyEventSource.java

Severity Category Rule Message Line
 Error
whitespace FileTabCharacter File contains tab characters (this is the first instance). 14
 Error
javadoc JavadocVariable Missing a Javadoc comment. 14
 Error
design DesignForExtension Class 'MyEventSource' looks like designed for extension (can be subclassed), but the method 'onOpen' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'MyEventSource' final or making the method 'onOpen' static/final/abstract/empty, or adding allowed annotation for the method. 16
 Error
sizes LineLength Line is longer than 80 characters (found 97). 18
 Error
sizes LineLength Line is longer than 80 characters (found 107). 20
 Error
misc FinalParameters Parameter data should be final. 22
 Error
sizes LineLength Line is longer than 80 characters (found 83). 25
 Error
whitespace WhitespaceAround '}' is not followed by whitespace. 29
 Error
whitespace WhitespaceAround '}' is not preceded with whitespace. 29
 Error
design DesignForExtension Class 'MyEventSource' looks like designed for extension (can be subclassed), but the method 'onClose' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'MyEventSource' final or making the method 'onClose' static/final/abstract/empty, or adding allowed annotation for the method. 32

ordertracker/rs/MyEventSourceServlet.java

Severity Category Rule Message Line
 Error
whitespace FileTabCharacter File contains tab characters (this is the first instance). 10
 Error
design DesignForExtension Class 'MyEventSourceServlet' looks like designed for extension (can be subclassed), but the method 'newEventSource' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'MyEventSourceServlet' final or making the method 'newEventSource' static/final/abstract/empty, or adding allowed annotation for the method. 12
 Error
misc FinalParameters Parameter req should be final. 13

ordertracker/rs/Service.java

Severity Category Rule Message Line
 Error
misc NewlineAtEndOfFile File does not end with a newline. 1
 Error
javadoc JavadocPackage Missing package-info.java file. 1
 Error
whitespace FileTabCharacter File contains tab characters (this is the first instance). 22
 Error
design DesignForExtension Class 'Service' looks like designed for extension (can be subclassed), but the method 'createOrder' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'Service' final or making the method 'createOrder' static/final/abstract/empty, or adding allowed annotation for the method. 22
 Error
javadoc MissingJavadocMethod Missing a Javadoc comment. 22
 Error
sizes ParameterNumber More than 7 parameters (found 8). 24
 Error
misc FinalParameters Parameter orderId should be final. 24
 Error
misc FinalParameters Parameter description should be final. 25
 Error
misc FinalParameters Parameter fromAddress should be final. 26
 Error
misc FinalParameters Parameter toAddress should be final. 27
 Error
misc FinalParameters Parameter destinationEmail should be final. 28
 Error
misc FinalParameters Parameter senderEmail should be final. 29
 Error
misc FinalParameters Parameter maxAttempts should be final. 30
 Error
misc FinalParameters Parameter comment should be final. 31
 Error
sizes LineLength Line is longer than 80 characters (found 87). 32
 Error
sizes LineLength Line is longer than 80 characters (found 97). 33
 Error
design DesignForExtension Class 'Service' looks like designed for extension (can be subclassed), but the method 'sendOrder' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'Service' final or making the method 'sendOrder' static/final/abstract/empty, or adding allowed annotation for the method. 37
 Error
javadoc MissingJavadocMethod Missing a Javadoc comment. 37
 Error
misc FinalParameters Parameter orderId should be final. 39
 Error
design DesignForExtension Class 'Service' looks like designed for extension (can be subclassed), but the method 'assignToCourier' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'Service' final or making the method 'assignToCourier' static/final/abstract/empty, or adding allowed annotation for the method. 45
 Error
javadoc MissingJavadocMethod Missing a Javadoc comment. 45
 Error
misc FinalParameters Parameter orderId should be final. 47
 Error
design DesignForExtension Class 'Service' looks like designed for extension (can be subclassed), but the method 'pickedUpByCourier' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'Service' final or making the method 'pickedUpByCourier' static/final/abstract/empty, or adding allowed annotation for the method. 53
 Error
javadoc MissingJavadocMethod Missing a Javadoc comment. 53
 Error
sizes LineLength Line is longer than 80 characters (found 81). 55
 Error
misc FinalParameters Parameter orderId should be final. 55
 Error
design DesignForExtension Class 'Service' looks like designed for extension (can be subclassed), but the method 'arrivedDepot' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'Service' final or making the method 'arrivedDepot' static/final/abstract/empty, or adding allowed annotation for the method. 61
 Error
javadoc MissingJavadocMethod Missing a Javadoc comment. 61
 Error
misc FinalParameters Parameter orderId should be final. 63
 Error
misc FinalParameters Parameter depotId should be final. 64
 Error
design DesignForExtension Class 'Service' looks like designed for extension (can be subclassed), but the method 'arrivedFinalDepot' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'Service' final or making the method 'arrivedFinalDepot' static/final/abstract/empty, or adding allowed annotation for the method. 70
 Error
javadoc MissingJavadocMethod Missing a Javadoc comment. 70
 Error
misc FinalParameters Parameter orderId should be final. 72
 Error
misc FinalParameters Parameter depotId should be final. 73
 Error
design DesignForExtension Class 'Service' looks like designed for extension (can be subclassed), but the method 'delivering' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'Service' final or making the method 'delivering' static/final/abstract/empty, or adding allowed annotation for the method. 79
 Error
javadoc MissingJavadocMethod Missing a Javadoc comment. 79
 Error
misc FinalParameters Parameter orderId should be final. 81
 Error
design DesignForExtension Class 'Service' looks like designed for extension (can be subclassed), but the method 'delivered' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'Service' final or making the method 'delivered' static/final/abstract/empty, or adding allowed annotation for the method. 87
 Error
javadoc MissingJavadocMethod Missing a Javadoc comment. 87
 Error
misc FinalParameters Parameter orderId should be final. 89
 Error
design DesignForExtension Class 'Service' looks like designed for extension (can be subclassed), but the method 'deliveryFailed' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'Service' final or making the method 'deliveryFailed' static/final/abstract/empty, or adding allowed annotation for the method. 95
 Error
javadoc MissingJavadocMethod Missing a Javadoc comment. 95
 Error
misc FinalParameters Parameter orderId should be final. 97
 Error
design DesignForExtension Class 'Service' looks like designed for extension (can be subclassed), but the method 'deliverAgain' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'Service' final or making the method 'deliverAgain' static/final/abstract/empty, or adding allowed annotation for the method. 103
 Error
javadoc MissingJavadocMethod Missing a Javadoc comment. 103
 Error
misc FinalParameters Parameter orderId should be final. 105
 Error
design DesignForExtension Class 'Service' looks like designed for extension (can be subclassed), but the method 'getOrdersReadyForDelivery' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'Service' final or making the method 'getOrdersReadyForDelivery' static/final/abstract/empty, or adding allowed annotation for the method. 111
 Error
javadoc MissingJavadocMethod Missing a Javadoc comment. 111
 Error
misc FinalParameters Parameter depotId should be final. 115
 Error
blocks NeedBraces 'for' construct must use '{}'s. 118
 Error
blocks NeedBraces 'if' construct must use '{}'s. 119
 Error
design DesignForExtension Class 'Service' looks like designed for extension (can be subclassed), but the method 'getOrderStatus' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'Service' final or making the method 'getOrderStatus' static/final/abstract/empty, or adding allowed annotation for the method. 127
 Error
javadoc MissingJavadocMethod Missing a Javadoc comment. 127
 Error
misc FinalParameters Parameter orderId should be final. 130
 Error
sizes LineLength Line is longer than 80 characters (found 83). 132

ordertracker/web/ContextListener.java

Severity Category Rule Message Line
 Error
javadoc JavadocPackage Missing package-info.java file. 1
 Error
whitespace FileTabCharacter File contains tab characters (this is the first instance). 14
 Error
javadoc JavadocVariable Missing a Javadoc comment. 14
 Error
design DesignForExtension Class 'ContextListener' looks like designed for extension (can be subclassed), but the method 'contextInitialized' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'ContextListener' final or making the method 'contextInitialized' static/final/abstract/empty, or adding allowed annotation for the method. 16
 Error
misc FinalParameters Parameter event should be final. 17
 Error
design DesignForExtension Class 'ContextListener' looks like designed for extension (can be subclassed), but the method 'contextDestroyed' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'ContextListener' final or making the method 'contextDestroyed' static/final/abstract/empty, or adding allowed annotation for the method. 26
 Error
misc FinalParameters Parameter event should be final. 27