Fork me on GitHub

Checkstyle Results

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

Summary

Files  Info  Warnings  Errors
4 0 0 225

Files

File  I  W  E
org/apache/streams/config/ComponentConfiguration.java 0 0 43
org/apache/streams/config/ComponentConfigurator.java 0 0 23
org/apache/streams/config/StreamsConfiguration.java 0 0 135
org/apache/streams/config/StreamsConfigurator.java 0 0 24

Rules

Category Rule Violations Severity
blocks LeftCurly 2  Error
coding HiddenField 23  Error
MagicNumber 6  Error
SimplifyBooleanExpression 2  Error
design DesignForExtension 23  Error
HideUtilityClassConstructor 1  Error
VisibilityModifier 1  Error
javadoc JavadocMethod 23  Error
JavadocPackage 2  Error
JavadocStyle 24  Error
JavadocType 3  Error
JavadocVariable 10  Error
misc FinalParameters 41  Error
naming ConstantName 2  Error
regexp RegexpSingleline
  • format: "\s+$"
  • maximum: "0"
  • message: "Line has trailing spaces."
  • minimum: "0"
 31  Error
sizes LineLength 29  Error
whitespace ParenPad 2  Error

Details

org/apache/streams/config/ComponentConfiguration.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 JavadocVariable Missing a Javadoc comment. 32
 Error sizes LineLength Line is longer than 80 characters (found 94). 35
 Error javadoc JavadocVariable Missing a Javadoc comment. 36
 Error sizes LineLength Line is longer than 80 characters (found 95). 39
 Error javadoc JavadocVariable Missing a Javadoc comment. 40
 Error sizes LineLength Line is longer than 80 characters (found 85). 41
 Error regexp RegexpSingleline Line has trailing spaces. 44
 Error regexp RegexpSingleline Line has trailing spaces. 55
 Error misc FinalParameters Parameter inClasses should be final. 61
 Error coding HiddenField 'inClasses' hides a field. 61
 Error design DesignForExtension Class 'ComponentConfiguration' looks like designed for extension (can be subclassed), but the method 'withInClasses' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'ComponentConfiguration' final or making the method 'withInClasses' static/final/abstract/empty, or adding allowed annotation for the method. 65
 Error javadoc JavadocMethod Missing a Javadoc comment. 65
 Error misc FinalParameters Parameter inClasses should be final. 65
 Error coding HiddenField 'inClasses' hides a field. 65
 Error regexp RegexpSingleline Line has trailing spaces. 71
 Error regexp RegexpSingleline Line has trailing spaces. 82
 Error misc FinalParameters Parameter outClasses should be final. 88
 Error coding HiddenField 'outClasses' hides a field. 88
 Error design DesignForExtension Class 'ComponentConfiguration' looks like designed for extension (can be subclassed), but the method 'withOutClasses' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'ComponentConfiguration' final or making the method 'withOutClasses' static/final/abstract/empty, or adding allowed annotation for the method. 92
 Error javadoc JavadocMethod Missing a Javadoc comment. 92
 Error misc FinalParameters Parameter outClasses should be final. 92
 Error coding HiddenField 'outClasses' hides a field. 92
 Error design DesignForExtension Class 'ComponentConfiguration' 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 'ComponentConfiguration' final or making the method 'toString' static/final/abstract/empty, or adding allowed annotation for the method. 97
 Error design DesignForExtension Class 'ComponentConfiguration' 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 'ComponentConfiguration' final or making the method 'getAdditionalProperties' static/final/abstract/empty, or adding allowed annotation for the method. 102
 Error javadoc JavadocMethod Missing a Javadoc comment. 102
 Error design DesignForExtension Class 'ComponentConfiguration' 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 'ComponentConfiguration' final or making the method 'setAdditionalProperty' static/final/abstract/empty, or adding allowed annotation for the method. 108
 Error javadoc JavadocMethod Missing a Javadoc comment. 108
 Error misc FinalParameters Parameter name should be final. 110
 Error misc FinalParameters Parameter value should be final. 110
 Error sizes LineLength Line is longer than 80 characters (found 85). 114
 Error design DesignForExtension Class 'ComponentConfiguration' 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 'ComponentConfiguration' final or making the method 'withAdditionalProperty' static/final/abstract/empty, or adding allowed annotation for the method. 114
 Error javadoc JavadocMethod Missing a Javadoc comment. 114
 Error misc FinalParameters Parameter name should be final. 114
 Error misc FinalParameters Parameter value should be final. 114
 Error design DesignForExtension Class 'ComponentConfiguration' 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 'ComponentConfiguration' final or making the method 'hashCode' static/final/abstract/empty, or adding allowed annotation for the method. 119
 Error sizes LineLength Line is longer than 80 characters (found 116). 121
 Error design DesignForExtension Class 'ComponentConfiguration' 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 'ComponentConfiguration' final or making the method 'equals' static/final/abstract/empty, or adding allowed annotation for the method. 124
 Error misc FinalParameters Parameter other should be final. 125
 Error coding SimplifyBooleanExpression Expression can be simplified. 129
 Error sizes LineLength Line is longer than 80 characters (found 169). 133

org/apache/streams/config/ComponentConfigurator.java

Severity Category Rule Message Line
 Error javadoc JavadocPackage Missing package-info.java file.
 Error sizes LineLength Line is longer than 80 characters (found 116). 30
 Error sizes LineLength Line is longer than 80 characters (found 113). 33
 Error sizes LineLength Line is longer than 80 characters (found 104). 36
 Error javadoc JavadocType Type Javadoc comment is missing an @param <T> tag. 42
 Error javadoc JavadocVariable Missing a Javadoc comment. 44
 Error javadoc JavadocMethod Missing a Javadoc comment. 46
 Error misc FinalParameters Parameter configClass should be final. 46
 Error coding HiddenField 'configClass' hides a field. 46
 Error sizes LineLength Line is longer than 80 characters (found 92). 50
 Error javadoc JavadocVariable Missing a Javadoc comment. 50
 Error javadoc JavadocVariable Missing a Javadoc comment. 52
 Error naming ConstantName Name 'mapper' must match pattern '^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$'. 52
 Error sizes LineLength Line is longer than 80 characters (found 83). 55
 Error misc FinalParameters Parameter typesafeConfig should be final. 59
 Error sizes LineLength Line is longer than 80 characters (found 110). 64
 Error sizes LineLength Line is longer than 80 characters (found 87). 74
 Error misc FinalParameters Parameter subConfig should be final. 78
 Error whitespace ParenPad '(' is followed by whitespace. 80
 Error sizes LineLength Line is longer than 80 characters (found 96). 84
 Error misc FinalParameters Parameter typesafeConfig should be final. 89
 Error misc FinalParameters Parameter subConfig should be final. 89
 Error whitespace ParenPad '(' is followed by whitespace. 90

org/apache/streams/config/StreamsConfiguration.java

Severity Category Rule Message Line
 Error javadoc JavadocType Missing a Javadoc comment. 19
 Error blocks LeftCurly '{' at column 1 should be on the previous line. 33
 Error javadoc JavadocStyle First sentence should end with a period. 35
 Error regexp RegexpSingleline Line has trailing spaces. 37
 Error coding MagicNumber '5000L' is a magic number. 41
 Error javadoc JavadocStyle First sentence should end with a period. 42
 Error regexp RegexpSingleline Line has trailing spaces. 44
 Error coding MagicNumber '1000L' is a magic number. 48
 Error javadoc JavadocStyle First sentence should end with a period. 49
 Error regexp RegexpSingleline Line has trailing spaces. 51
 Error javadoc JavadocStyle First sentence should end with a period. 56
 Error regexp RegexpSingleline Line has trailing spaces. 58
 Error regexp RegexpSingleline Line has trailing spaces. 65
 Error coding MagicNumber '1440000L' is a magic number. 69
 Error javadoc JavadocStyle First sentence should end with a period. 70
 Error regexp RegexpSingleline Line has trailing spaces. 72
 Error coding MagicNumber '1000L' is a magic number. 76
 Error javadoc JavadocStyle First sentence should end with a period. 77
 Error regexp RegexpSingleline Line has trailing spaces. 79
 Error coding MagicNumber '1000L' is a magic number. 83
 Error javadoc JavadocStyle First sentence should end with a period. 84
 Error regexp RegexpSingleline Line has trailing spaces. 86
 Error coding MagicNumber '1000L' is a magic number. 90
 Error javadoc JavadocStyle First sentence should end with a period. 91
 Error regexp RegexpSingleline Line has trailing spaces. 93
 Error javadoc JavadocVariable Missing a Javadoc comment. 98
 Error sizes LineLength Line is longer than 80 characters (found 85). 99
 Error javadoc JavadocStyle First sentence should end with a period. 101
 Error regexp RegexpSingleline Line has trailing spaces. 103
 Error javadoc JavadocStyle First sentence should end with a period. 113
 Error regexp RegexpSingleline Line has trailing spaces. 115
 Error misc FinalParameters Parameter batchFrequencyMs should be final. 121
 Error coding HiddenField 'batchFrequencyMs' hides a field. 121
 Error design DesignForExtension Class 'StreamsConfiguration' looks like designed for extension (can be subclassed), but the method 'withBatchFrequencyMs' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'StreamsConfiguration' final or making the method 'withBatchFrequencyMs' static/final/abstract/empty, or adding allowed annotation for the method. 125
 Error javadoc JavadocMethod Missing a Javadoc comment. 125
 Error misc FinalParameters Parameter batchFrequencyMs should be final. 125
 Error coding HiddenField 'batchFrequencyMs' hides a field. 125
 Error javadoc JavadocStyle First sentence should end with a period. 130
 Error regexp RegexpSingleline Line has trailing spaces. 132
 Error javadoc JavadocStyle First sentence should end with a period. 142
 Error regexp RegexpSingleline Line has trailing spaces. 144
 Error misc FinalParameters Parameter batchSize should be final. 150
 Error coding HiddenField 'batchSize' hides a field. 150
 Error design DesignForExtension Class 'StreamsConfiguration' looks like designed for extension (can be subclassed), but the method 'withBatchSize' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'StreamsConfiguration' final or making the method 'withBatchSize' static/final/abstract/empty, or adding allowed annotation for the method. 154
 Error javadoc JavadocMethod Missing a Javadoc comment. 154
 Error misc FinalParameters Parameter batchSize should be final. 154
 Error coding HiddenField 'batchSize' hides a field. 154
 Error javadoc JavadocStyle First sentence should end with a period. 159
 Error regexp RegexpSingleline Line has trailing spaces. 161
 Error javadoc JavadocStyle First sentence should end with a period. 171
 Error regexp RegexpSingleline Line has trailing spaces. 173
 Error misc FinalParameters Parameter identifier should be final. 179
 Error coding HiddenField 'identifier' hides a field. 179
 Error design DesignForExtension Class 'StreamsConfiguration' looks like designed for extension (can be subclassed), but the method 'withIdentifier' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'StreamsConfiguration' final or making the method 'withIdentifier' static/final/abstract/empty, or adding allowed annotation for the method. 183
 Error javadoc JavadocMethod Missing a Javadoc comment. 183
 Error misc FinalParameters Parameter identifier should be final. 183
 Error coding HiddenField 'identifier' hides a field. 183
 Error javadoc JavadocStyle First sentence should end with a period. 188
 Error regexp RegexpSingleline Line has trailing spaces. 190
 Error javadoc JavadocStyle First sentence should end with a period. 200
 Error regexp RegexpSingleline Line has trailing spaces. 202
 Error misc FinalParameters Parameter parallelism should be final. 208
 Error coding HiddenField 'parallelism' hides a field. 208
 Error design DesignForExtension Class 'StreamsConfiguration' looks like designed for extension (can be subclassed), but the method 'withParallelism' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'StreamsConfiguration' final or making the method 'withParallelism' static/final/abstract/empty, or adding allowed annotation for the method. 212
 Error javadoc JavadocMethod Missing a Javadoc comment. 212
 Error misc FinalParameters Parameter parallelism should be final. 212
 Error coding HiddenField 'parallelism' hides a field. 212
 Error regexp RegexpSingleline Line has trailing spaces. 219
 Error regexp RegexpSingleline Line has trailing spaces. 231
 Error misc FinalParameters Parameter providerTimeoutMs should be final. 237
 Error coding HiddenField 'providerTimeoutMs' hides a field. 237
 Error design DesignForExtension Class 'StreamsConfiguration' looks like designed for extension (can be subclassed), but the method 'withProviderTimeoutMs' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'StreamsConfiguration' final or making the method 'withProviderTimeoutMs' static/final/abstract/empty, or adding allowed annotation for the method. 241
 Error javadoc JavadocMethod Missing a Javadoc comment. 241
 Error misc FinalParameters Parameter providerTimeoutMs should be final. 241
 Error coding HiddenField 'providerTimeoutMs' hides a field. 241
 Error javadoc JavadocStyle First sentence should end with a period. 246
 Error regexp RegexpSingleline Line has trailing spaces. 248
 Error javadoc JavadocStyle First sentence should end with a period. 258
 Error regexp RegexpSingleline Line has trailing spaces. 260
 Error misc FinalParameters Parameter queueSize should be final. 266
 Error coding HiddenField 'queueSize' hides a field. 266
 Error design DesignForExtension Class 'StreamsConfiguration' looks like designed for extension (can be subclassed), but the method 'withQueueSize' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'StreamsConfiguration' final or making the method 'withQueueSize' static/final/abstract/empty, or adding allowed annotation for the method. 270
 Error javadoc JavadocMethod Missing a Javadoc comment. 270
 Error misc FinalParameters Parameter queueSize should be final. 270
 Error coding HiddenField 'queueSize' hides a field. 270
 Error javadoc JavadocStyle First sentence should end with a period. 275
 Error regexp RegexpSingleline Line has trailing spaces. 277
 Error javadoc JavadocStyle First sentence should end with a period. 287
 Error regexp RegexpSingleline Line has trailing spaces. 289
 Error misc FinalParameters Parameter shutdownCheckDelay should be final. 295
 Error coding HiddenField 'shutdownCheckDelay' hides a field. 295
 Error sizes LineLength Line is longer than 80 characters (found 81). 299
 Error design DesignForExtension Class 'StreamsConfiguration' looks like designed for extension (can be subclassed), but the method 'withShutdownCheckDelay' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'StreamsConfiguration' final or making the method 'withShutdownCheckDelay' static/final/abstract/empty, or adding allowed annotation for the method. 299
 Error javadoc JavadocMethod Missing a Javadoc comment. 299
 Error misc FinalParameters Parameter shutdownCheckDelay should be final. 299
 Error coding HiddenField 'shutdownCheckDelay' hides a field. 299
 Error javadoc JavadocStyle First sentence should end with a period. 304
 Error regexp RegexpSingleline Line has trailing spaces. 306
 Error javadoc JavadocStyle First sentence should end with a period. 316
 Error regexp RegexpSingleline Line has trailing spaces. 318
 Error misc FinalParameters Parameter shutdownCheckInterval should be final. 324
 Error coding HiddenField 'shutdownCheckInterval' hides a field. 324
 Error sizes LineLength Line is longer than 80 characters (found 87). 328
 Error design DesignForExtension Class 'StreamsConfiguration' looks like designed for extension (can be subclassed), but the method 'withShutdownCheckInterval' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'StreamsConfiguration' final or making the method 'withShutdownCheckInterval' static/final/abstract/empty, or adding allowed annotation for the method. 328
 Error javadoc JavadocMethod Missing a Javadoc comment. 328
 Error misc FinalParameters Parameter shutdownCheckInterval should be final. 328
 Error coding HiddenField 'shutdownCheckInterval' hides a field. 328
 Error javadoc JavadocStyle First sentence should end with a period. 333
 Error regexp RegexpSingleline Line has trailing spaces. 335
 Error javadoc JavadocStyle First sentence should end with a period. 345
 Error regexp RegexpSingleline Line has trailing spaces. 347
 Error misc FinalParameters Parameter startedAt should be final. 353
 Error coding HiddenField 'startedAt' hides a field. 353
 Error design DesignForExtension Class 'StreamsConfiguration' looks like designed for extension (can be subclassed), but the method 'withStartedAt' does not have javadoc that explains how to do that safely. If class is not designed for extension consider making the class 'StreamsConfiguration' final or making the method 'withStartedAt' static/final/abstract/empty, or adding allowed annotation for the method. 357
 Error javadoc JavadocMethod Missing a Javadoc comment. 357
 Error misc FinalParameters Parameter startedAt should be final. 357
 Error coding HiddenField 'startedAt' hides a field. 357
 Error design DesignForExtension Class 'StreamsConfiguration' 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 'StreamsConfiguration' final or making the method 'toString' static/final/abstract/empty, or adding allowed annotation for the method. 362
 Error design DesignForExtension Class 'StreamsConfiguration' 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 'StreamsConfiguration' final or making the method 'getAdditionalProperties' static/final/abstract/empty, or adding allowed annotation for the method. 367
 Error javadoc JavadocMethod Missing a Javadoc comment. 367
 Error design DesignForExtension Class 'StreamsConfiguration' 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 'StreamsConfiguration' final or making the method 'setAdditionalProperty' static/final/abstract/empty, or adding allowed annotation for the method. 373
 Error javadoc JavadocMethod Missing a Javadoc comment. 373
 Error misc FinalParameters Parameter name should be final. 375
 Error misc FinalParameters Parameter value should be final. 375
 Error sizes LineLength Line is longer than 80 characters (found 83). 379
 Error design DesignForExtension Class 'StreamsConfiguration' 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 'StreamsConfiguration' final or making the method 'withAdditionalProperty' static/final/abstract/empty, or adding allowed annotation for the method. 379
 Error javadoc JavadocMethod Missing a Javadoc comment. 379
 Error misc FinalParameters Parameter name should be final. 379
 Error misc FinalParameters Parameter value should be final. 379
 Error design DesignForExtension Class 'StreamsConfiguration' 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 'StreamsConfiguration' final or making the method 'hashCode' static/final/abstract/empty, or adding allowed annotation for the method. 384
 Error sizes LineLength Line is longer than 80 characters (found 280). 386
 Error design DesignForExtension Class 'StreamsConfiguration' 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 'StreamsConfiguration' final or making the method 'equals' static/final/abstract/empty, or adding allowed annotation for the method. 389
 Error misc FinalParameters Parameter other should be final. 390
 Error coding SimplifyBooleanExpression Expression can be simplified. 394
 Error sizes LineLength Line is longer than 80 characters (found 476). 398

org/apache/streams/config/StreamsConfigurator.java

Severity Category Rule Message Line
 Error sizes LineLength Line is longer than 80 characters (found 81). 32
 Error sizes LineLength Line is longer than 80 characters (found 87). 34
 Error design HideUtilityClassConstructor Utility classes should not have a public or default constructor. 37
 Error sizes LineLength Line is longer than 80 characters (found 92). 39
 Error javadoc JavadocVariable Missing a Javadoc comment. 39
 Error javadoc JavadocVariable Missing a Javadoc comment. 41
 Error naming ConstantName Name 'mapper' must match pattern '^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$'. 41
 Error sizes LineLength Line is longer than 80 characters (found 99). 44
 Error javadoc JavadocVariable Missing a Javadoc comment. 46
 Error design VisibilityModifier Variable 'config' must be private and have accessor methods. 46
 Error javadoc JavadocMethod Missing a Javadoc comment. 48
 Error sizes LineLength Line is longer than 80 characters (found 85). 52
 Error javadoc JavadocMethod Missing a Javadoc comment. 52
 Error misc FinalParameters Parameter configUrl should be final. 52
 Error javadoc JavadocMethod Missing a Javadoc comment. 62
 Error sizes LineLength Line is longer than 80 characters (found 81). 66
 Error javadoc JavadocMethod Missing a Javadoc comment. 66
 Error misc FinalParameters Parameter typesafeConfig should be final. 66
 Error sizes LineLength Line is longer than 80 characters (found 125). 71
 Error sizes LineLength Line is longer than 80 characters (found 85). 80
 Error javadoc JavadocMethod Missing a Javadoc comment. 80
 Error misc FinalParameters Parameter base should be final. 80
 Error misc FinalParameters Parameter delta should be final. 80
 Error sizes LineLength Line is longer than 80 characters (found 117). 87