universAAL UI kinect adapter – Checkstyle Results

Last Published: 2017 | Version: 3.4.2-SNAPSHOT

universAAL UI kinect adapter

Parent Project

universAAL UI Framework

Project Documentation

Project Information
Project Reports
- Checkstyle
- Cobertura Test Coverage
- JavaDocs
- FindBugs
- universAAL Directive Checks

Built by Maven

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.

Summary

Files	Info	Warnings	Errors
16	5	14	71

Files

File	I	W	E
org/universAAL/ui/handler/kinect/adapter/IMessageBroker/AdapterException.java	0	1	5
org/universAAL/ui/handler/kinect/adapter/IMessageBroker/IMessageBroker.java	0	1	1
org/universAAL/ui/handler/kinect/adapter/communication/receiver/MessageParser.java	1	3	6
org/universAAL/ui/handler/kinect/adapter/communication/receiver/TCPServer.java	1	2	10
org/universAAL/ui/handler/kinect/adapter/communication/receiver/Worker.java	0	0	10
org/universAAL/ui/handler/kinect/adapter/contextBus/AbstractContext.java	0	1	2
org/universAAL/ui/handler/kinect/adapter/contextBus/IContextCallback.java	0	1	1
org/universAAL/ui/handler/kinect/adapter/contextBus/IContextPublisher.java	1	0	2
org/universAAL/ui/handler/kinect/adapter/defaultComponents/DefaultAdapter.java	1	1	6
org/universAAL/ui/handler/kinect/adapter/defaultComponents/DefaultBroker.java	1	1	11
org/universAAL/ui/handler/kinect/adapter/defaultComponents/DefaultContextSubscriber.java	0	0	3
org/universAAL/ui/handler/kinect/adapter/logging/LoggerWithModuleContext.java	0	1	3
org/universAAL/ui/handler/kinect/adapter/serviceBus/AbstractService.java	0	1	3
org/universAAL/ui/handler/kinect/adapter/serviceBus/IServiceCall.java	0	0	4
org/universAAL/ui/handler/kinect/adapter/serviceBus/QueryService.java	0	1	2
org/universAAL/ui/handler/kinect/adapter/serviceBus/RequestService.java	0	0	2

Rules

Category	Rule	Violations	Severity
design	HideUtilityClassConstructor	1	Error
	VisibilityModifier protectedAllowed: `"true"`	15	Error
imports	UnusedImports	1	Info
javadoc	JavadocMethod	25	Error
	JavadocPackage allowLegacy: `"true"`	6	Warning
	JavadocStyle	19	Error
	JavadocVariable	11	Error
misc	NewlineAtEndOfFile	3	Info
naming	LocalVariableName	3	Warning
	MemberName	2	Warning
	MethodName	3	Warning
whitespace	WhitespaceAfter	1	Info

Details

org/universAAL/ui/handler/kinect/adapter/IMessageBroker/AdapterException.java

Severity	Category	Rule	Message	Line
Warning	javadoc	JavadocPackage	Missing package-info.java file.
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	28
Error	javadoc	JavadocMethod	Missing a Javadoc comment.	30
Error	javadoc	JavadocMethod	Missing a Javadoc comment.	34
Error	javadoc	JavadocMethod	Missing a Javadoc comment.	38
Error	javadoc	JavadocMethod	Missing a Javadoc comment.	42

org/universAAL/ui/handler/kinect/adapter/IMessageBroker/IMessageBroker.java

Severity	Category	Rule	Message	Line
Warning	naming	MethodName	Name 'SendNewMessage' must match pattern '^[a-z][a-zA-Z0-9]*$'.	42
Error	javadoc	JavadocMethod	Expected @throws tag for 'AdapterException'.	42

org/universAAL/ui/handler/kinect/adapter/communication/receiver/MessageParser.java

Severity	Category	Rule	Message	Line
Warning	javadoc	JavadocPackage	Missing package-info.java file.
Error	design	VisibilityModifier	Variable 'separator' must be private and have accessor methods.	37
Error	javadoc	JavadocStyle	First sentence should end with a period.	39
Error	design	VisibilityModifier	Variable 'broker' must be private and have accessor methods.	42
Error	javadoc	JavadocStyle	First sentence should end with a period.	44
Error	javadoc	JavadocMethod	Expected an @return tag.	68
Error	javadoc	JavadocMethod	Expected @throws tag for 'AdapterException'.	68
Warning	naming	LocalVariableName	Name 'square_free_args' must match pattern '^[a-z][a-zA-Z0-9]*$'.	72
Warning	naming	LocalVariableName	Name 'splitted_square_free_args' must match pattern '^[a-z][a-zA-Z0-9]*$'.	73
Info	whitespace	WhitespaceAfter	';' is not followed by whitespace.	73

org/universAAL/ui/handler/kinect/adapter/communication/receiver/TCPServer.java

Severity	Category	Rule	Message	Line
Info	misc	NewlineAtEndOfFile	File does not end with a newline.
Error	javadoc	JavadocStyle	First sentence should end with a period.	39
Error	design	VisibilityModifier	Variable 'port' must be private and have accessor methods.	42
Error	javadoc	JavadocStyle	First sentence should end with a period.	44
Warning	naming	MemberName	Name 'server_socket' must match pattern '^[a-z][a-zA-Z0-9]*$'.	47
Error	design	VisibilityModifier	Variable 'server_socket' must be private and have accessor methods.	47
Error	javadoc	JavadocStyle	First sentence should end with a period.	49
Error	design	VisibilityModifier	Variable 'threadPool' must be private and have accessor methods.	52
Error	design	VisibilityModifier	Variable 'broker' must be private and have accessor methods.	57
Error	javadoc	JavadocStyle	First sentence should end with a period.	59
Error	javadoc	JavadocMethod	Expected @param tag for 'port'.	65
Error	javadoc	JavadocMethod	Expected @param tag for 'broker'.	65
Warning	naming	LocalVariableName	Name 'server_socket' must match pattern '^[a-z][a-zA-Z0-9]*$'.	77

org/universAAL/ui/handler/kinect/adapter/communication/receiver/Worker.java

Severity	Category	Rule	Message	Line
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	36
Error	design	VisibilityModifier	Variable 'socket' must be private and have accessor methods.	36
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	37
Error	design	VisibilityModifier	Variable 'br' must be private and have accessor methods.	37
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	38
Error	design	VisibilityModifier	Variable 'osw' must be private and have accessor methods.	38
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	39
Error	design	VisibilityModifier	Variable 'parser' must be private and have accessor methods.	39
Error	javadoc	JavadocMethod	Missing a Javadoc comment.	41
Error	javadoc	JavadocStyle	First sentence should end with a period.	47

org/universAAL/ui/handler/kinect/adapter/contextBus/AbstractContext.java

Severity	Category	Rule	Message	Line
Warning	javadoc	JavadocPackage	Missing package-info.java file.
Error	javadoc	JavadocStyle	First sentence should end with a period.	33
Error	javadoc	JavadocMethod	Expected an @return tag.	38

org/universAAL/ui/handler/kinect/adapter/contextBus/IContextCallback.java

Severity	Category	Rule	Message	Line
Error	javadoc	JavadocStyle	First sentence should end with a period.	28
Warning	naming	MethodName	Name 'CallbackForHandleContextEvent' must match pattern '^[a-z][a-zA-Z0-9]*$'.	34

org/universAAL/ui/handler/kinect/adapter/contextBus/IContextPublisher.java

Severity	Category	Rule	Message	Line
Info	imports	UnusedImports	Unused import - org.universAAL.middleware.context.ContextEvent.	21
Error	javadoc	JavadocStyle	First sentence should end with a period.	28
Error	javadoc	JavadocMethod	Expected @throws tag for 'AdapterException'.	35

org/universAAL/ui/handler/kinect/adapter/defaultComponents/DefaultAdapter.java

Severity	Category	Rule	Message	Line
Info	misc	NewlineAtEndOfFile	File does not end with a newline.
Warning	javadoc	JavadocPackage	Missing package-info.java file.
Error	javadoc	JavadocStyle	First sentence should end with a period.	31
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	38
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	39
Error	javadoc	JavadocMethod	Missing a Javadoc comment.	41
Error	javadoc	JavadocMethod	Missing a Javadoc comment.	47
Error	javadoc	JavadocMethod	Missing a Javadoc comment.	51

org/universAAL/ui/handler/kinect/adapter/defaultComponents/DefaultBroker.java

Severity	Category	Rule	Message	Line
Info	misc	NewlineAtEndOfFile	File does not end with a newline.
Error	javadoc	JavadocStyle	First sentence should end with a period.	41
Error	javadoc	JavadocStyle	First sentence should end with a period.	45
Error	javadoc	JavadocStyle	First sentence should end with a period.	49
Error	design	VisibilityModifier	Variable 'hp' must be private and have accessor methods.	52
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	53
Error	design	VisibilityModifier	Variable 'service' must be private and have accessor methods.	53
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	54
Error	design	VisibilityModifier	Variable 'context' must be private and have accessor methods.	54
Error	javadoc	JavadocMethod	Missing a Javadoc comment.	56
Error	javadoc	JavadocMethod	Missing a Javadoc comment.	63
Error	javadoc	JavadocMethod	Missing a Javadoc comment.	67
Warning	naming	MethodName	Name 'SendNewMessage' must match pattern '^[a-z][a-zA-Z0-9]*$'.	67

org/universAAL/ui/handler/kinect/adapter/defaultComponents/DefaultContextSubscriber.java

Severity	Category	Rule	Message	Line
Error	design	VisibilityModifier	Variable 'callback' must be private and have accessor methods.	39
Error	javadoc	JavadocMethod	Missing a Javadoc comment.	41
Error	javadoc	JavadocMethod	Expected @param tag for 'event'.	55

org/universAAL/ui/handler/kinect/adapter/logging/LoggerWithModuleContext.java

Severity	Category	Rule	Message	Line
Warning	javadoc	JavadocPackage	Missing package-info.java file.
Error	design	HideUtilityClassConstructor	Utility classes should not have a public or default constructor.	28
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	29
Error	design	VisibilityModifier	Variable 'mc' must be private and have accessor methods.	29

org/universAAL/ui/handler/kinect/adapter/serviceBus/AbstractService.java

Severity	Category	Rule	Message	Line
Warning	javadoc	JavadocPackage	Missing package-info.java file.
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	36
Error	javadoc	JavadocMethod	Missing a Javadoc comment.	38
Error	javadoc	JavadocStyle	First sentence should end with a period.	51

org/universAAL/ui/handler/kinect/adapter/serviceBus/IServiceCall.java

Severity	Category	Rule	Message	Line
Error	javadoc	JavadocStyle	First sentence should end with a period.	25
Error	javadoc	JavadocStyle	First sentence should end with a period.	31
Error	javadoc	JavadocMethod	Expected an @return tag.	39
Error	javadoc	JavadocMethod	Expected @throws tag for 'AdapterException'.	39

org/universAAL/ui/handler/kinect/adapter/serviceBus/QueryService.java

Severity	Category	Rule	Message	Line
Error	javadoc	JavadocStyle	First sentence should end with a period.	28
Warning	naming	MemberName	Name 'IDforResult' must match pattern '^[a-z][a-zA-Z0-9]*$'.	39
Error	javadoc	JavadocMethod	Missing a Javadoc comment.	69

org/universAAL/ui/handler/kinect/adapter/serviceBus/RequestService.java

Severity	Category	Rule	Message	Line
Error	javadoc	JavadocStyle	First sentence should end with a period.	28
Error	javadoc	JavadocMethod	Missing a Javadoc comment.	50