mongo-elasticsearch-sync – Checkstyle Results

Checkstyle Results

The following document contains the results of Checkstyle 7.2 with sun_checks.xml ruleset.

Summary

Files	Info	Warnings	Errors
2	0	0	78

Files

File	I	W	E
org/apache/streams/example/MongoElasticsearchSync.java	0	0	22
org/apache/streams/example/MongoElasticsearchSyncConfiguration.java	0	0	56

Rules

Category	Rule	Violations	Severity
blocks	LeftCurly	2	Error
coding	HiddenField	5	Error
	SimplifyBooleanExpression	1	Error
design	DesignForExtension	9	Error
	VisibilityModifier	1	Error
javadoc	JavadocMethod	8	Error
	JavadocPackage	2	Error
	JavadocStyle	6	Error
	JavadocType	1	Error
	JavadocVariable	4	Error
misc	FinalParameters	11	Error
modifier	ModifierOrder	2	Error
regexp	RegexpSingleline format: `"\s+$"` maximum: `"0"` message: `"Line has trailing spaces."` minimum: `"0"`	12	Error
sizes	LineLength	14	Error

Details

org/apache/streams/example/MongoElasticsearchSync.java

Severity	Category	Rule	Message	Line
Error	javadoc	JavadocPackage	Missing package-info.java file.
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	38
Error	modifier	ModifierOrder	'static' modifier out of order with the JLS suggestions.	38
Error	sizes	LineLength	Line is longer than 80 characters (found 93).	40
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	40
Error	modifier	ModifierOrder	'static' modifier out of order with the JLS suggestions.	40
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	42
Error	design	VisibilityModifier	Variable 'config' must be private and have accessor methods.	42
Error	javadoc	JavadocMethod	Missing a Javadoc comment.	44
Error	sizes	LineLength	Line is longer than 80 characters (found 169).	45
Error	javadoc	JavadocMethod	Missing a Javadoc comment.	48
Error	misc	FinalParameters	Parameter config should be final.	48
Error	coding	HiddenField	'config' hides a field.	48
Error	javadoc	JavadocMethod	Missing a Javadoc comment.	52
Error	misc	FinalParameters	Parameter args should be final.	52
Error	blocks	LeftCurly	'{' at column 3 should be on the previous line.	53
Error	design	DesignForExtension	Class 'MongoElasticsearchSync' looks like designed for extension (can be subclassed), but the method 'run' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'MongoElasticsearchSync' final or making the method 'run' static/final/abstract/empty, or adding allowed annotation for the method.	62
Error	sizes	LineLength	Line is longer than 80 characters (found 87).	65
Error	sizes	LineLength	Line is longer than 80 characters (found 116).	67
Error	sizes	LineLength	Line is longer than 80 characters (found 132).	70
Error	sizes	LineLength	Line is longer than 80 characters (found 96).	73
Error	sizes	LineLength	Line is longer than 80 characters (found 165).	74

org/apache/streams/example/MongoElasticsearchSyncConfiguration.java

Severity	Category	Rule	Message	Line
Error	javadoc	JavadocPackage	Missing package-info.java file.
Error	javadoc	JavadocType	Missing a Javadoc comment.	22
Error	blocks	LeftCurly	'{' at column 1 should be on the previous line.	29
Error	javadoc	JavadocStyle	First sentence should end with a period.	31
Error	regexp	RegexpSingleline	Line has trailing spaces.	32
Error	regexp	RegexpSingleline	Line has trailing spaces.	34
Error	javadoc	JavadocStyle	First sentence should end with a period.	40
Error	regexp	RegexpSingleline	Line has trailing spaces.	41
Error	regexp	RegexpSingleline	Line has trailing spaces.	43
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	49
Error	sizes	LineLength	Line is longer than 80 characters (found 85).	50
Error	javadoc	JavadocStyle	First sentence should end with a period.	52
Error	regexp	RegexpSingleline	Line has trailing spaces.	53
Error	regexp	RegexpSingleline	Line has trailing spaces.	55
Error	javadoc	JavadocStyle	First sentence should end with a period.	64
Error	regexp	RegexpSingleline	Line has trailing spaces.	65
Error	regexp	RegexpSingleline	Line has trailing spaces.	67
Error	misc	FinalParameters	Parameter source should be final.	72
Error	coding	HiddenField	'source' hides a field.	72
Error	sizes	LineLength	Line is longer than 80 characters (found 86).	76
Error	design	DesignForExtension	Class 'MongoElasticsearchSyncConfiguration' looks like designed for extension (can be subclassed), but the method 'withSource' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'MongoElasticsearchSyncConfiguration' final or making the method 'withSource' static/final/abstract/empty, or adding allowed annotation for the method.	76
Error	javadoc	JavadocMethod	Missing a Javadoc comment.	76
Error	misc	FinalParameters	Parameter source should be final.	76
Error	coding	HiddenField	'source' hides a field.	76
Error	javadoc	JavadocStyle	First sentence should end with a period.	81
Error	regexp	RegexpSingleline	Line has trailing spaces.	82
Error	regexp	RegexpSingleline	Line has trailing spaces.	84
Error	javadoc	JavadocStyle	First sentence should end with a period.	93
Error	regexp	RegexpSingleline	Line has trailing spaces.	94
Error	regexp	RegexpSingleline	Line has trailing spaces.	96
Error	misc	FinalParameters	Parameter destination should be final.	101
Error	coding	HiddenField	'destination' hides a field.	101
Error	sizes	LineLength	Line is longer than 80 characters (found 110).	105
Error	design	DesignForExtension	Class 'MongoElasticsearchSyncConfiguration' looks like designed for extension (can be subclassed), but the method 'withDestination' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'MongoElasticsearchSyncConfiguration' final or making the method 'withDestination' static/final/abstract/empty, or adding allowed annotation for the method.	105
Error	javadoc	JavadocMethod	Missing a Javadoc comment.	105
Error	misc	FinalParameters	Parameter destination should be final.	105
Error	coding	HiddenField	'destination' hides a field.	105
Error	design	DesignForExtension	Class 'MongoElasticsearchSyncConfiguration' looks like designed for extension (can be subclassed), but the method 'toString' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'MongoElasticsearchSyncConfiguration' final or making the method 'toString' static/final/abstract/empty, or adding allowed annotation for the method.	110
Error	design	DesignForExtension	Class 'MongoElasticsearchSyncConfiguration' looks like designed for extension (can be subclassed), but the method 'getAdditionalProperties' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'MongoElasticsearchSyncConfiguration' final or making the method 'getAdditionalProperties' static/final/abstract/empty, or adding allowed annotation for the method.	115
Error	javadoc	JavadocMethod	Missing a Javadoc comment.	115
Error	design	DesignForExtension	Class 'MongoElasticsearchSyncConfiguration' looks like designed for extension (can be subclassed), but the method 'setAdditionalProperty' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'MongoElasticsearchSyncConfiguration' final or making the method 'setAdditionalProperty' static/final/abstract/empty, or adding allowed annotation for the method.	120
Error	javadoc	JavadocMethod	Missing a Javadoc comment.	120
Error	misc	FinalParameters	Parameter name should be final.	121
Error	misc	FinalParameters	Parameter value should be final.	121
Error	sizes	LineLength	Line is longer than 80 characters (found 98).	125
Error	design	DesignForExtension	Class 'MongoElasticsearchSyncConfiguration' looks like designed for extension (can be subclassed), but the method 'withAdditionalProperty' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'MongoElasticsearchSyncConfiguration' final or making the method 'withAdditionalProperty' static/final/abstract/empty, or adding allowed annotation for the method.	125
Error	javadoc	JavadocMethod	Missing a Javadoc comment.	125
Error	misc	FinalParameters	Parameter name should be final.	125
Error	misc	FinalParameters	Parameter value should be final.	125
Error	design	DesignForExtension	Class 'MongoElasticsearchSyncConfiguration' looks like designed for extension (can be subclassed), but the method 'hashCode' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'MongoElasticsearchSyncConfiguration' final or making the method 'hashCode' static/final/abstract/empty, or adding allowed annotation for the method.	130
Error	sizes	LineLength	Line is longer than 80 characters (found 114).	132
Error	design	DesignForExtension	Class 'MongoElasticsearchSyncConfiguration' looks like designed for extension (can be subclassed), but the method 'equals' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'MongoElasticsearchSyncConfiguration' final or making the method 'equals' static/final/abstract/empty, or adding allowed annotation for the method.	135
Error	misc	FinalParameters	Parameter other should be final.	136
Error	coding	SimplifyBooleanExpression	Expression can be simplified.	140
Error	sizes	LineLength	Line is longer than 80 characters (found 96).	143
Error	sizes	LineLength	Line is longer than 80 characters (found 165).	144