Checkstyle Results

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

rss feed

Summary

Files
 Info
 Warnings
 Errors
7 0 0 138

Files

File
 I
 W
 E
ordertracker/App.java 0 0 9
ordertracker/AppTest.java 0 0 56
ordertracker/DepotBehaviour.java 0 0 7
ordertracker/EventService.java 0 0 8
ordertracker/OrderBehaviour.java 0 0 46
ordertracker/StateDiagramViewerMain.java 0 0 3
ordertracker/SystemEventBehaviour.java 0 0 9

Rules

Category Rule Violations Severity
blocks NeedBraces 8
 Error
coding HiddenField 3
 Error
MagicNumber 13
 Error
design DesignForExtension 20
 Error
HideUtilityClassConstructor 2
 Error
VisibilityModifier 1
 Error
javadoc JavadocPackage 2
 Error
JavadocVariable 8
 Error
MissingJavadocMethod 14
 Error
misc FinalParameters 32
 Error
NewlineAtEndOfFile 2
 Error
naming ConstantName 1
 Error
sizes LineLength
  • fileExtensions: "java"
 32
 Error

Details

ordertracker/App.java

Severity Category Rule Message Line
 Error		 misc NewlineAtEndOfFile File does not end with a newline. 1
 Error		 design HideUtilityClassConstructor Utility classes should not have a public or default constructor. 8
 Error		 javadoc JavadocVariable Missing a Javadoc comment. 10
 Error		 javadoc MissingJavadocMethod Missing a Javadoc comment. 12
 Error		 sizes LineLength Line is longer than 80 characters (found 97). 17
 Error		 sizes LineLength Line is longer than 80 characters (found 81). 21
 Error		 coding MagicNumber '-35.0' is a magic number. 34
 Error		 coding MagicNumber '142.0' is a magic number. 34
 Error		 javadoc MissingJavadocMethod Missing a Javadoc comment. 39

ordertracker/AppTest.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		 javadoc JavadocVariable Missing a Javadoc comment. 30
 Error		 naming ConstantName Name 'log' must match pattern '^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$'. 30
 Error		 sizes LineLength Line is longer than 80 characters (found 93). 32
 Error		 javadoc JavadocVariable Missing a Javadoc comment. 32
 Error		 javadoc MissingJavadocMethod Missing a Javadoc comment. 34
 Error		 blocks NeedBraces 'for' construct must use '{}'s. 37
 Error		 sizes LineLength Line is longer than 80 characters (found 94). 37
 Error		 sizes LineLength Line is longer than 80 characters (found 95). 39
 Error		 sizes LineLength Line is longer than 80 characters (found 88). 41
 Error		 javadoc MissingJavadocMethod Missing a Javadoc comment. 48
 Error		 javadoc MissingJavadocMethod Missing a Javadoc comment. 53
 Error		 sizes LineLength Line is longer than 80 characters (found 97). 57
 Error		 misc FinalParameters Parameter event should be final. 59
 Error		 sizes LineLength Line is longer than 80 characters (found 85). 64
 Error		 coding MagicNumber '3' is a magic number. 65
 Error		 coding MagicNumber '5000' is a magic number. 66
 Error		 javadoc MissingJavadocMethod Missing a Javadoc comment. 69
 Error		 sizes LineLength Line is longer than 80 characters (found 99). 72
 Error		 sizes LineLength Line is longer than 80 characters (found 93). 73
 Error		 sizes LineLength Line is longer than 80 characters (found 95). 74
 Error		 blocks NeedBraces 'for' construct must use '{}'s. 76
 Error		 sizes LineLength Line is longer than 80 characters (found 91). 80
 Error		 sizes LineLength Line is longer than 80 characters (found 97). 87
 Error		 coding MagicNumber '-35.0' is a magic number. 87
 Error		 coding MagicNumber '142.0' is a magic number. 87
 Error		 sizes LineLength Line is longer than 80 characters (found 97). 88
 Error		 sizes LineLength Line is longer than 80 characters (found 81). 89
 Error		 coding MagicNumber '3' is a magic number. 89
 Error		 javadoc MissingJavadocMethod Missing a Javadoc comment. 112
 Error		 sizes LineLength Line is longer than 80 characters (found 99). 115
 Error		 sizes LineLength Line is longer than 80 characters (found 93). 116
 Error		 sizes LineLength Line is longer than 80 characters (found 100). 117
 Error		 sizes LineLength Line is longer than 80 characters (found 91). 118
 Error		 sizes LineLength Line is longer than 80 characters (found 91). 120
 Error		 sizes LineLength Line is longer than 80 characters (found 97). 121
 Error		 blocks NeedBraces 'for' construct must use '{}'s. 124
 Error		 sizes LineLength Line is longer than 80 characters (found 91). 128
 Error		 sizes LineLength Line is longer than 80 characters (found 97). 133
 Error		 coding MagicNumber '3' is a magic number. 134
 Error		 sizes LineLength Line is longer than 80 characters (found 83). 135
 Error		 coding MagicNumber '-35.0' is a magic number. 135
 Error		 coding MagicNumber '142.0' is a magic number. 135
 Error		 misc FinalParameters Parameter states should be final. 166
 Error		 blocks NeedBraces 'for' construct must use '{}'s. 168
 Error		 misc FinalParameters Parameter latches should be final. 173
 Error		 misc FinalParameters Parameter expectedStates should be final. 174
 Error		 misc FinalParameters Parameter states should be final. 174
 Error		 misc FinalParameters Parameter index should be final. 174
 Error		 sizes LineLength Line is longer than 80 characters (found 96). 177
 Error		 coding MagicNumber '120' is a magic number. 178
 Error		 sizes LineLength Line is longer than 80 characters (found 89). 180
 Error		 design VisibilityModifier Variable 'count' must be private and have accessor methods. 187
 Error		 misc FinalParameters Parameter e should be final. 194
 Error		 misc FinalParameters Parameter state should be final. 199

ordertracker/DepotBehaviour.java

Severity Category Rule Message Line
 Error		 javadoc JavadocVariable Missing a Javadoc comment. 7
 Error		 javadoc MissingJavadocMethod Missing a Javadoc comment. 9
 Error		 misc FinalParameters Parameter self should be final. 9
 Error		 coding HiddenField 'self' hides a field. 9
 Error		 design DesignForExtension Class 'DepotBehaviour' looks like designed for extension (can be subclassed), but the method 'onEntryCreated' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'DepotBehaviour' final or making the method 'onEntryCreated' static/final/abstract/empty, or adding allowed annotation for the method. 13
 Error		 misc FinalParameters Parameter event should be final. 14
 Error		 sizes LineLength Line is longer than 80 characters (found 100). 16

ordertracker/EventService.java

Severity Category Rule Message Line
 Error		 javadoc JavadocVariable Missing a Javadoc comment. 8
 Error		 javadoc JavadocVariable Missing a Javadoc comment. 10
 Error		 javadoc MissingJavadocMethod Missing a Javadoc comment. 12
 Error		 design DesignForExtension Class 'EventService' looks like designed for extension (can be subclassed), but the method 'event' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'EventService' final or making the method 'event' static/final/abstract/empty, or adding allowed annotation for the method. 16
 Error		 javadoc MissingJavadocMethod Missing a Javadoc comment. 16
 Error		 misc FinalParameters Parameter data should be final. 16
 Error		 design DesignForExtension Class 'EventService' looks like designed for extension (can be subclassed), but the method 'events' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'EventService' final or making the method 'events' static/final/abstract/empty, or adding allowed annotation for the method. 20
 Error		 javadoc MissingJavadocMethod Missing a Javadoc comment. 20

ordertracker/OrderBehaviour.java

Severity Category Rule Message Line
 Error		 javadoc JavadocVariable Missing a Javadoc comment. 26
 Error		 javadoc MissingJavadocMethod Missing a Javadoc comment. 28
 Error		 misc FinalParameters Parameter self should be final. 28
 Error		 coding HiddenField 'self' hides a field. 28
 Error		 design DesignForExtension Class 'OrderBehaviour' looks like designed for extension (can be subclassed), but the method 'onEntryPreparing' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'OrderBehaviour' final or making the method 'onEntryPreparing' static/final/abstract/empty, or adding allowed annotation for the method. 32
 Error		 misc FinalParameters Parameter event should be final. 33
 Error		 design DesignForExtension Class 'OrderBehaviour' looks like designed for extension (can be subclassed), but the method 'onEntryReadyForDispatch' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'OrderBehaviour' final or making the method 'onEntryReadyForDispatch' static/final/abstract/empty, or adding allowed annotation for the method. 46
 Error		 misc FinalParameters Parameter event should be final. 47
 Error		 design DesignForExtension Class 'OrderBehaviour' looks like designed for extension (can be subclassed), but the method 'onEntryCourierAssigned' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'OrderBehaviour' final or making the method 'onEntryCourierAssigned' static/final/abstract/empty, or adding allowed annotation for the method. 51
 Error		 misc FinalParameters Parameter event should be final. 52
 Error		 design DesignForExtension Class 'OrderBehaviour' looks like designed for extension (can be subclassed), but the method 'onEntryInTransit' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'OrderBehaviour' final or making the method 'onEntryInTransit' static/final/abstract/empty, or adding allowed annotation for the method. 56
 Error		 misc FinalParameters Parameter event should be final. 57
 Error		 design DesignForExtension Class 'OrderBehaviour' looks like designed for extension (can be subclassed), but the method 'onEntryInTransit' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'OrderBehaviour' final or making the method 'onEntryInTransit' static/final/abstract/empty, or adding allowed annotation for the method. 61
 Error		 misc FinalParameters Parameter event should be final. 62
 Error		 blocks NeedBraces 'if' construct must use '{}'s. 64
 Error		 sizes LineLength Line is longer than 80 characters (found 86). 65
 Error		 design DesignForExtension Class 'OrderBehaviour' looks like designed for extension (can be subclassed), but the method 'onEntryReadyForDelivery' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'OrderBehaviour' final or making the method 'onEntryReadyForDelivery' static/final/abstract/empty, or adding allowed annotation for the method. 72
 Error		 misc FinalParameters Parameter event should be final. 73
 Error		 blocks NeedBraces 'if' construct must use '{}'s. 75
 Error		 sizes LineLength Line is longer than 80 characters (found 86). 76
 Error		 design DesignForExtension Class 'OrderBehaviour' looks like designed for extension (can be subclassed), but the method 'onEntryDelivering' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'OrderBehaviour' final or making the method 'onEntryDelivering' static/final/abstract/empty, or adding allowed annotation for the method. 83
 Error		 misc FinalParameters Parameter event should be final. 84
 Error		 design DesignForExtension Class 'OrderBehaviour' looks like designed for extension (can be subclassed), but the method 'onEntryDelivered' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'OrderBehaviour' final or making the method 'onEntryDelivered' static/final/abstract/empty, or adding allowed annotation for the method. 89
 Error		 misc FinalParameters Parameter event should be final. 90
 Error		 design DesignForExtension Class 'OrderBehaviour' looks like designed for extension (can be subclassed), but the method 'onEntryDeliveryFailed' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'OrderBehaviour' final or making the method 'onEntryDeliveryFailed' static/final/abstract/empty, or adding allowed annotation for the method. 96
 Error		 misc FinalParameters Parameter event should be final. 97
 Error		 blocks NeedBraces 'if' construct must use '{}'s. 99
 Error		 blocks NeedBraces 'else' construct must use '{}'s. 101
 Error		 design DesignForExtension Class 'OrderBehaviour' looks like designed for extension (can be subclassed), but the method 'onEntryAwaitingNextDeliveryAttempt' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'OrderBehaviour' final or making the method 'onEntryAwaitingNextDeliveryAttempt' static/final/abstract/empty, or adding allowed annotation for the method. 105
 Error		 misc FinalParameters Parameter event should be final. 106
 Error		 sizes LineLength Line is longer than 80 characters (found 97). 107
 Error		 coding MagicNumber '12' is a magic number. 107
 Error		 design DesignForExtension Class 'OrderBehaviour' looks like designed for extension (can be subclassed), but the method 'onEntryHeldForPickup' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'OrderBehaviour' final or making the method 'onEntryHeldForPickup' static/final/abstract/empty, or adding allowed annotation for the method. 111
 Error		 misc FinalParameters Parameter event should be final. 112
 Error		 design DesignForExtension Class 'OrderBehaviour' looks like designed for extension (can be subclassed), but the method 'onEntryHeldForPickup' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'OrderBehaviour' final or making the method 'onEntryHeldForPickup' static/final/abstract/empty, or adding allowed annotation for the method. 116
 Error		 misc FinalParameters Parameter event should be final. 117
 Error		 sizes LineLength Line is longer than 80 characters (found 99). 122
 Error		 coding MagicNumber '14' is a magic number. 122
 Error		 design DesignForExtension Class 'OrderBehaviour' looks like designed for extension (can be subclassed), but the method 'onEntryReturnToSender' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'OrderBehaviour' final or making the method 'onEntryReturnToSender' static/final/abstract/empty, or adding allowed annotation for the method. 126
 Error		 misc FinalParameters Parameter event should be final. 127
 Error		 design DesignForExtension Class 'OrderBehaviour' looks like designed for extension (can be subclassed), but the method 'onEntryDelivered' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'OrderBehaviour' final or making the method 'onEntryDelivered' static/final/abstract/empty, or adding allowed annotation for the method. 132
 Error		 misc FinalParameters Parameter event should be final. 133
 Error		 misc FinalParameters Parameter state should be final. 137
 Error		 sizes LineLength Line is longer than 80 characters (found 94). 139
 Error		 design DesignForExtension Class 'OrderBehaviour' looks like designed for extension (can be subclassed), but the method 'onEntryReadyForDelivery' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'OrderBehaviour' final or making the method 'onEntryReadyForDelivery' static/final/abstract/empty, or adding allowed annotation for the method. 142
 Error		 misc FinalParameters Parameter event should be final. 143

ordertracker/StateDiagramViewerMain.java

Severity Category Rule Message Line
 Error		 design HideUtilityClassConstructor Utility classes should not have a public or default constructor. 7
 Error		 javadoc MissingJavadocMethod Missing a Javadoc comment. 9
 Error		 misc FinalParameters Parameter args should be final. 9

ordertracker/SystemEventBehaviour.java

Severity Category Rule Message Line
 Error		 javadoc JavadocPackage Missing package-info.java file. 1
 Error		 javadoc JavadocVariable Missing a Javadoc comment. 8
 Error		 javadoc MissingJavadocMethod Missing a Javadoc comment. 10
 Error		 misc FinalParameters Parameter self should be final. 10
 Error		 coding HiddenField 'self' hides a field. 10
 Error		 design DesignForExtension Class 'SystemEventBehaviour' looks like designed for extension (can be subclassed), but the method 'onEntryCreated' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'SystemEventBehaviour' final or making the method 'onEntryCreated' static/final/abstract/empty, or adding allowed annotation for the method. 14
 Error		 misc FinalParameters Parameter event should be final. 15
 Error		 design DesignForExtension Class 'SystemEventBehaviour' looks like designed for extension (can be subclassed), but the method 'onEntryCreated' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'SystemEventBehaviour' final or making the method 'onEntryCreated' static/final/abstract/empty, or adding allowed annotation for the method. 19
 Error		 misc FinalParameters Parameter event should be final. 20