Apache log4j logo Apache logging services logo
Log4j Catalog API ™

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-catalog/log4j-catalog-api/../../checkstyle.xml ruleset. rss feed

Summary

Files  Info  Warnings  Errors
44 0 0 144

Files

File  I  W  E
org/apache/logging/log4j/catalog/api/Attribute.java 0 0 11
org/apache/logging/log4j/catalog/api/CatalogReader.java 0 0 4
org/apache/logging/log4j/catalog/api/CatalogWriter.java 0 0 2
org/apache/logging/log4j/catalog/api/Category.java 0 0 4
org/apache/logging/log4j/catalog/api/Constraint.java 0 0 4
org/apache/logging/log4j/catalog/api/ConstraintType.java 0 0 4
org/apache/logging/log4j/catalog/api/DataType.java 0 0 12
org/apache/logging/log4j/catalog/api/Event.java 0 0 8
org/apache/logging/log4j/catalog/api/EventAttribute.java 0 0 1
org/apache/logging/log4j/catalog/api/ListResponse.java 0 0 2
org/apache/logging/log4j/catalog/api/Product.java 0 0 4
org/apache/logging/log4j/catalog/api/Versions.java 0 0 11
org/apache/logging/log4j/catalog/api/annotation/ConditionOnPropertyExists.java 0 0 3
org/apache/logging/log4j/catalog/api/annotation/JdbcUrl.java 0 0 2
org/apache/logging/log4j/catalog/api/annotation/JdbcUrlCondition.java 0 0 1
org/apache/logging/log4j/catalog/api/annotation/PropertyExistsCondition.java 0 0 2
org/apache/logging/log4j/catalog/api/constant/Constants.java 0 0 3
org/apache/logging/log4j/catalog/api/dao/AbstractCatalogReader.java 0 0 4
org/apache/logging/log4j/catalog/api/dao/CatalogDao.java 0 0 1
org/apache/logging/log4j/catalog/api/dao/ClassPathCatalogReader.java 0 0 4
org/apache/logging/log4j/catalog/api/dao/FileCatalogReader.java 0 0 3
org/apache/logging/log4j/catalog/api/dao/JsonCatalogReader.java 0 0 2
org/apache/logging/log4j/catalog/api/exception/ConstraintCreationException.java 0 0 1
org/apache/logging/log4j/catalog/api/package-info.java 0 0 2
org/apache/logging/log4j/catalog/api/plugins/CaseInsensitiveEnumConstraint.java 0 0 2
org/apache/logging/log4j/catalog/api/plugins/ConstraintPlugins.java 0 0 6
org/apache/logging/log4j/catalog/api/plugins/ConstraintTypeDeserializer.java 0 0 3
org/apache/logging/log4j/catalog/api/plugins/ConstraintTypeSerializer.java 0 0 8
org/apache/logging/log4j/catalog/api/plugins/EnumConstraint.java 0 0 2
org/apache/logging/log4j/catalog/api/plugins/MaxLengthConstraint.java 0 0 4
org/apache/logging/log4j/catalog/api/plugins/MaxValueConstraint.java 0 0 4
org/apache/logging/log4j/catalog/api/plugins/MinLengthConstraint.java 0 0 4
org/apache/logging/log4j/catalog/api/plugins/MinValueConstraint.java 0 0 4
org/apache/logging/log4j/catalog/api/plugins/PatternConstraint.java 0 0 3
org/apache/logging/log4j/catalog/api/util/CatalogEventFilter.java 0 0 4
org/apache/logging/log4j/catalog/api/util/ProfileUtil.java 0 0 2
org/apache/logging/log4j/catalog/api/util/StringUtils.java 0 0 3

Details

org/apache/logging/log4j/catalog/api/Attribute.java

Severity Category Rule Message Line
 Error javadoc JavadocMethod Expected an @return tag. 70
 Error coding HiddenField 'name' hides a field. 79
 Error coding HiddenField 'name' hides a field. 97
 Error coding HiddenField 'description' hides a field. 115
 Error coding HiddenField 'dataType' hides a field. 133
 Error coding HiddenField 'indexed' hides a field. 151
 Error coding HiddenField 'sortable' hides a field. 169
 Error coding HiddenField 'required' hides a field. 187
 Error coding HiddenField 'examples' hides a field. 223
 Error coding HiddenField 'aliases' hides a field. 241
 Error coding HiddenField 'constraints' hides a field. 259

org/apache/logging/log4j/catalog/api/CatalogReader.java

Severity Category Rule Message Line
 Error javadoc JavadocMethod Expected an @return tag. 65
 Error javadoc JavadocMethod Expected @param tag for 'name'. 65
 Error javadoc JavadocMethod Expected an @return tag. 72
 Error javadoc JavadocMethod Expected @param tag for 'name'. 72

org/apache/logging/log4j/catalog/api/CatalogWriter.java

Severity Category Rule Message Line
 Error header Header Line does not match expected header line of ' * Licensed to the Apache Software Foundation (ASF) under one or more'. 2
 Error javadoc JavadocType Missing a Javadoc comment. 18

org/apache/logging/log4j/catalog/api/Category.java

Severity Category Rule Message Line
 Error javadoc JavadocStyle First sentence should end with a period. 37
 Error coding HiddenField 'name' hides a field. 95
 Error javadoc JavadocMethod Expected an @return tag. 149
 Error coding HiddenField 'events' hides a field. 149

org/apache/logging/log4j/catalog/api/Constraint.java

Severity Category Rule Message Line
 Error imports ImportOrder Wrong order for 'org.apache.logging.log4j.catalog.api.ConstraintType' import. 22
 Error imports RedundantImport Redundant import from the same package - org.apache.logging.log4j.catalog.api.ConstraintType. 22
 Error coding HiddenField 'constraintType' hides a field. 56
 Error coding HiddenField 'value' hides a field. 65

org/apache/logging/log4j/catalog/api/ConstraintType.java

Severity Category Rule Message Line
 Error header Header Line does not match expected header line of ' * Licensed to the Apache Software Foundation (ASF) under one or more'. 2
 Error imports ImportOrder Wrong order for 'org.apache.logging.log4j.catalog.api.exception.NameNotFoundException' import. 20
 Error javadoc JavadocVariable Missing a Javadoc comment. 32
 Error modifier RedundantModifier Redundant 'public' modifier. 32

org/apache/logging/log4j/catalog/api/DataType.java

Severity Category Rule Message Line
 Error javadoc JavadocVariable Missing a Javadoc comment. 24
 Error javadoc JavadocVariable Missing a Javadoc comment. 25
 Error javadoc JavadocVariable Missing a Javadoc comment. 26
 Error javadoc JavadocVariable Missing a Javadoc comment. 27
 Error javadoc JavadocVariable Missing a Javadoc comment. 28
 Error javadoc JavadocVariable Missing a Javadoc comment. 29
 Error javadoc JavadocVariable Missing a Javadoc comment. 30
 Error javadoc JavadocVariable Missing a Javadoc comment. 31
 Error javadoc JavadocVariable Missing a Javadoc comment. 32
 Error javadoc JavadocVariable Missing a Javadoc comment. 36
 Error coding DeclarationOrder Variable access definition in wrong order. 36
 Error design VisibilityModifier Variable 'importClass' must be private and have accessor methods. 36

org/apache/logging/log4j/catalog/api/Event.java

Severity Category Rule Message Line
 Error coding HiddenField 'name' hides a field. 78
 Error coding HiddenField 'name' hides a field. 96
 Error coding HiddenField 'description' hides a field. 114
 Error javadoc JavadocMethod Expected an @return tag. 131
 Error coding HiddenField 'catalogId' hides a field. 131
 Error coding HiddenField 'aliases' hides a field. 151
 Error coding HiddenField 'attributes' hides a field. 169
 Error sizes LineLength Line is longer than 120 characters (found 141). 185

org/apache/logging/log4j/catalog/api/EventAttribute.java

Severity Category Rule Message Line
 Error javadoc JavadocStyle First sentence should end with a period. 21

org/apache/logging/log4j/catalog/api/ListResponse.java

Severity Category Rule Message Line
 Error header Header Line does not match expected header line of ' * Licensed to the Apache Software Foundation (ASF) under one or more'. 2
 Error javadoc JavadocType Type Javadoc comment is missing an @param <T> tag. 23

org/apache/logging/log4j/catalog/api/Product.java

Severity Category Rule Message Line
 Error coding HiddenField 'name' hides a field. 74
 Error coding HiddenField 'name' hides a field. 92
 Error coding HiddenField 'description' hides a field. 110
 Error coding HiddenField 'events' hides a field. 144

org/apache/logging/log4j/catalog/api/Versions.java

Severity Category Rule Message Line
 Error javadoc JavadocType Missing a Javadoc comment. 24
 Error naming ConstantName Name 'type' must match pattern '^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$|^capabilities$|^log$'. 26
 Error naming ConstantName Name 'subType' must match pattern '^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$|^capabilities$|^log$'. 27
 Error naming ConstantName Name 'versionKey' must match pattern '^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$|^capabilities$|^log$'. 28
 Error naming ConstantName Name 'version1' must match pattern '^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$|^capabilities$|^log$'. 29
 Error naming ConstantName Name 'V1Parameters' must match pattern '^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$|^capabilities$|^log$'. 30
 Error javadoc JavadocVariable Missing a Javadoc comment. 34
 Error coding DeclarationOrder Variable access definition in wrong order. 34
 Error javadoc JavadocVariable Missing a Javadoc comment. 35
 Error coding DeclarationOrder Variable access definition in wrong order. 35
 Error whitespace WhitespaceAround '+' is not followed by whitespace. 35

org/apache/logging/log4j/catalog/api/annotation/ConditionOnPropertyExists.java

Severity Category Rule Message Line
 Error javadoc JavadocPackage Missing package-info.java file.
 Error header Header Line does not match expected header line of ' * Licensed to the Apache Software Foundation (ASF) under one or more'. 2
 Error modifier RedundantModifier Redundant 'public' modifier. 36

org/apache/logging/log4j/catalog/api/annotation/JdbcUrl.java

Severity Category Rule Message Line
 Error header Header Line does not match expected header line of ' * Licensed to the Apache Software Foundation (ASF) under one or more'. 2
 Error modifier RedundantModifier Redundant 'public' modifier. 36

org/apache/logging/log4j/catalog/api/annotation/JdbcUrlCondition.java

Severity Category Rule Message Line
 Error header Header Line does not match expected header line of ' * Licensed to the Apache Software Foundation (ASF) under one or more'. 2

org/apache/logging/log4j/catalog/api/annotation/PropertyExistsCondition.java

Severity Category Rule Message Line
 Error header Header Line does not match expected header line of ' * Licensed to the Apache Software Foundation (ASF) under one or more'. 2
 Error sizes LineLength Line is longer than 120 characters (found 125). 31

org/apache/logging/log4j/catalog/api/constant/Constants.java

Severity Category Rule Message Line
 Error javadoc JavadocPackage Missing package-info.java file.
 Error javadoc JavadocVariable Missing a Javadoc comment. 27
 Error coding DeclarationOrder Static variable definition in wrong order. 27

org/apache/logging/log4j/catalog/api/dao/AbstractCatalogReader.java

Severity Category Rule Message Line
 Error header Header Line does not match expected header line of ' * Licensed to the Apache Software Foundation (ASF) under one or more'. 2
 Error javadoc JavadocType Missing a Javadoc comment. 28
 Error javadoc JavadocVariable Missing a Javadoc comment. 29
 Error javadoc JavadocVariable Missing a Javadoc comment. 31

org/apache/logging/log4j/catalog/api/dao/CatalogDao.java

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

org/apache/logging/log4j/catalog/api/dao/ClassPathCatalogReader.java

Severity Category Rule Message Line
 Error header Header Line does not match expected header line of ' * Licensed to the Apache Software Foundation (ASF) under one or more'. 2
 Error imports ImportOrder Wrong order for 'org.apache.logging.log4j.LogManager' import. 33
 Error coding MagicNumber '1024' is a magic number. 86
 Error coding DeclarationOrder Constructor definition in wrong order. 95

org/apache/logging/log4j/catalog/api/dao/FileCatalogReader.java

Severity Category Rule Message Line
 Error header Header Line does not match expected header line of ' * Licensed to the Apache Software Foundation (ASF) under one or more'. 2
 Error imports ImportOrder Wrong order for 'org.apache.logging.log4j.LogManager' import. 31
 Error whitespace WhitespaceAround '{' is not preceded with whitespace. 68

org/apache/logging/log4j/catalog/api/dao/JsonCatalogReader.java

Severity Category Rule Message Line
 Error imports ImportOrder Wrong order for 'org.apache.logging.log4j.LogManager' import. 25
 Error design VisibilityModifier Variable 'catalogReader' must be private and have accessor methods. 39

org/apache/logging/log4j/catalog/api/exception/ConstraintCreationException.java

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

org/apache/logging/log4j/catalog/api/package-info.java

Severity Category Rule Message Line
 Error misc NewlineAtEndOfFile File does not end with a newline.
 Error header Header Line does not match expected header line of ' * Licensed to the Apache Software Foundation (ASF) under one or more'. 2

org/apache/logging/log4j/catalog/api/plugins/CaseInsensitiveEnumConstraint.java

Severity Category Rule Message Line
 Error header Header Line does not match expected header line of ' * Licensed to the Apache Software Foundation (ASF) under one or more'. 2
 Error imports ImportOrder 'org.apache.logging.log4j.catalog.api.util.StringUtils.appendNewline' should be separated from previous imports. 22

org/apache/logging/log4j/catalog/api/plugins/ConstraintPlugins.java

Severity Category Rule Message Line
 Error header Header Line does not match expected header line of ' * Licensed to the Apache Software Foundation (ASF) under one or more'. 2
 Error design FinalClass Class ConstraintPlugins should be declared as final. 36
 Error naming StaticVariableName Name 'LOGGER' must match pattern '^[a-z][a-zA-Z0-9]*$'. 38
 Error whitespace WhitespaceAround 'synchronized' is not followed by whitespace. 48
 Error coding DeclarationOrder Constructor definition in wrong order. 57
 Error sizes LineLength Line is longer than 120 characters (found 129). 70

org/apache/logging/log4j/catalog/api/plugins/ConstraintTypeDeserializer.java

Severity Category Rule Message Line
 Error header Header Line does not match expected header line of ' * Licensed to the Apache Software Foundation (ASF) under one or more'. 2
 Error imports ImportOrder Wrong order for 'org.apache.logging.log4j.catalog.api.ConstraintType' import. 25
 Error design VisibilityModifier Variable 'plugins' must be private and have accessor methods. 33

org/apache/logging/log4j/catalog/api/plugins/ConstraintTypeSerializer.java

Severity Category Rule Message Line
 Error header Header Line does not match expected header line of ' * Licensed to the Apache Software Foundation (ASF) under one or more'. 2
 Error imports UnusedImports Unused import - com.fasterxml.jackson.core.JsonParser. 21
 Error imports UnusedImports Unused import - com.fasterxml.jackson.core.JsonProcessingException. 22
 Error imports UnusedImports Unused import - com.fasterxml.jackson.databind.DeserializationContext. 23
 Error imports UnusedImports Unused import - com.fasterxml.jackson.databind.JsonNode. 24
 Error imports UnusedImports Unused import - com.fasterxml.jackson.databind.deser.std.StdDeserializer. 26
 Error imports ImportOrder Wrong order for 'org.apache.logging.log4j.catalog.api.ConstraintType' import. 28
 Error imports UnusedImports Unused import - org.apache.logging.log4j.catalog.api.exception.NameNotFoundException. 29

org/apache/logging/log4j/catalog/api/plugins/EnumConstraint.java

Severity Category Rule Message Line
 Error header Header Line does not match expected header line of ' * Licensed to the Apache Software Foundation (ASF) under one or more'. 2
 Error imports ImportOrder 'org.apache.logging.log4j.catalog.api.util.StringUtils.appendNewline' should be separated from previous imports. 22

org/apache/logging/log4j/catalog/api/plugins/MaxLengthConstraint.java

Severity Category Rule Message Line
 Error header Header Line does not match expected header line of ' * Licensed to the Apache Software Foundation (ASF) under one or more'. 2
 Error imports ImportOrder 'org.apache.logging.log4j.catalog.api.util.StringUtils.isBlank' should be separated from previous imports. 20
 Error imports ImportOrder Wrong order for 'org.apache.logging.log4j.catalog.api.util.StringUtils.appendNewline' import. 21
 Error sizes LineLength Line is longer than 120 characters (found 138). 54

org/apache/logging/log4j/catalog/api/plugins/MaxValueConstraint.java

Severity Category Rule Message Line
 Error header Header Line does not match expected header line of ' * Licensed to the Apache Software Foundation (ASF) under one or more'. 2
 Error imports ImportOrder 'org.apache.logging.log4j.catalog.api.util.StringUtils.isBlank' should be separated from previous imports. 22
 Error imports ImportOrder Wrong order for 'org.apache.logging.log4j.catalog.api.util.StringUtils.appendNewline' import. 23
 Error sizes LineLength Line is longer than 120 characters (found 131). 57

org/apache/logging/log4j/catalog/api/plugins/MinLengthConstraint.java

Severity Category Rule Message Line
 Error header Header Line does not match expected header line of ' * Licensed to the Apache Software Foundation (ASF) under one or more'. 2
 Error imports ImportOrder 'org.apache.logging.log4j.catalog.api.util.StringUtils.isBlank' should be separated from previous imports. 20
 Error imports ImportOrder Wrong order for 'org.apache.logging.log4j.catalog.api.util.StringUtils.appendNewline' import. 21
 Error sizes LineLength Line is longer than 120 characters (found 138). 54

org/apache/logging/log4j/catalog/api/plugins/MinValueConstraint.java

Severity Category Rule Message Line
 Error header Header Line does not match expected header line of ' * Licensed to the Apache Software Foundation (ASF) under one or more'. 2
 Error imports ImportOrder 'org.apache.logging.log4j.catalog.api.util.StringUtils.isBlank' should be separated from previous imports. 22
 Error imports ImportOrder Wrong order for 'org.apache.logging.log4j.catalog.api.util.StringUtils.appendNewline' import. 23
 Error sizes LineLength Line is longer than 120 characters (found 131). 57

org/apache/logging/log4j/catalog/api/plugins/PatternConstraint.java

Severity Category Rule Message Line
 Error javadoc JavadocPackage Missing package-info.java file.
 Error header Header Line does not match expected header line of ' * Licensed to the Apache Software Foundation (ASF) under one or more'. 2
 Error imports ImportOrder 'org.apache.logging.log4j.catalog.api.util.StringUtils.*' should be separated from previous imports. 20

org/apache/logging/log4j/catalog/api/util/CatalogEventFilter.java

Severity Category Rule Message Line
 Error imports ImportOrder Wrong order for 'org.apache.logging.log4j.catalog.api.Event' import. 23
 Error javadoc JavadocType Missing a Javadoc comment. 27
 Error sizes LineLength Line is longer than 120 characters (found 136). 30
 Error whitespace WhitespaceAfter 'typecast' is not followed by whitespace. 31

org/apache/logging/log4j/catalog/api/util/ProfileUtil.java

Severity Category Rule Message Line
 Error imports ImportOrder Wrong order for 'java.io.IOException' import. 20
 Error javadoc JavadocMethod Expected @param tag for 'servletContext'. 38

org/apache/logging/log4j/catalog/api/util/StringUtils.java

Severity Category Rule Message Line
 Error javadoc JavadocPackage Missing package-info.java file.
 Error header Header Line does not match expected header line of ' * Licensed to the Apache Software Foundation (ASF) under one or more'. 2
 Error modifier RedundantModifier Redundant 'final' modifier. 26

Copyright © 2016-2018 Apache Software Foundation. All Rights Reserved.

Apache Logging, Apache Log4j, Log4j, Apache Log4j Audit, Log4j Audit, Apache, the Apache feather logo, and the Apache Logging project logo are trademarks of The Apache Software Foundation.

Site powered by Twitter Bootstrap. Icons from Glyphicons Free.