## Checkstyle Results

The following document contains the results of Checkstyle.

## Summary

Files | Infos | Warnings | Errors
--- | --- | --- | ---
7 | 0 | 0 | 192

## Files

Files | I | W | E
--- | --- | --- | ---
org/apache/any23/cli/Crawler.java | 0 | 0 | 68
org/apache/any23/cli/package-info.java | 0 | 0 | 1
org/apache/any23/plugin/crawler/DefaultWebCrawler.java | 0 | 0 | 20
org/apache/any23/plugin/crawler/SharedData.java | 0 | 0 | 22
org/apache/any23/plugin/crawler/SiteCrawler.java | 0 | 0 | 80
org/apache/any23/plugin/crawler/package-info.java | 0 | 0 | 1

## Rules

Rules | Violations | Severity
--- | --- | ---
JavadocPackage allowLegacy: `"true"` | 0 | Error
NewlineAtEndOfFile | 0 | Error
Translation | 0 | Error
FileLength | 0 | Error
FileTabCharacter eachLine: `"true"` | 0 | Error
RegexpSingleline message: `"Line has trailing spaces."` format: `"\s+$"` | 0 | Error
JavadocMethod | 16 | Error
JavadocType | 0 | Error
JavadocVariable | 3 | Error
JavadocStyle | 2 | Error
ConstantName | 1 | Error
LocalFinalVariableName | 0 | Error
LocalVariableName | 0 | Error
MemberName | 0 | Error
MethodName | 0 | Error
PackageName | 0 | Error
ParameterName | 0 | Error
StaticVariableName | 0 | Error
TypeName | 0 | Error
AvoidStarImport | 0 | Error
IllegalImport | 0 | Error
RedundantImport | 0 | Error
UnusedImports | 0 | Error
LineLength | 41 | Error
MethodLength | 0 | Error
ParameterNumber | 0 | Error
EmptyForIteratorPad | 0 | Error
MethodParamPad | 0 | Error
NoWhitespaceAfter | 2 | Error
NoWhitespaceBefore | 0 | Error
OperatorWrap | 9 | Error
ParenPad | 22 | Error
TypecastParenPad | 0 | Error
WhitespaceAfter | 2 | Error
WhitespaceAround | 25 | Error
ModifierOrder | 0 | Error
RedundantModifier | 0 | Error
AvoidNestedBlocks | 0 | Error
EmptyBlock | 0 | Error
LeftCurly | 0 | Error
NeedBraces | 17 | Error
RightCurly | 0 | Error
AvoidInlineConditionals | 1 | Error
DoubleCheckedLocking | 0 | Error
EmptyStatement | 0 | Error
EqualsHashCode | 0 | Error
HiddenField | 5 | Error
IllegalInstantiation | 0 | Error
InnerAssignment | 0 | Error
MagicNumber | 1 | Error
MissingSwitchDefault | 0 | Error
RedundantThrows | 0 | Error
SimplifyBooleanExpression | 0 | Error
SimplifyBooleanReturn | 0 | Error
DesignForExtension | 19 | Error
FinalClass | 1 | Error
HideUtilityClassConstructor | 0 | Error
InterfaceIsType | 0 | Error
VisibilityModifier | 1 | Error
ArrayTypeStyle | 0 | Error
FinalParameters | 25 | Error
TodoComment | 1 | Error
UpperEll | 0 | Error

## Details

### org/apache/any23/cli/Crawler.java

Violation | Message | Line
--- | --- | ---
| Missing a Javadoc comment. | 44
| Missing a Javadoc comment. | 46
| Parameter args should be final. | 46
| '(' is followed by whitespace. | 48
| ')' is preceded with whitespace. | 48
| Method 'run' is not designed for extension - needs to be abstract, final or empty. | 54
| Parameter args should be final. | 55
| 'if' construct must use '{}'s. | 58
| Line is longer than 80 characters. | 58
| 'if' is not followed by whitespace. | 58
| Line is longer than 80 characters. | 63
| '(' is followed by whitespace. | 63
| ')' is preceded with whitespace. | 63
| Line is longer than 80 characters. | 66
| Avoid inline conditionals. | 66
| 'if' is not followed by whitespace. | 68
| Line is longer than 80 characters. | 69
| '(' is followed by whitespace. | 69
| ')' is preceded with whitespace. | 69
| 'if' is not followed by whitespace. | 71
| 'if' is not followed by whitespace. | 74
| Line is longer than 80 characters. | 78
| 'if' construct must use '{}'s. | 79
| Line is longer than 80 characters. | 79
| 'if' is not followed by whitespace. | 79
| Parameter page should be final. | 84
| Line is longer than 80 characters. | 86
| '(' is followed by whitespace. | 86
| ')' is preceded with whitespace. | 86
| Line is longer than 80 characters. | 99
| '(' is followed by whitespace. | 105
| '(' is followed by whitespace. | 109
| ')' is preceded with whitespace. | 109
| Comment matches to-do format 'TODO:'. | 110
| 'if' construct must use '{}'s. | 119
| 'if' is not followed by whitespace. | 119
| 'if' is not followed by whitespace. | 120
| Method 'createOptions' is not designed for extension - needs to be abstract, final or empty. | 127
| Missing a Javadoc comment. | 134
| Parameter options should be final. | 134
| Line is longer than 80 characters. | 136
| Line is longer than 80 characters. | 139
| Line is longer than 80 characters. | 142
| Line is longer than 80 characters. | 145
| Line is longer than 80 characters. | 148
| Line is longer than 80 characters. | 151
| Missing a Javadoc comment. | 155
| Parameter commandLine should be final. | 155
| 'if' is not followed by whitespace. | 156
| Line is longer than 80 characters. | 158
| '(' is followed by whitespace. | 158
| ')' is preceded with whitespace. | 158
| Line is longer than 80 characters. | 160
| '6' is a magic number. | 160
| Missing a Javadoc comment. | 166
| Parameter commandLine should be final. | 166
| 'if' is not followed by whitespace. | 167
| Line is longer than 80 characters. | 168
| '(' is followed by whitespace. | 168
| ')' is preceded with whitespace. | 168
| 'if' construct must use '{}'s. | 169
| 'if' is not followed by whitespace. | 169
| Line is longer than 80 characters. | 170
| Line is longer than 80 characters. | 173
| Missing a Javadoc comment. | 179
| Parameter cl should be final. | 179
| Parameter option should be final. | 179
| Line is longer than 80 characters. | 184

### org/apache/any23/cli/package-info.java

Violation | Message | Line
--- | --- | ---
| First sentence should end with a period. | 18

### org/apache/any23/plugin/crawler/DefaultWebCrawler.java

Violation | Message | Line
--- | --- | ---
| Line is longer than 80 characters. | 35
| Missing a Javadoc comment. | 35
| Name 'logger' must match pattern '^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$'. | 35
| Line is longer than 80 characters. | 48
| Expected an @return tag. | 50
| Method 'shouldVisit' is not designed for extension - needs to be abstract, final or empty. | 50
| Parameter url should be final. | 51
| Expected @param tag for 'url'. | 51
| 'if' construct must use '{}'s. | 52
| 'if' construct must use '{}'s. | 54
| 'if' is not followed by whitespace. | 54
| '(' is followed by whitespace. | 54
| '!' is followed by whitespace. | 54
| '(' is followed by whitespace. | 54
| ')' is preceded with whitespace. | 54
| ')' is preceded with whitespace. | 54
| '!' is followed by whitespace. | 55
| Method 'visit' is not designed for extension - needs to be abstract, final or empty. | 61
| Parameter page should be final. | 62
| Expected @param tag for 'page'. | 62

### org/apache/any23/plugin/crawler/SharedData.java

Violation | Message | Line
--- | --- | ---
| Class SharedData should be declared as final. | 32
| 'if' construct must use '{}'s. | 63
| Line is longer than 80 characters. | 63
| 'if' is not followed by whitespace. | 63
| Line is longer than 80 characters. | 74
| Parameter seed should be final. | 74
| Parameter regex should be final. | 74
| Parameter listeners should be final. | 74
| Line is longer than 80 characters. | 85
| Parameter seed should be final. | 85
| 'seed' hides a field. | 85
| Expected @param tag for 'seed'. | 85
| Parameter pattern should be final. | 85
| 'pattern' hides a field. | 85
| Expected @param tag for 'pattern'. | 85
| Parameter listeners should be final. | 85
| 'listeners' hides a field. | 85
| Expected @param tag for 'listeners'. | 85
| 'if' construct must use '{}'s. | 86
| 'if' is not followed by whitespace. | 86
| Parameter page should be final. | 115
| 'for' is not followed by whitespace. | 116

### org/apache/any23/plugin/crawler/SiteCrawler.java

Violation | Message | Line
--- | --- | ---
| Missing a Javadoc comment. | 40
| '+' should be on a new line. | 41
| '+' should be on a new line. | 42
| '+' should be on a new line. | 43
| '+' should be on a new line. | 44
| '+' should be on a new line. | 45
| '+' should be on a new line. | 46
| '+' should be on a new line. | 47
| '+' should be on a new line. | 48
| '+' should be on a new line. | 49
| Line is longer than 80 characters. | 60
| Line is longer than 80 characters. | 65
| Variable 'defaultFilters' must be private and have accessor methods. | 65
| Line is longer than 80 characters. | 75
| Line is longer than 80 characters. | 110
| Parameter storageFolder should be final. | 112
| '(' is followed by whitespace. | 114
| ')' is preceded with whitespace. | 114
| Line is longer than 80 characters. | 116
| Method 'getNumOfCrawlers' is not designed for extension - needs to be abstract, final or empty. | 123
| Method 'setNumOfCrawlers' is not designed for extension - needs to be abstract, final or empty. | 132
| Parameter n should be final. | 132
| 'if' construct must use '{}'s. | 133
| Line is longer than 80 characters. | 133
| 'if' is not followed by whitespace. | 133
| '<=' is not followed by whitespace. | 133
| Method 'getWebCrawler' is not designed for extension - needs to be abstract, final or empty. | 137
| Missing a Javadoc comment. | 137
| Method 'setWebCrawler' is not designed for extension - needs to be abstract, final or empty. | 146
| Parameter c should be final. | 146
| 'if' construct must use '{}'s. | 147
| 'if' is not followed by whitespace. | 147
| Method 'getMaxDepth' is not designed for extension - needs to be abstract, final or empty. | 154
| Method 'setMaxDepth' is not designed for extension - needs to be abstract, final or empty. | 163
| Parameter maxDepth should be final. | 163
| 'maxDepth' hides a field. | 163
| 'if' construct must use '{}'s. | 164
| Line is longer than 80 characters. | 164
| 'if' is not followed by whitespace. | 164
| 'if' construct must use '{}'s. | 165
| 'if' is not followed by whitespace. | 165
| Line is longer than 80 characters. | 168
| Method 'getMaxPages' is not designed for extension - needs to be abstract, final or empty. | 176
| Method 'setMaxPages' is not designed for extension - needs to be abstract, final or empty. | 185
| Parameter maxPages should be final. | 185
| 'maxPages' hides a field. | 185
| 'if' construct must use '{}'s. | 186
| Line is longer than 80 characters. | 186
| 'if' is not followed by whitespace. | 186
| 'if' construct must use '{}'s. | 187
| 'if' is not followed by whitespace. | 187
| Method 'getPolitenessDelay' is not designed for extension - needs to be abstract, final or empty. | 194
| Method 'setPolitenessDelay' is not designed for extension - needs to be abstract, final or empty. | 203
| Parameter millis should be final. | 203
| 'if' construct must use '{}'s. | 204
| Line is longer than 80 characters. | 204
| 'if' is not followed by whitespace. | 204
| 'if' construct must use '{}'s. | 205
| 'if' is not followed by whitespace. | 205
| Method 'addListener' is not designed for extension - needs to be abstract, final or empty. | 214
| Parameter listener should be final. | 214
| Expected @param tag for 'listener'. | 214
| Method 'removeListener' is not designed for extension - needs to be abstract, final or empty. | 223
| Parameter listener should be final. | 223
| Expected @param tag for 'listener'. | 223
| Line is longer than 80 characters. | 231
| Line is longer than 80 characters. | 232
| Method 'start' is not designed for extension - needs to be abstract, final or empty. | 235
| Expected @throws tag for 'Exception'. | 237
| Line is longer than 80 characters. | 238
| ')' is preceded with whitespace. | 238
| 'if' is not followed by whitespace. | 246
| 'if' construct must use '{}'s. | 249
| Line is longer than 80 characters. | 249
| 'if' is not followed by whitespace. | 249
| Line is longer than 80 characters. | 259
| Method 'start' is not designed for extension - needs to be abstract, final or empty. | 262
| Expected @throws tag for 'Exception'. | 262
| Line is longer than 80 characters. | 267
| Method 'stop' is not designed for extension - needs to be abstract, final or empty. | 269

### org/apache/any23/plugin/crawler/package-info.java

Violation | Message | Line
--- | --- | ---
| First sentence should end with a period. | 18