Lutece Word template 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
14	0	2	139

Files

File	W	E
fr/paris/lutece/plugins/wordtemplate/business/AbstractInstructionElement.java	0	4
fr/paris/lutece/plugins/wordtemplate/business/IWordInstructionElement.java	0	6
fr/paris/lutece/plugins/wordtemplate/business/InterpolationInstructionElement.java	0	2
fr/paris/lutece/plugins/wordtemplate/business/WordTemplate.java	0	2
fr/paris/lutece/plugins/wordtemplate/exception/WordTemplateException.java	0	4
fr/paris/lutece/plugins/wordtemplate/service/InstructionService.java	0	8
fr/paris/lutece/plugins/wordtemplate/service/TemplateEngineService.java	0	1
fr/paris/lutece/plugins/wordtemplate/service/WordService.java	2	77
fr/paris/lutece/plugins/wordtemplate/service/WordTemplateParser.java	0	13
fr/paris/lutece/plugins/wordtemplate/service/WordTemplateProcessor.java	0	2
fr/paris/lutece/plugins/wordtemplate/service/WordTemplateService.java	0	4
fr/paris/lutece/plugins/wordtemplate/service/instruction/IInstructionManager.java	0	10
fr/paris/lutece/plugins/wordtemplate/service/instruction/InterpolationInstructionManager.java	0	6

Rules

Category	Rule	Violations	Severity
blocks	EmptyBlock	4	Error
coding	ArrayTrailingComma	1	Error
	MissingSwitchDefault	1	Error
	ParameterAssignment	4	Error
	ReturnCount max: `"5"`	2	Warning
design	FinalClass	1	Error
	HideUtilityClassConstructor	2	Error
imports	UnusedImports	1	Error
javadoc	JavadocMethod	120	Error
modifier	RedundantModifier	5	Error

Details

fr/paris/lutece/plugins/wordtemplate/business/AbstractInstructionElement.java

Severity	Category	Rule	Message	Line
Error	javadoc	JavadocMethod	Expected @param tag for 'strExpression'.	58
Error	javadoc	JavadocMethod	Expected @param tag for 'run'.	58
Error	javadoc	JavadocMethod	Expected @return tag.	98
Error	javadoc	JavadocMethod	Expected @param tag for 'run'.	107

fr/paris/lutece/plugins/wordtemplate/business/IWordInstructionElement.java

Severity	Category	Rule	Message	Line
Error	javadoc	JavadocMethod	Expected @return tag.	47
Error	javadoc	JavadocMethod	Expected @param tag for 'strExpression'.	53
Error	javadoc	JavadocMethod	Expected @return tag.	59
Error	modifier	RedundantModifier	Redundant 'public' modifier.	59
Error	modifier	RedundantModifier	Redundant 'public' modifier.	65
Error	javadoc	JavadocMethod	Expected @param tag for 'run'.	65

fr/paris/lutece/plugins/wordtemplate/business/InterpolationInstructionElement.java

Severity	Category	Rule	Message	Line
Error	javadoc	JavadocMethod	Expected @param tag for 'strExpression'.	54
Error	javadoc	JavadocMethod	Expected @param tag for 'run'.	54

fr/paris/lutece/plugins/wordtemplate/business/WordTemplate.java

Severity	Category	Rule	Message	Line
Error	javadoc	JavadocMethod	Expected @return tag.	49
Error	javadoc	JavadocMethod	Expected @param tag for 'listInstructions'.	58

fr/paris/lutece/plugins/wordtemplate/exception/WordTemplateException.java

Severity	Category	Rule	Message	Line
Error	javadoc	JavadocMethod	Expected @param tag for 'message'.	46
Error	javadoc	JavadocMethod	Expected @param tag for 'cause'.	56
Error	javadoc	JavadocMethod	Expected @param tag for 'message'.	67
Error	javadoc	JavadocMethod	Expected @param tag for 'cause'.	67

fr/paris/lutece/plugins/wordtemplate/service/InstructionService.java

Severity	Category	Rule	Message	Line
Error	design	FinalClass	Class InstructionService should be declared as final.	47
Error	javadoc	JavadocMethod	Missing a Javadoc comment.	52
Error	javadoc	JavadocMethod	Expected @return tag.	62
Error	javadoc	JavadocMethod	Expected @return tag.	78
Error	javadoc	JavadocMethod	Expected @param tag for 'expression'.	78
Error	javadoc	JavadocMethod	Expected @param tag for 'run'.	78
Error	javadoc	JavadocMethod	Expected @param tag for 'instruction'.	96
Error	javadoc	JavadocMethod	Expected @param tag for 'model'.	96

fr/paris/lutece/plugins/wordtemplate/service/TemplateEngineService.java

Severity	Category	Rule	Message	Line
Error	design	HideUtilityClassConstructor	Utility classes should not have a public or default constructor.	47

fr/paris/lutece/plugins/wordtemplate/service/WordService.java

Severity	Category	Rule	Message	Line
Error	imports	UnusedImports	Unused import - org.apache.poi.xwpf.usermodel.XWPFDocument.	42
Error	javadoc	JavadocMethod	Expected @param tag for 'body'.	72
Error	javadoc	JavadocMethod	Expected @throws tag for 'XmlException'.	72
Warning	coding	ReturnCount	Return count is 2 (max allowed for void methods/constructors/lambdas is 1).	109
Error	javadoc	JavadocMethod	Expected @param tag for 'isEmpty'.	133
Error	javadoc	JavadocMethod	Expected @param tag for 'isEmpty'.	159
Error	javadoc	JavadocMethod	Expected @param tag for 'isEmpty'.	181
Error	coding	ArrayTrailingComma	Array should contain trailing comma.	207
Error	javadoc	JavadocMethod	Expected @param tag for 'isEmpty'.	227
Error	javadoc	JavadocMethod	Expected @param tag for 'fromIndex'.	278
Error	javadoc	JavadocMethod	Expected @param tag for 'toIndex'.	278
Error	javadoc	JavadocMethod	Expected @return tag.	324
Error	javadoc	JavadocMethod	Expected @param tag for 'body'.	324
Error	javadoc	JavadocMethod	Expected @param tag for 'posDest'.	324
Error	javadoc	JavadocMethod	Expected @return tag.	363
Error	javadoc	JavadocMethod	Expected @param tag for 'body'.	363
Error	javadoc	JavadocMethod	Expected @param tag for 'cursor'.	363
Error	javadoc	JavadocMethod	Expected @return tag.	378
Error	javadoc	JavadocMethod	Expected @param tag for 'table'.	378
Error	javadoc	JavadocMethod	Expected @param tag for 'tableRow'.	378
Error	javadoc	JavadocMethod	Expected @param tag for 'posDest'.	378
Error	javadoc	JavadocMethod	Expected @return tag.	397
Error	javadoc	JavadocMethod	Expected @param tag for 'table'.	397
Error	javadoc	JavadocMethod	Expected @param tag for 'tableRow'.	397
Error	javadoc	JavadocMethod	Expected @param tag for 'cursor'.	397
Error	javadoc	JavadocMethod	Expected @return tag.	412
Error	javadoc	JavadocMethod	Expected @param tag for 'tableRow'.	412
Error	javadoc	JavadocMethod	Expected @param tag for 'tableCell'.	412
Error	javadoc	JavadocMethod	Expected @param tag for 'posDest'.	412
Error	coding	ParameterAssignment	Assignment of parameter 'tableCell' is not allowed.	414
Error	javadoc	JavadocMethod	Expected @return tag.	427
Error	javadoc	JavadocMethod	Expected @param tag for 'tableRow'.	427
Error	javadoc	JavadocMethod	Expected @param tag for 'tableCell'.	427
Error	javadoc	JavadocMethod	Expected @param tag for 'cursor'.	427
Error	javadoc	JavadocMethod	Expected @return tag.	442
Error	javadoc	JavadocMethod	Expected @param tag for 'body'.	442
Error	javadoc	JavadocMethod	Expected @param tag for 'paragraph'.	442
Error	javadoc	JavadocMethod	Expected @param tag for 'posDest'.	442
Error	javadoc	JavadocMethod	Expected @return tag.	479
Error	javadoc	JavadocMethod	Expected @param tag for 'body'.	479
Error	javadoc	JavadocMethod	Expected @param tag for 'paragraph'.	479
Error	javadoc	JavadocMethod	Expected @param tag for 'cursor'.	479
Error	javadoc	JavadocMethod	Expected @return tag.	494
Error	javadoc	JavadocMethod	Expected @param tag for 'paragraphe'.	494
Error	javadoc	JavadocMethod	Expected @param tag for 'run'.	494
Error	javadoc	JavadocMethod	Expected @param tag for 'posDest'.	494
Error	javadoc	JavadocMethod	Expected @return tag.	509
Error	javadoc	JavadocMethod	Expected @param tag for 'paragraphe'.	509
Error	javadoc	JavadocMethod	Expected @param tag for 'run'.	509
Error	javadoc	JavadocMethod	Expected @param tag for 'cursor'.	509
Error	javadoc	JavadocMethod	Expected @param tag for 'paragraph'.	522
Error	javadoc	JavadocMethod	Expected @param tag for 'pos'.	522
Error	blocks	EmptyBlock	Must have at least one statement.	530
Error	coding	ParameterAssignment	Assignment of parameter 'pos' is not allowed.	534
Warning	coding	ReturnCount	Return count is 2 (max allowed for void methods/constructors/lambdas is 1).	545
Error	javadoc	JavadocMethod	Expected @param tag for 'run'.	545
Error	javadoc	JavadocMethod	Expected @param tag for 'pos'.	545
Error	javadoc	JavadocMethod	Expected @param tag for 'table'.	571
Error	javadoc	JavadocMethod	Expected @param tag for 'pos'.	571
Error	blocks	EmptyBlock	Must have at least one statement.	579
Error	coding	ParameterAssignment	Assignment of parameter 'pos' is not allowed.	583
Error	javadoc	JavadocMethod	Expected @param tag for 'tableRow'.	594
Error	javadoc	JavadocMethod	Expected @param tag for 'pos'.	594
Error	blocks	EmptyBlock	Must have at least one statement.	602
Error	coding	ParameterAssignment	Assignment of parameter 'pos' is not allowed.	606
Error	javadoc	JavadocMethod	Expected @param tag for 'tableCell'.	617
Error	javadoc	JavadocMethod	Expected @param tag for 'pos'.	617
Error	javadoc	JavadocMethod	Expected @return tag.	639
Error	javadoc	JavadocMethod	Expected @param tag for 'tableRow'.	639
Error	javadoc	JavadocMethod	Expected @param tag for 'posDest'.	639
Error	javadoc	JavadocMethod	Expected @return tag.	654
Error	javadoc	JavadocMethod	Expected @param tag for 'tableRow'.	654
Error	javadoc	JavadocMethod	Expected @param tag for 'posDest'.	654
Error	javadoc	JavadocMethod	Expected @param tag for 'body'.	671
Error	javadoc	JavadocMethod	Expected @param tag for 'posDest'.	671
Error	javadoc	JavadocMethod	Expected @param tag for 'cursor'.	683
Error	javadoc	JavadocMethod	Expected @return tag.	694
Error	javadoc	JavadocMethod	Expected @param tag for 'bodyElement'.	694
Error	coding	MissingSwitchDefault	switch without "default" clause.	698

fr/paris/lutece/plugins/wordtemplate/service/WordTemplateParser.java

Severity	Category	Rule	Message	Line
Error	javadoc	JavadocMethod	Expected @return tag.	70
Error	javadoc	JavadocMethod	Expected @param tag for 'document'.	70
Error	javadoc	JavadocMethod	Expected @param tag for 'model'.	70
Error	javadoc	JavadocMethod	Expected @throws tag for 'Exception'.	70
Error	javadoc	JavadocMethod	Expected @param tag for 'body'.	98
Error	blocks	EmptyBlock	Must have at least one statement.	105
Error	javadoc	JavadocMethod	Expected @return tag.	127
Error	javadoc	JavadocMethod	Expected @param tag for 'body'.	127
Error	javadoc	JavadocMethod	Expected @return tag.	158
Error	javadoc	JavadocMethod	Expected @param tag for 'paragraph'.	158
Error	javadoc	JavadocMethod	Expected @param tag for 'paragraph'.	191
Error	javadoc	JavadocMethod	Expected @param tag for 'start'.	191
Error	javadoc	JavadocMethod	Expected @param tag for 'end'.	191

fr/paris/lutece/plugins/wordtemplate/service/WordTemplateProcessor.java

Severity	Category	Rule	Message	Line
Error	javadoc	JavadocMethod	Expected @param tag for 'wordTemplate'.	51
Error	javadoc	JavadocMethod	Expected @param tag for 'model'.	51

fr/paris/lutece/plugins/wordtemplate/service/WordTemplateService.java

Severity	Category	Rule	Message	Line
Error	design	HideUtilityClassConstructor	Utility classes should not have a public or default constructor.	47
Error	javadoc	JavadocMethod	Expected @param tag for 'fis'.	56
Error	javadoc	JavadocMethod	Expected @param tag for 'model'.	56
Error	javadoc	JavadocMethod	Expected @throws tag for 'WordTemplateException'.	56

fr/paris/lutece/plugins/wordtemplate/service/instruction/IInstructionManager.java

Severity	Category	Rule	Message	Line
Error	javadoc	JavadocMethod	Expected @return tag.	51
Error	modifier	RedundantModifier	Redundant 'public' modifier.	51
Error	javadoc	JavadocMethod	Expected @param tag for 'strExpression'.	51
Error	javadoc	JavadocMethod	Expected @return tag.	59
Error	modifier	RedundantModifier	Redundant 'public' modifier.	59
Error	javadoc	JavadocMethod	Expected @param tag for 'strExpression'.	59
Error	javadoc	JavadocMethod	Expected @param tag for 'run'.	59
Error	modifier	RedundantModifier	Redundant 'public' modifier.	66
Error	javadoc	JavadocMethod	Expected @param tag for 'instruction'.	66
Error	javadoc	JavadocMethod	Expected @param tag for 'model'.	66

fr/paris/lutece/plugins/wordtemplate/service/instruction/InterpolationInstructionManager.java

Severity	Category	Rule	Message	Line
Error	javadoc	JavadocMethod	Expected @return tag.	55
Error	javadoc	JavadocMethod	Expected @return tag.	65
Error	javadoc	JavadocMethod	Expected @param tag for 'strExpression'.	65
Error	javadoc	JavadocMethod	Expected @return tag.	106
Error	javadoc	JavadocMethod	Expected @param tag for 'strExpression'.	106
Error	javadoc	JavadocMethod	Expected @param tag for 'model'.	106