Apache log4j logo Apache logging services logo

Checkstyle Results

The following document contains the results of Checkstyle 6.11.2 with /Users/rgoers/projects/apache/logging/log4j/log4j-audit-1.0.1/log4j-audit/log4j-audit-api/../../checkstyle.xml ruleset. rss feed

Summary

Files  Info  Warnings  Errors
45 0 0 157

Files

File  I  W  E
org/apache/logging/log4j/audit/AbstractEventLogger.java 0 0 14
org/apache/logging/log4j/audit/ActivityLogger.java 0 0 1
org/apache/logging/log4j/audit/AuditLogger.java 0 0 1
org/apache/logging/log4j/audit/AuditMessage.java 0 0 1
org/apache/logging/log4j/audit/LogEventFactory.java 0 0 14
org/apache/logging/log4j/audit/annotation/Chained.java 0 0 3
org/apache/logging/log4j/audit/annotation/ChainedSupplier.java 0 0 1
org/apache/logging/log4j/audit/annotation/ClientServer.java 0 0 2
org/apache/logging/log4j/audit/annotation/Constraint.java 0 0 2
org/apache/logging/log4j/audit/annotation/HeaderPrefix.java 0 0 1
org/apache/logging/log4j/audit/annotation/Local.java 0 0 2
org/apache/logging/log4j/audit/annotation/RequestContext.java 0 0 1
org/apache/logging/log4j/audit/catalog/CatalogManager.java 0 0 1
org/apache/logging/log4j/audit/catalog/CatalogManagerImpl.java 0 0 10
org/apache/logging/log4j/audit/dto/AuditDto.java 0 0 1
org/apache/logging/log4j/audit/exception/ConstraintValidationException.java 0 0 1
org/apache/logging/log4j/audit/generator/AccessorDefinition.java 0 0 12
org/apache/logging/log4j/audit/generator/ClassGenerator.java 0 0 9
org/apache/logging/log4j/audit/generator/Constants.java 0 0 2
org/apache/logging/log4j/audit/generator/ConstructorDefinition.java 0 0 4
org/apache/logging/log4j/audit/generator/InterfacesGenerator.java 0 0 5
org/apache/logging/log4j/audit/generator/MethodDefinition.java 0 0 18
org/apache/logging/log4j/audit/generator/Parameter.java 0 0 2
org/apache/logging/log4j/audit/generator/VariableDefinition.java 0 0 2
org/apache/logging/log4j/audit/layout/AuditLayout.java 0 0 2
org/apache/logging/log4j/audit/request/ChainedMapping.java 0 0 1
org/apache/logging/log4j/audit/request/RequestContextMapping.java 0 0 1
org/apache/logging/log4j/audit/request/RequestContextMappings.java 0 0 6
org/apache/logging/log4j/audit/request/Scope.java 0 0 4
org/apache/logging/log4j/audit/rest/ElapsedUtil.java 0 0 8
org/apache/logging/log4j/audit/rest/RequestContextFilter.java 0 0 11
org/apache/logging/log4j/audit/rest/RequestContextHandlerInterceptor.java 0 0 6
org/apache/logging/log4j/audit/rest/RequestContextHeaderInterceptor.java 0 0 1
org/apache/logging/log4j/audit/util/JsonObjectMapperFactory.java 0 0 2
org/apache/logging/log4j/audit/util/NamingUtils.java 0 0 1
org/apache/logging/log4j/audit/util/StringUtil.java 0 0 4

Details

org/apache/logging/log4j/audit/AbstractEventLogger.java

Severity Category Rule Message Line
 Error imports ImportOrder Wrong order for 'org.apache.logging.log4j.audit.exception.ConstraintValidationException' import. 29
 Error imports AvoidStarImport Using the '.*' form of import should be avoided - java.util.*. 33
 Error imports ImportOrder Wrong order for 'java.util.*' import. 33
 Error naming ConstantName Name 'logger' must match pattern '^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$|^capabilities$|^log$'. 42
 Error javadoc JavadocVariable Missing a Javadoc comment. 48
 Error design VisibilityModifier Variable 'catalogManager' must be private and have accessor methods. 48
 Error coding DeclarationOrder Static variable definition in wrong order. 50
 Error coding DeclarationOrder Static variable definition in wrong order. 54
 Error sizes LineLength Line is longer than 120 characters (found 135). 93
 Error sizes LineLength Line is longer than 120 characters (found 121). 95
 Error sizes LineLength Line is longer than 120 characters (found 136). 146
 Error sizes LineLength Line is longer than 120 characters (found 127). 162
 Error sizes LineLength Line is longer than 120 characters (found 142). 209
 Error sizes LineLength Line is longer than 120 characters (found 121). 227

org/apache/logging/log4j/audit/ActivityLogger.java

Severity Category Rule Message Line
 Error naming StaticVariableName Name 'EVENT_MARKER' must match pattern '^[a-z][a-zA-Z0-9]*$'. 34

org/apache/logging/log4j/audit/AuditLogger.java

Severity Category Rule Message Line
 Error naming StaticVariableName Name 'EVENT_MARKER' must match pattern '^[a-z][a-zA-Z0-9]*$'. 35

org/apache/logging/log4j/audit/AuditMessage.java

Severity Category Rule Message Line
 Error javadoc JavadocType Missing a Javadoc comment. 48

org/apache/logging/log4j/audit/LogEventFactory.java

Severity Category Rule Message Line
 Error javadoc JavadocPackage Missing package-info.java file.
 Error imports AvoidStarImport Using the '.*' form of import should be avoided - java.util.*. 23
 Error imports ImportOrder Wrong order for 'org.apache.logging.log4j.audit.exception.ConstraintValidationException' import. 39
 Error design HideUtilityClassConstructor Utility classes should not have a public or default constructor. 49
 Error naming ConstantName Name 'logger' must match pattern '^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$|^capabilities$|^log$'. 51
 Error whitespace FileTabCharacter File contains tab characters (this is the first instance). 74
 Error whitespace NoWhitespaceAfter '{' is followed by whitespace. 87
 Error sizes LineLength Line is longer than 120 characters (found 141). 151
 Error sizes LineLength Line is longer than 120 characters (found 141). 161
 Error javadoc JavadocType Missing a Javadoc comment. 255
 Error sizes LineLength Line is longer than 120 characters (found 135). 300
 Error sizes LineLength Line is longer than 120 characters (found 123). 330
 Error javadoc JavadocType Missing a Javadoc comment. 398
 Error modifier RedundantModifier Redundant 'public' modifier. 403

org/apache/logging/log4j/audit/annotation/Chained.java

Severity Category Rule Message Line
 Error imports UnusedImports Unused import - java.util.function.Consumer. 23
 Error imports UnusedImports Unused import - java.util.function.Supplier. 24
 Error javadoc JavadocType Missing a Javadoc comment. 26

org/apache/logging/log4j/audit/annotation/ChainedSupplier.java

Severity Category Rule Message Line
 Error javadoc JavadocType Missing a Javadoc comment. 24

org/apache/logging/log4j/audit/annotation/ClientServer.java

Severity Category Rule Message Line
 Error imports UnusedImports Unused import - java.lang.annotation.Repeatable. 20
 Error javadoc JavadocType Missing a Javadoc comment. 25

org/apache/logging/log4j/audit/annotation/Constraint.java

Severity Category Rule Message Line
 Error javadoc JavadocType Missing a Javadoc comment. 25
 Error whitespace FileTabCharacter File contains tab characters (this is the first instance). 30

org/apache/logging/log4j/audit/annotation/HeaderPrefix.java

Severity Category Rule Message Line
 Error javadoc JavadocType Missing a Javadoc comment. 24

org/apache/logging/log4j/audit/annotation/Local.java

Severity Category Rule Message Line
 Error javadoc JavadocPackage Missing package-info.java file.
 Error javadoc JavadocType Missing a Javadoc comment. 24

org/apache/logging/log4j/audit/annotation/RequestContext.java

Severity Category Rule Message Line
 Error javadoc JavadocMethod Expected an @return tag. 41

org/apache/logging/log4j/audit/catalog/CatalogManager.java

Severity Category Rule Message Line
 Error imports ImportOrder Wrong order for 'java.util.List' import. 22

org/apache/logging/log4j/audit/catalog/CatalogManagerImpl.java

Severity Category Rule Message Line
 Error javadoc JavadocPackage Missing package-info.java file.
 Error imports ImportOrder Wrong order for 'org.apache.logging.log4j.LogManager' import. 29
 Error imports ImportOrder Wrong order for 'org.apache.logging.log4j.catalog.api.CatalogReader' import. 36
 Error imports ImportOrder 'org.apache.logging.log4j.catalog.api.constant.Constants.DEFAULT_CATALOG' should be separated from previous imports. 40
 Error javadoc JavadocVariable Missing a Javadoc comment. 53
 Error coding DeclarationOrder Variable access definition in wrong order. 53
 Error coding DeclarationOrder Static variable definition in wrong order. 55
 Error javadoc JavadocVariable Missing a Javadoc comment. 57
 Error coding DeclarationOrder Variable access definition in wrong order. 57
 Error javadoc JavadocType Missing a Javadoc comment. 206

org/apache/logging/log4j/audit/dto/AuditDto.java

Severity Category Rule Message Line
 Error javadoc JavadocPackage Missing package-info.java file.

org/apache/logging/log4j/audit/exception/ConstraintValidationException.java

Severity Category Rule Message Line
 Error javadoc JavadocPackage Missing package-info.java file.

org/apache/logging/log4j/audit/generator/AccessorDefinition.java

Severity Category Rule Message Line
 Error javadoc JavadocType Missing a Javadoc comment. 22
 Error javadoc JavadocType Missing a Javadoc comment. 24
 Error whitespace FileTabCharacter File contains tab characters (this is the first instance). 24
 Error javadoc JavadocType Missing a Javadoc comment. 38
 Error coding DeclarationOrder Instance variable definition in wrong order. 60
 Error coding DeclarationOrder Instance variable definition in wrong order. 61
 Error coding DeclarationOrder Instance variable definition in wrong order. 62
 Error coding DeclarationOrder Instance variable definition in wrong order. 64
 Error coding DeclarationOrder Instance variable definition in wrong order. 66
 Error coding DeclarationOrder Instance variable definition in wrong order. 67
 Error coding DeclarationOrder Constructor definition in wrong order. 77
 Error coding DeclarationOrder Constructor definition in wrong order. 81

org/apache/logging/log4j/audit/generator/ClassGenerator.java

Severity Category Rule Message Line
 Error misc NewlineAtEndOfFile File does not end with a newline.
 Error imports UnusedImports Unused import - java.util.Iterator. 27
 Error imports UnusedImports Unused import - java.util.TreeSet. 30
 Error javadoc JavadocVariable Missing a Javadoc comment. 44
 Error javadoc JavadocStyle First sentence should end with a period. 87
 Error javadoc JavadocMethod Expected an @return tag. 94
 Error coding HiddenField 'isAbstract' hides a field. 190
 Error coding HiddenField 'isClass' hides a field. 198
 Error javadoc JavadocStyle First sentence should end with a period. 202

org/apache/logging/log4j/audit/generator/Constants.java

Severity Category Rule Message Line
 Error design HideUtilityClassConstructor Utility classes should not have a public or default constructor. 22
 Error javadoc JavadocVariable Missing a Javadoc comment. 24

org/apache/logging/log4j/audit/generator/ConstructorDefinition.java

Severity Category Rule Message Line
 Error javadoc JavadocPackage Missing package-info.java file.
 Error javadoc JavadocType Missing a Javadoc comment. 25
 Error whitespace EmptyForIteratorPad ';' is followed by whitespace. 88
 Error whitespace EmptyForIteratorPad ';' is followed by whitespace. 102

org/apache/logging/log4j/audit/generator/InterfacesGenerator.java

Severity Category Rule Message Line
 Error javadoc JavadocType Missing a Javadoc comment. 39
 Error sizes MethodLength Method length is 189 lines (max allowed is 150). 123
 Error sizes LineLength Line is longer than 120 characters (found 131). 207
 Error sizes LineLength Line is longer than 120 characters (found 149). 268
 Error sizes LineLength Line is longer than 120 characters (found 121). 315

org/apache/logging/log4j/audit/generator/MethodDefinition.java

Severity Category Rule Message Line
 Error imports ImportOrder 'org.apache.logging.log4j.audit.generator.Constants.PUBLIC' should be separated from previous imports. 26
 Error javadoc JavadocType Missing a Javadoc comment. 28
 Error javadoc JavadocType Missing a Javadoc comment. 54
 Error javadoc JavadocStyle First sentence should end with a period. 55
 Error javadoc JavadocMethod Expected @param tag for 'returnType'. 58
 Error javadoc JavadocMethod Expected @param tag for 'name'. 58
 Error javadoc JavadocMethod Expected @param tag for 'parameters'. 58
 Error whitespace EmptyForIteratorPad ';' is followed by whitespace. 70
 Error coding DeclarationOrder Static variable definition in wrong order. 84
 Error coding DeclarationOrder Constructor definition in wrong order. 92
 Error coding DeclarationOrder Constructor definition in wrong order. 102
 Error coding HiddenField 'content' hides a field. 107
 Error coding DeclarationOrder Constructor definition in wrong order. 134
 Error coding DeclarationOrder Constructor definition in wrong order. 138
 Error coding HiddenField 'isAbstract' hides a field. 206
 Error coding HiddenField 'isFinal' hides a field. 222
 Error coding HiddenField 'isInterface' hides a field. 226
 Error coding HiddenField 'isStatic' hides a field. 238

org/apache/logging/log4j/audit/generator/Parameter.java

Severity Category Rule Message Line
 Error javadoc JavadocType Missing a Javadoc comment. 19
 Error coding HiddenField 'isFinal' hides a field. 47

org/apache/logging/log4j/audit/generator/VariableDefinition.java

Severity Category Rule Message Line
 Error javadoc JavadocType Missing a Javadoc comment. 19
 Error whitespace FileTabCharacter File contains tab characters (this is the first instance). 20

org/apache/logging/log4j/audit/layout/AuditLayout.java

Severity Category Rule Message Line
 Error javadoc JavadocPackage Missing package-info.java file.
 Error javadoc JavadocType Missing a Javadoc comment. 19

org/apache/logging/log4j/audit/request/ChainedMapping.java

Severity Category Rule Message Line
 Error design VisibilityModifier Variable 'supplier' must be private and have accessor methods. 26

org/apache/logging/log4j/audit/request/RequestContextMapping.java

Severity Category Rule Message Line
 Error javadoc JavadocType Missing a Javadoc comment. 20

org/apache/logging/log4j/audit/request/RequestContextMappings.java

Severity Category Rule Message Line
 Error javadoc JavadocPackage Missing package-info.java file.
 Error imports UnusedImports Unused import - org.apache.logging.log4j.audit.annotation.ChainedSupplier. 26
 Error javadoc JavadocType Missing a Javadoc comment. 31
 Error coding DeclarationOrder Constructor definition in wrong order. 52
 Error sizes LineLength Line is longer than 120 characters (found 123). 57
 Error sizes LineLength Line is longer than 120 characters (found 131). 90

org/apache/logging/log4j/audit/request/Scope.java

Severity Category Rule Message Line
 Error javadoc JavadocType Missing a Javadoc comment. 19
 Error javadoc JavadocVariable Missing a Javadoc comment. 20
 Error javadoc JavadocVariable Missing a Javadoc comment. 20
 Error javadoc JavadocVariable Missing a Javadoc comment. 20

org/apache/logging/log4j/audit/rest/ElapsedUtil.java

Severity Category Rule Message Line
 Error javadoc JavadocType Missing a Javadoc comment. 21
 Error design HideUtilityClassConstructor Utility classes should not have a public or default constructor. 21
 Error naming StaticVariableName Name 'NANO_PER_SECOND' must match pattern '^[a-z][a-zA-Z0-9]*$'. 23
 Error coding MagicNumber '1000000000L' is a magic number. 23
 Error naming StaticVariableName Name 'NANO_PER_MINUTE' must match pattern '^[a-z][a-zA-Z0-9]*$'. 24
 Error coding MagicNumber '60' is a magic number. 24
 Error naming StaticVariableName Name 'NANO_PER_HOUR' must match pattern '^[a-z][a-zA-Z0-9]*$'. 25
 Error coding MagicNumber '60' is a magic number. 25

org/apache/logging/log4j/audit/rest/RequestContextFilter.java

Severity Category Rule Message Line
 Error imports UnusedImports Unused import - java.text.DecimalFormat. 20
 Error naming ConstantName Name 'logger' must match pattern '^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$|^capabilities$|^log$'. 44
 Error javadoc JavadocMethod Expected @param tag for 'servletRequest'. 77
 Error javadoc JavadocMethod Expected @param tag for 'servletResponse'. 77
 Error javadoc JavadocMethod Expected @param tag for 'filterChain'. 77
 Error javadoc JavadocMethod Expected @throws tag for 'IOException'. 78
 Error javadoc JavadocMethod Expected @throws tag for 'ServletException'. 78
 Error sizes LineLength Line is longer than 120 characters (found 129). 92
 Error whitespace WhitespaceAfter 'typecast' is not followed by whitespace. 93
 Error sizes LineLength Line is longer than 120 characters (found 130). 98
 Error sizes LineLength Line is longer than 120 characters (found 126). 109

org/apache/logging/log4j/audit/rest/RequestContextHandlerInterceptor.java

Severity Category Rule Message Line
 Error imports ImportOrder Wrong order for 'java.util.Enumeration' import. 21
 Error naming ConstantName Name 'logger' must match pattern '^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$|^capabilities$|^log$'. 37
 Error sizes LineLength Line is longer than 120 characters (found 121). 56
 Error sizes LineLength Line is longer than 120 characters (found 122). 62
 Error sizes LineLength Line is longer than 120 characters (found 140). 73
 Error sizes LineLength Line is longer than 120 characters (found 153). 84

org/apache/logging/log4j/audit/rest/RequestContextHeaderInterceptor.java

Severity Category Rule Message Line
 Error javadoc JavadocPackage Missing package-info.java file.

org/apache/logging/log4j/audit/util/JsonObjectMapperFactory.java

Severity Category Rule Message Line
 Error sizes LineLength Line is longer than 120 characters (found 122). 54
 Error sizes LineLength Line is longer than 120 characters (found 122). 74

org/apache/logging/log4j/audit/util/NamingUtils.java

Severity Category Rule Message Line
 Error javadoc JavadocType Missing a Javadoc comment. 19

org/apache/logging/log4j/audit/util/StringUtil.java

Severity Category Rule Message Line
 Error javadoc JavadocPackage Missing package-info.java file.
 Error javadoc JavadocType Missing a Javadoc comment. 19
 Error design HideUtilityClassConstructor Utility classes should not have a public or default constructor. 19
 Error whitespace FileTabCharacter File contains tab characters (this is the first instance). 21