universAAL Middleware Manager API (Core) – Checkstyle Results

Last Published: 2017 | Version: 3.4.2-SNAPSHOT

universAAL Middleware Manager API (Core)

Parent Project

universAAL Middleware Suite (Core)

Project Documentation

Project Information
Project Reports
- Checkstyle
- 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	6	1	104

Files

File	I	W	E
org/universAAL/middleware/managers/api/ConfigurationEditor.java	2	0	1
org/universAAL/middleware/managers/api/ConfigurationManagerConnector.java	0	0	3
org/universAAL/middleware/managers/api/DeployManager.java	2	0	3
org/universAAL/middleware/managers/api/DeployManagerEventHandler.java	0	0	2
org/universAAL/middleware/managers/api/DistributedMWEventHandler.java	0	0	2
org/universAAL/middleware/managers/api/InstallationResults.java	1	0	14
org/universAAL/middleware/managers/api/InstallationResultsDetails.java	1	0	15
org/universAAL/middleware/managers/api/Manager.java	0	0	3
org/universAAL/middleware/managers/api/MatchingResult.java	0	0	1
org/universAAL/middleware/managers/api/SpaceEventHandler.java	0	0	16
org/universAAL/middleware/managers/api/SpaceListener.java	0	0	8
org/universAAL/middleware/managers/api/SpaceManager.java	0	0	17
org/universAAL/middleware/managers/api/TenantListener.java	0	0	3
org/universAAL/middleware/managers/api/TenantManager.java	0	1	7
org/universAAL/middleware/managers/api/UAPPPackage.java	0	0	9

Rules

Category	Rule	Violations	Severity
design	DesignForExtension	10	Error
imports	UnusedImports	4	Info
javadoc	JavadocMethod	35	Error
	JavadocPackage allowLegacy: `"true"`	1	Warning
	JavadocStyle	34	Error
	JavadocType	1	Error
	JavadocVariable	24	Error
sizes	LineLength max: `"120"` tabWidth: `"4"`	2	Info

Details

org/universAAL/middleware/managers/api/ConfigurationEditor.java

Severity	Category	Rule	Message	Line
Info	imports	UnusedImports	Unused import - org.universAAL.middleware.interfaces.configuration.ConfigurableModule.	23
Info	imports	UnusedImports	Unused import - org.universAAL.middleware.interfaces.configuration.configurationDefinitionTypes.DescribedEntity.	24
Error	javadoc	JavadocMethod	Expected @param tag for 'manager'.	98

org/universAAL/middleware/managers/api/ConfigurationManagerConnector.java

Severity	Category	Rule	Message	Line
Error	javadoc	JavadocMethod	Expected @param tag for 'message'.	35
Error	javadoc	JavadocMethod	Expected @param tag for 'message'.	42
Error	javadoc	JavadocMethod	Expected @param tag for 'message'.	49

org/universAAL/middleware/managers/api/DeployManager.java

Severity	Category	Rule	Message	Line
Info	imports	UnusedImports	Unused import - java.net.URI.	24
Info	imports	UnusedImports	Unused import - java.util.Map.	25
Error	javadoc	JavadocStyle	First sentence should end with a period.	27
Error	javadoc	JavadocStyle	First sentence should end with a period.	50
Error	javadoc	JavadocStyle	First sentence should end with a period.	58

org/universAAL/middleware/managers/api/DeployManagerEventHandler.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.	38

org/universAAL/middleware/managers/api/DistributedMWEventHandler.java

Severity	Category	Rule	Message	Line
Error	javadoc	JavadocType	Missing a Javadoc comment.	25
Error	javadoc	JavadocMethod	Missing a Javadoc comment.	27

org/universAAL/middleware/managers/api/InstallationResults.java

Severity	Category	Rule	Message	Line
Info	sizes	LineLength	Line is longer than 120 characters (found 250).	30
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	30
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	30
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	30
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	30
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	30
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	30
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	30
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	30
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	30
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	30
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	30
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	30
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	30
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	30

org/universAAL/middleware/managers/api/InstallationResultsDetails.java

Severity	Category	Rule	Message	Line
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	37
Info	sizes	LineLength	Line is longer than 120 characters (found 124).	38
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	38
Error	javadoc	JavadocMethod	Missing a Javadoc comment.	40
Error	design	DesignForExtension	Method 'setDetailedResult' is not designed for extension - needs to be abstract, final or empty.	44
Error	javadoc	JavadocMethod	Missing a Javadoc comment.	44
Error	design	DesignForExtension	Method 'setDetailedResult' is not designed for extension - needs to be abstract, final or empty.	53
Error	javadoc	JavadocMethod	Missing a Javadoc comment.	53
Error	design	DesignForExtension	Method 'getDetailedResult' is not designed for extension - needs to be abstract, final or empty.	57
Error	javadoc	JavadocMethod	Missing a Javadoc comment.	57
Error	design	DesignForExtension	Method 'getDetailedResult' is not designed for extension - needs to be abstract, final or empty.	65
Error	javadoc	JavadocMethod	Missing a Javadoc comment.	65
Error	design	DesignForExtension	Method 'getGlobalResult' is not designed for extension - needs to be abstract, final or empty.	69
Error	javadoc	JavadocMethod	Missing a Javadoc comment.	69
Error	design	DesignForExtension	Method 'setGlobalResult' is not designed for extension - needs to be abstract, final or empty.	73
Error	javadoc	JavadocMethod	Missing a Javadoc comment.	73

org/universAAL/middleware/managers/api/Manager.java

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

org/universAAL/middleware/managers/api/MatchingResult.java

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

org/universAAL/middleware/managers/api/SpaceEventHandler.java

Severity	Category	Rule	Message	Line
Error	javadoc	JavadocMethod	Expected @param tag for 'spaceCard'.	55
Error	javadoc	JavadocMethod	Expected @param tag for 'sender'.	55
Error	javadoc	JavadocStyle	First sentence should end with a period.	57
Error	javadoc	JavadocMethod	Expected @param tag for 'spaceCard'.	62
Error	javadoc	JavadocStyle	First sentence should end with a period.	64
Error	javadoc	JavadocMethod	Expected @param tag for 'peer'.	70
Error	javadoc	JavadocStyle	First sentence should end with a period.	72
Error	javadoc	JavadocMethod	Expected @param tag for 'peer'.	78
Error	javadoc	JavadocStyle	First sentence should end with a period.	80
Error	javadoc	JavadocMethod	Expected @param tag for 'spaceCards'.	85
Error	javadoc	JavadocMethod	Missing a Javadoc comment.	87
Error	javadoc	JavadocStyle	First sentence should end with a period.	89
Error	javadoc	JavadocStyle	First sentence should end with a period.	98
Error	javadoc	JavadocMethod	Expected @param tag for 'spaceDescriptor'.	101
Error	javadoc	JavadocStyle	First sentence should end with a period.	103
Error	javadoc	JavadocMethod	Expected @param tag for 'spaceDescriptor'.	106

org/universAAL/middleware/managers/api/SpaceListener.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.	35
Error	javadoc	JavadocStyle	First sentence should end with a period.	43
Error	javadoc	JavadocStyle	First sentence should end with a period.	51
Error	javadoc	JavadocStyle	First sentence should end with a period.	59
Error	javadoc	JavadocMethod	Expected @param tag for 'peer'.	64
Error	javadoc	JavadocStyle	First sentence should end with a period.	66
Error	javadoc	JavadocMethod	Expected @param tag for 'status'.	71

org/universAAL/middleware/managers/api/SpaceManager.java

Severity	Category	Rule	Message	Line
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	41
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	42
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	43
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	44
Error	javadoc	JavadocStyle	First sentence should end with a period.	46
Error	javadoc	JavadocStyle	First sentence should end with a period.	53
Error	javadoc	JavadocStyle	First sentence should end with a period.	68
Error	javadoc	JavadocMethod	Expected an @return tag.	73
Error	javadoc	JavadocStyle	First sentence should end with a period.	75
Error	javadoc	JavadocMethod	Unused @param tag for 'space'.	81
Error	javadoc	JavadocMethod	Expected @param tag for 'spaceCard'.	84
Error	javadoc	JavadocStyle	First sentence should end with a period.	86
Error	javadoc	JavadocMethod	Expected @param tag for 'spaceDescriptor'.	91
Error	javadoc	JavadocStyle	Unclosed HTML tag found: <ul>	129
Error	javadoc	JavadocMethod	Expected @param tag for 'listener'.	161
Error	javadoc	JavadocStyle	First sentence should end with a period.	163
Error	javadoc	JavadocMethod	Expected @param tag for 'listener'.	168

org/universAAL/middleware/managers/api/TenantListener.java

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

org/universAAL/middleware/managers/api/TenantManager.java

Severity	Category	Rule	Message	Line
Warning	javadoc	JavadocPackage	Missing package-info.java file.
Error	javadoc	JavadocStyle	First sentence should end with a period.	34
Error	javadoc	JavadocStyle	First sentence should end with a period.	44
Error	javadoc	JavadocMethod	Expected @param tag for 'tenantID'.	49
Error	javadoc	JavadocStyle	First sentence should end with a period.	51
Error	javadoc	JavadocMethod	Expected an @return tag.	56
Error	javadoc	JavadocMethod	Missing a Javadoc comment.	58
Error	javadoc	JavadocMethod	Missing a Javadoc comment.	60

org/universAAL/middleware/managers/api/UAPPPackage.java

Severity	Category	Rule	Message	Line
Error	javadoc	JavadocStyle	First sentence should end with a period.	30
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	41
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	42
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	43
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	44
Error	design	DesignForExtension	Method 'getServiceId' is not designed for extension - needs to be abstract, final or empty.	75
Error	design	DesignForExtension	Method 'getFolder' is not designed for extension - needs to be abstract, final or empty.	83
Error	design	DesignForExtension	Method 'getId' is not designed for extension - needs to be abstract, final or empty.	92
Error	design	DesignForExtension	Method 'getDeploy' is not designed for extension - needs to be abstract, final or empty.	100