Lutece geocode library – Checkstyle Results

Checkstyle Results

The following document contains the results of Checkstyle 8.19 with build-config/lutece_checks.xml ruleset.

Summary

Files	Info	Warnings	Errors
11	0	0	93

Files

File	I	W	E
fr/paris/lutece/plugins/geocode/v1/web/rs/dto/City.java	0	0	19
fr/paris/lutece/plugins/geocode/v1/web/rs/dto/Country.java	0	0	9
fr/paris/lutece/plugins/geocode/v1/web/rs/service/AbstractTransportRest.java	0	0	5
fr/paris/lutece/plugins/geocode/v1/web/rs/service/GeoCodeTransportRest.java	0	0	1
fr/paris/lutece/plugins/geocode/v1/web/rs/service/HttpAccessTransport.java	0	0	21
fr/paris/lutece/plugins/geocode/v1/web/rs/service/HttpApiManagerAccessTransport.java	0	0	2
fr/paris/lutece/plugins/geocode/v1/web/rs/util/Constants.java	0	0	4
fr/paris/lutece/plugins/geocode/v1/web/service/CustomResponseStatusValidator.java	0	0	7
fr/paris/lutece/plugins/geocode/v1/web/service/GeoCodeQualityService.java	0	0	4
fr/paris/lutece/plugins/geocode/v1/web/service/IGeoCodeTransportProvider.java	0	0	9
fr/paris/lutece/plugins/geocode/v1/web/service/IHttpTransportProvider.java	0	0	12

Rules

Category	Rule	Violations	Severity
blocks	LeftCurly option: `"nl"`	13	Error
coding	DeclarationOrder	10	Error
design	FinalClass	2	Error
	VisibilityModifier	4	Error
header	Header fileExtensions: `"java"` headerFile: `"/opt/datas/jenkins/home/jobs/admin-github-build/workspace/target/checkstyle-header.txt"`	11	Error
javadoc	JavadocMethod	24	Error
	JavadocType	4	Error
modifier	RedundantModifier	8	Error
naming	StaticVariableName format: `"^_[a-z](_?[a-zA-Z0-9])*$"`	1	Error
whitespace	ParenPad option: `"space"`	16	Error

Details

fr/paris/lutece/plugins/geocode/v1/web/rs/dto/City.java

Severity	Category	Rule	Message	Line
Error	header	Header	Line does not match expected header line of '/*'.	1
Error	javadoc	JavadocType	Missing a Javadoc comment.	10
Error	coding	DeclarationOrder	Static variable definition in wrong order.	18
Error	coding	DeclarationOrder	Static variable definition in wrong order.	19
Error	coding	DeclarationOrder	Static variable definition in wrong order.	20
Error	coding	DeclarationOrder	Static variable definition in wrong order.	21
Error	coding	DeclarationOrder	Static variable definition in wrong order.	22
Error	blocks	LeftCurly	'{' at column 38 should be on a new line.	139
Error	blocks	LeftCurly	'{' at column 51 should be on a new line.	148
Error	whitespace	ParenPad	'(' is not followed by whitespace.	158
Error	whitespace	ParenPad	')' is not preceded with whitespace.	158
Error	blocks	LeftCurly	'{' at column 59 should be on a new line.	158
Error	blocks	LeftCurly	'{' at column 35 should be on a new line.	166
Error	blocks	LeftCurly	'{' at column 49 should be on a new line.	175
Error	blocks	LeftCurly	'{' at column 57 should be on a new line.	184
Error	blocks	LeftCurly	'{' at column 31 should be on a new line.	193
Error	blocks	LeftCurly	'{' at column 48 should be on a new line.	202
Error	blocks	LeftCurly	'{' at column 39 should be on a new line.	211
Error	blocks	LeftCurly	'{' at column 64 should be on a new line.	220

fr/paris/lutece/plugins/geocode/v1/web/rs/dto/Country.java

Severity	Category	Rule	Message	Line
Error	header	Header	Line does not match expected header line of '/*'.	1
Error	javadoc	JavadocType	Missing a Javadoc comment.	10
Error	coding	DeclarationOrder	Static variable definition in wrong order.	18
Error	coding	DeclarationOrder	Static variable definition in wrong order.	19
Error	coding	DeclarationOrder	Static variable definition in wrong order.	20
Error	blocks	LeftCurly	'{' at column 34 should be on a new line.	91
Error	whitespace	ParenPad	'(' is not followed by whitespace.	99
Error	whitespace	ParenPad	')' is not preceded with whitespace.	99
Error	blocks	LeftCurly	'{' at column 53 should be on a new line.	99

fr/paris/lutece/plugins/geocode/v1/web/rs/service/AbstractTransportRest.java

Severity	Category	Rule	Message	Line
Error	header	Header	Line does not match expected header line of ' * Copyright (c) 2002-2020, City of Paris'.	2
Error	design	VisibilityModifier	Variable '_httpTransport' must be private and have accessor methods.	48
Error	coding	DeclarationOrder	Static variable definition in wrong order.	51
Error	design	VisibilityModifier	Variable '_mapper' must be private and have accessor methods.	51
Error	javadoc	JavadocMethod	Expected @param tag for 'transportProvider'.	65

fr/paris/lutece/plugins/geocode/v1/web/rs/service/GeoCodeTransportRest.java

Severity	Category	Rule	Message	Line
Error	header	Header	Line does not match expected header line of ' * Copyright (c) 2002-2020, City of Paris'.	2

fr/paris/lutece/plugins/geocode/v1/web/rs/service/HttpAccessTransport.java

Severity	Category	Rule	Message	Line
Error	header	Header	Line does not match expected header line of ' * Copyright (c) 2002-2020, City of Paris'.	2
Error	design	VisibilityModifier	Variable '_httpClient' must be private and have accessor methods.	61
Error	design	VisibilityModifier	Variable '_strEndPoint' must be private and have accessor methods.	62
Error	javadoc	JavadocMethod	Missing a Javadoc comment.	64
Error	whitespace	ParenPad	'(' is not followed by whitespace.	70
Error	whitespace	ParenPad	')' is not preceded with whitespace.	71
Error	whitespace	ParenPad	'(' is not followed by whitespace.	101
Error	whitespace	ParenPad	')' is not preceded with whitespace.	102
Error	javadoc	JavadocMethod	Unable to get class information for @throws tag 'IdentityNotFoundException'.	136
Error	javadoc	JavadocMethod	Unable to get class information for @throws tag 'IdentityStoreException'.	138
Error	javadoc	JavadocMethod	Expected @throws tag for 'Exception'.	141
Error	javadoc	JavadocMethod	Expected @throws tag for 'Exception'.	165
Error	javadoc	JavadocMethod	Expected @param tag for 'strApiEndPointUrl'.	175
Error	javadoc	JavadocMethod	Expected @param tag for '<T>'.	203
Error	javadoc	JavadocMethod	Expected @throws tag for 'JsonProcessingException'.	204
Error	javadoc	JavadocMethod	Expected @throws tag for 'InstantiationException'.	204
Error	javadoc	JavadocMethod	Expected @throws tag for 'IllegalAccessException'.	204
Error	javadoc	JavadocMethod	Expected @param tag for '<T>'.	233
Error	javadoc	JavadocMethod	Expected @throws tag for 'JsonProcessingException'.	234
Error	javadoc	JavadocMethod	Expected @throws tag for 'InstantiationException'.	234
Error	javadoc	JavadocMethod	Expected @throws tag for 'IllegalAccessException'.	234

fr/paris/lutece/plugins/geocode/v1/web/rs/service/HttpApiManagerAccessTransport.java

Severity	Category	Rule	Message	Line
Error	header	Header	Line does not match expected header line of ' * Copyright (c) 2002-2020, City of Paris'.	2
Error	javadoc	JavadocMethod	Expected @throws tag for 'Exception'.	98

fr/paris/lutece/plugins/geocode/v1/web/rs/util/Constants.java

Severity	Category	Rule	Message	Line
Error	header	Header	Line does not match expected header line of '/*'.	1
Error	design	FinalClass	Class Constants should be declared as final.	3
Error	javadoc	JavadocType	Missing a Javadoc comment.	3
Error	blocks	LeftCurly	'{' at column 24 should be on a new line.	3

fr/paris/lutece/plugins/geocode/v1/web/service/CustomResponseStatusValidator.java

Severity	Category	Rule	Message	Line
Error	header	Header	Line does not match expected header line of ' * Copyright (c) 2002-2020, City of Paris'.	2
Error	design	FinalClass	Class CustomResponseStatusValidator should be declared as final.	38
Error	javadoc	JavadocType	Missing a Javadoc comment.	38
Error	naming	StaticVariableName	Name 'instance' must match pattern '^_[a-z](_?[a-zA-Z0-9])*$'.	40
Error	javadoc	JavadocMethod	Missing a Javadoc comment.	42
Error	coding	DeclarationOrder	Constructor definition in wrong order.	51
Error	javadoc	JavadocMethod	Missing a Javadoc comment.	51

fr/paris/lutece/plugins/geocode/v1/web/service/GeoCodeQualityService.java

Severity	Category	Rule	Message	Line
Error	header	Header	Line does not match expected header line of ' * Copyright (c) 2002-2020, City of Paris'.	2
Error	javadoc	JavadocMethod	Expected @throws tag for 'Exception'.	91
Error	javadoc	JavadocMethod	Expected @throws tag for 'Exception'.	106
Error	javadoc	JavadocMethod	Expected @throws tag for 'Exception'.	121

fr/paris/lutece/plugins/geocode/v1/web/service/IGeoCodeTransportProvider.java

Severity	Category	Rule	Message	Line
Error	header	Header	Line does not match expected header line of ' * Copyright (c) 2002-2020, City of Paris'.	2
Error	modifier	RedundantModifier	Redundant 'final' modifier.	58
Error	modifier	RedundantModifier	Redundant 'final' modifier.	58
Error	whitespace	ParenPad	'(' is not followed by whitespace.	70
Error	whitespace	ParenPad	')' is not preceded with whitespace.	70
Error	modifier	RedundantModifier	Redundant 'final' modifier.	82
Error	modifier	RedundantModifier	Redundant 'final' modifier.	82
Error	whitespace	ParenPad	'(' is not followed by whitespace.	94
Error	whitespace	ParenPad	')' is not preceded with whitespace.	94

fr/paris/lutece/plugins/geocode/v1/web/service/IHttpTransportProvider.java

Severity	Category	Rule	Message	Line
Error	header	Header	Line does not match expected header line of ' * Copyright (c) 2002-2020, City of Paris'.	2
Error	modifier	RedundantModifier	Redundant 'public' modifier.	52
Error	javadoc	JavadocMethod	Expected @param tag for 'strApiEndPointUrl'.	52
Error	modifier	RedundantModifier	Redundant 'public' modifier.	59
Error	javadoc	JavadocMethod	Missing a Javadoc comment.	61
Error	modifier	RedundantModifier	Redundant 'public' modifier.	61
Error	whitespace	ParenPad	'(' is not followed by whitespace.	61
Error	whitespace	ParenPad	')' is not preceded with whitespace.	62
Error	javadoc	JavadocMethod	Missing a Javadoc comment.	66
Error	modifier	RedundantModifier	Redundant 'public' modifier.	66
Error	whitespace	ParenPad	'(' is not followed by whitespace.	66
Error	whitespace	ParenPad	')' is not preceded with whitespace.	67