twitter-userstream-elasticsearch

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	101

Files

File	I	W	E
org/apache/streams/example/TwitterUserstreamElasticsearch.java	0	0	43
org/apache/streams/example/TwitterUserstreamElasticsearchConfiguration.java	0	0	58

Rules

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

Details

org/apache/streams/example/TwitterUserstreamElasticsearch.java

Severity	Category	Rule	Message	Line
Error	javadoc	JavadocPackage	Missing package-info.java file.
Error	javadoc	JavadocStyle	First sentence should end with a period.	51
Error	sizes	LineLength	Line is longer than 80 characters (found 99).	52
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	56
Error	modifier	ModifierOrder	'static' modifier out of order with the JLS suggestions.	56
Error	sizes	LineLength	Line is longer than 80 characters (found 101).	58
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	58
Error	modifier	ModifierOrder	'static' modifier out of order with the JLS suggestions.	58
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	61
Error	sizes	LineLength	Line is longer than 80 characters (found 88).	64
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	66
Error	javadoc	JavadocMethod	Missing a Javadoc comment.	68
Error	sizes	LineLength	Line is longer than 80 characters (found 142).	69
Error	sizes	LineLength	Line is longer than 80 characters (found 93).	73
Error	javadoc	JavadocMethod	Missing a Javadoc comment.	73
Error	misc	FinalParameters	Parameter config should be final.	73
Error	coding	HiddenField	'config' hides a field.	73
Error	javadoc	JavadocMethod	Missing a Javadoc comment.	77
Error	misc	FinalParameters	Parameter args should be final.	77
Error	blocks	LeftCurly	'{' at column 3 should be on the previous line.	78
Error	sizes	LineLength	Line is longer than 80 characters (found 85).	81
Error	design	DesignForExtension	Class 'TwitterUserstreamElasticsearch' 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 'TwitterUserstreamElasticsearch' final or making the method 'run' static/final/abstract/empty, or adding allowed annotation for the method.	86
Error	sizes	LineLength	Line is longer than 80 characters (found 98).	90
Error	sizes	LineLength	Line is longer than 80 characters (found 89).	92
Error	sizes	LineLength	Line is longer than 80 characters (found 140).	94
Error	sizes	LineLength	Line is longer than 80 characters (found 105).	95
Error	sizes	LineLength	Line is longer than 80 characters (found 141).	96
Error	sizes	LineLength	Line is longer than 80 characters (found 108).	98
Error	sizes	LineLength	Line is longer than 80 characters (found 132).	101
Error	sizes	LineLength	Line is longer than 80 characters (found 87).	104
Error	sizes	LineLength	Line is longer than 80 characters (found 147).	105
Error	sizes	LineLength	Line is longer than 80 characters (found 159).	106
Error	sizes	LineLength	Line is longer than 80 characters (found 151).	107
Error	sizes	LineLength	Line is longer than 80 characters (found 160).	108
Error	sizes	LineLength	Line is longer than 80 characters (found 155).	109
Error	sizes	LineLength	Line is longer than 80 characters (found 149).	110
Error	javadoc	JavadocType	Missing a Javadoc comment.	116
Error	design	DesignForExtension	Class 'SetDeleteIdProcessor' looks like designed for extension (can be subclassed), but the method 'getId' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'SetDeleteIdProcessor' final or making the method 'getId' static/final/abstract/empty, or adding allowed annotation for the method.	118
Error	javadoc	JavadocMethod	Missing a Javadoc comment.	118
Error	design	DesignForExtension	Class 'SetDeleteIdProcessor' looks like designed for extension (can be subclassed), but the method 'process' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'SetDeleteIdProcessor' final or making the method 'process' static/final/abstract/empty, or adding allowed annotation for the method.	122
Error	misc	FinalParameters	Parameter entry should be final.	123
Error	sizes	LineLength	Line is longer than 80 characters (found 93).	125
Error	misc	FinalParameters	Parameter configurationObject should be final.	136

org/apache/streams/example/TwitterUserstreamElasticsearchConfiguration.java

Severity	Category	Rule	Message	Line
Error	javadoc	JavadocPackage	Missing package-info.java file.
Error	javadoc	JavadocType	Missing a Javadoc comment.	23
Error	blocks	LeftCurly	'{' at column 1 should be on the previous line.	30
Error	javadoc	JavadocStyle	First sentence should end with a period.	32
Error	regexp	RegexpSingleline	Line has trailing spaces.	33
Error	regexp	RegexpSingleline	Line has trailing spaces.	35
Error	javadoc	JavadocStyle	First sentence should end with a period.	42
Error	regexp	RegexpSingleline	Line has trailing spaces.	43
Error	regexp	RegexpSingleline	Line has trailing spaces.	45
Error	javadoc	JavadocVariable	Missing a Javadoc comment.	52
Error	sizes	LineLength	Line is longer than 80 characters (found 85).	53
Error	javadoc	JavadocStyle	First sentence should end with a period.	55
Error	regexp	RegexpSingleline	Line has trailing spaces.	56
Error	regexp	RegexpSingleline	Line has trailing spaces.	58
Error	javadoc	JavadocStyle	First sentence should end with a period.	68
Error	regexp	RegexpSingleline	Line has trailing spaces.	69
Error	regexp	RegexpSingleline	Line has trailing spaces.	71
Error	misc	FinalParameters	Parameter twitter should be final.	77
Error	coding	HiddenField	'twitter' hides a field.	77
Error	sizes	LineLength	Line is longer than 80 characters (found 104).	81
Error	design	DesignForExtension	Class 'TwitterUserstreamElasticsearchConfiguration' looks like designed for extension (can be subclassed), but the method 'withTwitter' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'TwitterUserstreamElasticsearchConfiguration' final or making the method 'withTwitter' static/final/abstract/empty, or adding allowed annotation for the method.	81
Error	javadoc	JavadocMethod	Missing a Javadoc comment.	81
Error	misc	FinalParameters	Parameter twitter should be final.	81
Error	coding	HiddenField	'twitter' hides a field.	81
Error	javadoc	JavadocStyle	First sentence should end with a period.	86
Error	regexp	RegexpSingleline	Line has trailing spaces.	87
Error	regexp	RegexpSingleline	Line has trailing spaces.	89
Error	javadoc	JavadocStyle	First sentence should end with a period.	99
Error	regexp	RegexpSingleline	Line has trailing spaces.	100
Error	regexp	RegexpSingleline	Line has trailing spaces.	102
Error	sizes	LineLength	Line is longer than 80 characters (found 82).	108
Error	misc	FinalParameters	Parameter elasticsearch should be final.	108
Error	coding	HiddenField	'elasticsearch' hides a field.	108
Error	sizes	LineLength	Line is longer than 80 characters (found 122).	112
Error	design	DesignForExtension	Class 'TwitterUserstreamElasticsearchConfiguration' looks like designed for extension (can be subclassed), but the method 'withElasticsearch' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'TwitterUserstreamElasticsearchConfiguration' final or making the method 'withElasticsearch' static/final/abstract/empty, or adding allowed annotation for the method.	112
Error	javadoc	JavadocMethod	Missing a Javadoc comment.	112
Error	misc	FinalParameters	Parameter elasticsearch should be final.	112
Error	coding	HiddenField	'elasticsearch' hides a field.	112
Error	design	DesignForExtension	Class 'TwitterUserstreamElasticsearchConfiguration' 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 'TwitterUserstreamElasticsearchConfiguration' final or making the method 'toString' static/final/abstract/empty, or adding allowed annotation for the method.	117
Error	design	DesignForExtension	Class 'TwitterUserstreamElasticsearchConfiguration' 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 'TwitterUserstreamElasticsearchConfiguration' final or making the method 'getAdditionalProperties' static/final/abstract/empty, or adding allowed annotation for the method.	122
Error	javadoc	JavadocMethod	Missing a Javadoc comment.	122
Error	design	DesignForExtension	Class 'TwitterUserstreamElasticsearchConfiguration' 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 'TwitterUserstreamElasticsearchConfiguration' final or making the method 'setAdditionalProperty' static/final/abstract/empty, or adding allowed annotation for the method.	128
Error	javadoc	JavadocMethod	Missing a Javadoc comment.	128
Error	misc	FinalParameters	Parameter name should be final.	130
Error	misc	FinalParameters	Parameter value should be final.	130
Error	sizes	LineLength	Line is longer than 80 characters (found 106).	134
Error	design	DesignForExtension	Class 'TwitterUserstreamElasticsearchConfiguration' 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 'TwitterUserstreamElasticsearchConfiguration' final or making the method 'withAdditionalProperty' static/final/abstract/empty, or adding allowed annotation for the method.	134
Error	javadoc	JavadocMethod	Missing a Javadoc comment.	134
Error	misc	FinalParameters	Parameter name should be final.	134
Error	misc	FinalParameters	Parameter value should be final.	134
Error	design	DesignForExtension	Class 'TwitterUserstreamElasticsearchConfiguration' 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 'TwitterUserstreamElasticsearchConfiguration' final or making the method 'hashCode' static/final/abstract/empty, or adding allowed annotation for the method.	139
Error	sizes	LineLength	Line is longer than 80 characters (found 117).	141
Error	design	DesignForExtension	Class 'TwitterUserstreamElasticsearchConfiguration' 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 'TwitterUserstreamElasticsearchConfiguration' final or making the method 'equals' static/final/abstract/empty, or adding allowed annotation for the method.	144
Error	misc	FinalParameters	Parameter other should be final.	145
Error	sizes	LineLength	Line is longer than 80 characters (found 86).	149
Error	coding	SimplifyBooleanExpression	Expression can be simplified.	149
Error	sizes	LineLength	Line is longer than 80 characters (found 112).	152
Error	sizes	LineLength	Line is longer than 80 characters (found 171).	153