Checkstyle Results

The following document contains the results of Checkstyle 6.11.2 with http://depot.universaal.org/Resources/Checkstyle/uaal-checkstyle-config.xml ruleset. rss feed

Summary

Files  Info  Warnings  Errors
11 0 4 120

Files

File  I  W  E
org/universAAL/middleware/modules/CommunicationModule.java 0 0 29
org/universAAL/middleware/modules/ConfigurableCommunicationModule.java 0 0 8
org/universAAL/middleware/modules/DeployModule.java 0 0 3
org/universAAL/middleware/modules/Module.java 0 1 7
org/universAAL/middleware/modules/SpaceModule.java 0 0 21
org/universAAL/middleware/modules/exception/CommunicationModuleErrorCode.java 0 0 5
org/universAAL/middleware/modules/exception/CommunicationModuleException.java 0 0 13
org/universAAL/middleware/modules/exception/SpaceModuleErrorCode.java 0 1 14
org/universAAL/middleware/modules/exception/SpaceModuleException.java 0 0 7
org/universAAL/middleware/modules/listener/MessageListener.java 0 1 6
org/universAAL/middleware/modules/util/Consts.java 0 1 7

Rules

Category Rule Violations Severity
design DesignForExtension 5  Error
HideUtilityClassConstructor 3  Error
javadoc JavadocMethod 51  Error
JavadocPackage
  • allowLegacy: "true"
 4  Warning
JavadocStyle 36  Error
JavadocVariable 25  Error

Details

org/universAAL/middleware/modules/CommunicationModule.java

Severity Category Rule Message Line
 Error javadoc JavadocMethod Expected @param tag for 'channelMessage'. 45
 Error javadoc JavadocStyle First sentence should end with a period. 47
 Error javadoc JavadocMethod Expected @throws tag for 'CommunicationModuleException'. 58
 Error javadoc JavadocMethod Expected @param tag for 'message'. 67
 Error javadoc JavadocMethod Expected @param tag for 'receivers'. 67
 Error javadoc JavadocMethod Expected @throws tag for 'CommunicationModuleException'. 67
 Error javadoc JavadocStyle First sentence should end with a period. 69
 Error javadoc JavadocMethod Expected @param tag for 'message'. 76
 Error javadoc JavadocMethod Expected @throws tag for 'CommunicationModuleException'. 76
 Error javadoc JavadocStyle First sentence should end with a period. 78
 Error javadoc JavadocMethod Expected @param tag for 'message'. 83
 Error javadoc JavadocMethod Expected @throws tag for 'CommunicationModuleException'. 83
 Error javadoc JavadocStyle First sentence should end with a period. 85
 Error javadoc JavadocMethod Expected @param tag for 'message'. 93
 Error javadoc JavadocMethod Expected @param tag for 'receiver'. 93
 Error javadoc JavadocMethod Expected @throws tag for 'CommunicationModuleException'. 94
 Error javadoc JavadocStyle First sentence should end with a period. 96
 Error javadoc JavadocMethod Expected @param tag for 'message'. 103
 Error javadoc JavadocMethod Expected @param tag for 'receiver'. 103
 Error javadoc JavadocMethod Expected @throws tag for 'CommunicationModuleException'. 103
 Error javadoc JavadocStyle First sentence should end with a period. 105
 Error javadoc JavadocMethod Expected @param tag for 'listener'. 111
 Error javadoc JavadocMethod Expected @param tag for 'channelName'. 111
 Error javadoc JavadocStyle First sentence should end with a period. 113
 Error javadoc JavadocMethod Expected @param tag for 'listener'. 120
 Error javadoc JavadocMethod Expected @param tag for 'channelName'. 120
 Error javadoc JavadocMethod Expected an @return tag. 129
 Error javadoc JavadocMethod Expected @param tag for 'name'. 129
 Error javadoc JavadocMethod Expected @param tag for 'clz'. 129

org/universAAL/middleware/modules/ConfigurableCommunicationModule.java

Severity Category Rule Message Line
 Error javadoc JavadocStyle First sentence should end with a period. 27
 Error javadoc JavadocStyle First sentence should end with a period. 34
 Error javadoc JavadocMethod Expected @param tag for 'communicationChannels'. 40
 Error javadoc JavadocMethod Expected @param tag for 'peerName'. 40
 Error javadoc JavadocStyle First sentence should end with a period. 42
 Error javadoc JavadocMethod Expected @param tag for 'communicationChannels'. 47
 Error javadoc JavadocStyle First sentence should end with a period. 49
 Error javadoc JavadocMethod Expected @param tag for 'groupName'. 55

org/universAAL/middleware/modules/DeployModule.java

Severity Category Rule Message Line
 Error javadoc JavadocStyle First sentence should end with a period. 23
 Error javadoc JavadocStyle First sentence should end with a period. 31
 Error javadoc JavadocStyle First sentence should end with a period. 41

org/universAAL/middleware/modules/Module.java

Severity Category Rule Message Line
 Warning javadoc JavadocPackage Missing package-info.java file.
 Error javadoc JavadocMethod Missing a Javadoc comment. 31
 Error javadoc JavadocMethod Missing a Javadoc comment. 33
 Error javadoc JavadocMethod Missing a Javadoc comment. 35
 Error javadoc JavadocMethod Missing a Javadoc comment. 37
 Error javadoc JavadocMethod Missing a Javadoc comment. 39
 Error javadoc JavadocStyle First sentence should end with a period. 41
 Error javadoc JavadocMethod Expected an @return tag. 52

org/universAAL/middleware/modules/SpaceModule.java

Severity Category Rule Message Line
 Error javadoc JavadocStyle First sentence should end with a period. 38
 Error javadoc JavadocStyle First sentence should end with a period. 45
 Error javadoc JavadocMethod Expected an @return tag. 52
 Error javadoc JavadocStyle First sentence should end with a period. 54
 Error javadoc JavadocMethod Unused @param tag for 'configurations'. 57
 Error javadoc JavadocMethod Expected @param tag for 'spaceCard'. 61
 Error javadoc JavadocStyle First sentence should end with a period. 63
 Error javadoc JavadocMethod Expected @param tag for 'spaceCard'. 68
 Error javadoc JavadocStyle First sentence should end with a period. 70
 Error javadoc JavadocStyle First sentence should end with a period. 78
 Error javadoc JavadocStyle First sentence should end with a period. 89
 Error javadoc JavadocMethod Expected @param tag for 'spaceCoordinator'. 95
 Error javadoc JavadocStyle First sentence should end with a period. 97
 Error javadoc JavadocMethod Expected @param tag for 'spaceDescriptor'. 102
 Error javadoc JavadocStyle First sentence should end with a period. 104
 Error javadoc JavadocStyle First sentence should end with a period. 115
 Error javadoc JavadocMethod Expected @param tag for 'message'. 120
 Error javadoc JavadocMethod Expected @param tag for 'sender'. 120
 Error javadoc JavadocStyle First sentence should end with a period. 132
 Error javadoc JavadocStyle First sentence should end with a period. 142
 Error javadoc JavadocStyle First sentence should end with a period. 148

org/universAAL/middleware/modules/exception/CommunicationModuleErrorCode.java

Severity Category Rule Message Line
 Error javadoc JavadocStyle First sentence should end with a period. 23
 Error design HideUtilityClassConstructor Utility classes should not have a public or default constructor. 30
 Error javadoc JavadocVariable Missing a Javadoc comment. 32
 Error javadoc JavadocVariable Missing a Javadoc comment. 33
 Error javadoc JavadocVariable Missing a Javadoc comment. 34

org/universAAL/middleware/modules/exception/CommunicationModuleException.java

Severity Category Rule Message Line
 Error javadoc JavadocStyle First sentence should end with a period. 23
 Error javadoc JavadocVariable Missing a Javadoc comment. 32
 Error design DesignForExtension Method 'getDescription' is not designed for extension - needs to be abstract, final or empty. 34
 Error javadoc JavadocMethod Missing a Javadoc comment. 34
 Error design DesignForExtension Method 'setDescription' is not designed for extension - needs to be abstract, final or empty. 38
 Error javadoc JavadocMethod Missing a Javadoc comment. 38
 Error design DesignForExtension Method 'getErrorCode' is not designed for extension - needs to be abstract, final or empty. 42
 Error javadoc JavadocMethod Missing a Javadoc comment. 42
 Error design DesignForExtension Method 'setErrorCode' is not designed for extension - needs to be abstract, final or empty. 46
 Error javadoc JavadocMethod Missing a Javadoc comment. 46
 Error javadoc JavadocVariable Missing a Javadoc comment. 50
 Error javadoc JavadocMethod Missing a Javadoc comment. 52
 Error javadoc JavadocMethod Missing a Javadoc comment. 58

org/universAAL/middleware/modules/exception/SpaceModuleErrorCode.java

Severity Category Rule Message Line
 Warning javadoc JavadocPackage Missing package-info.java file.
 Error javadoc JavadocStyle First sentence should end with a period. 23
 Error design HideUtilityClassConstructor Utility classes should not have a public or default constructor. 30
 Error javadoc JavadocVariable Missing a Javadoc comment. 31
 Error javadoc JavadocVariable Missing a Javadoc comment. 32
 Error javadoc JavadocVariable Missing a Javadoc comment. 33
 Error javadoc JavadocVariable Missing a Javadoc comment. 34
 Error javadoc JavadocVariable Missing a Javadoc comment. 35
 Error javadoc JavadocVariable Missing a Javadoc comment. 36
 Error javadoc JavadocVariable Missing a Javadoc comment. 37
 Error javadoc JavadocVariable Missing a Javadoc comment. 38
 Error javadoc JavadocVariable Missing a Javadoc comment. 40
 Error javadoc JavadocVariable Missing a Javadoc comment. 41
 Error javadoc JavadocVariable Missing a Javadoc comment. 42
 Error javadoc JavadocVariable Missing a Javadoc comment. 44

org/universAAL/middleware/modules/exception/SpaceModuleException.java

Severity Category Rule Message Line
 Error javadoc JavadocStyle First sentence should end with a period. 23
 Error javadoc JavadocVariable Missing a Javadoc comment. 31
 Error javadoc JavadocVariable Missing a Javadoc comment. 32
 Error javadoc JavadocVariable Missing a Javadoc comment. 33
 Error javadoc JavadocMethod Missing a Javadoc comment. 35
 Error design DesignForExtension Method 'toString' is not designed for extension - needs to be abstract, final or empty. 41
 Error javadoc JavadocMethod Missing a Javadoc comment. 41

org/universAAL/middleware/modules/listener/MessageListener.java

Severity Category Rule Message Line
 Warning javadoc JavadocPackage Missing package-info.java file.
 Error javadoc JavadocStyle First sentence should end with a period. 26
 Error javadoc JavadocStyle First sentence should end with a period. 35
 Error javadoc JavadocMethod Expected @param tag for 'message'. 40
 Error javadoc JavadocStyle First sentence should end with a period. 42
 Error javadoc JavadocMethod Expected @param tag for 'message'. 48
 Error javadoc JavadocMethod Expected @param tag for 'e'. 48

org/universAAL/middleware/modules/util/Consts.java

Severity Category Rule Message Line
 Warning javadoc JavadocPackage Missing package-info.java file.
 Error javadoc JavadocStyle First sentence should end with a period. 23
 Error design HideUtilityClassConstructor Utility classes should not have a public or default constructor. 29
 Error javadoc JavadocVariable Missing a Javadoc comment. 31
 Error javadoc JavadocVariable Missing a Javadoc comment. 32
 Error javadoc JavadocVariable Missing a Javadoc comment. 33
 Error javadoc JavadocVariable Missing a Javadoc comment. 34
 Error javadoc JavadocVariable Missing a Javadoc comment. 35