Apache Log4j™ 2
Manual
- Introduction
- Architecture
- Log4j 1.x Migration
- API
- Configuration
- Plugins
- Lookups
- Appenders
- Layouts
- Filters
- JMX
- Logging Separation
- Extending Log4j
Components
Core Documentation
Checkstyle Results
The following document contains the results of Checkstyle. 
Files
Details
org/apache/logging/log4j/core/Appender.java
| Violation | Message | Line |
|---|---|---|
 | Type Javadoc comment is missing an @param <T> tag. | 24 |
org/apache/logging/log4j/core/Filter.java
| Violation | Message | Line |
|---|---|---|
| Unused import - java.util.Locale. | 20 |
| Unused import - org.apache.logging.log4j.core.net.Protocol. | 24 |
| Line has trailing spaces. | 54 |
| Line has trailing spaces. | 57 |
| Line has trailing spaces. | 67 |
org/apache/logging/log4j/core/Layout.java
| Violation | Message | Line |
|---|---|---|
| Line has trailing spaces. | 22 |
| Line has trailing spaces. | 25 |
| Line is longer than 120 characters. | 26 |
| Line is longer than 120 characters. | 27 |
| Line is longer than 120 characters. | 28 |
org/apache/logging/log4j/core/LoggerContext.java
| Violation | Message | Line |
|---|---|---|
| Name 'logger' must match pattern '^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$|^capabilities$|^log$'. | 41 |
org/apache/logging/log4j/core/appender/AbstractAppender.java
| Violation | Message | Line |
|---|---|---|
| Line is longer than 120 characters. | 35 |
| Type Javadoc comment is missing an @param <T> tag. | 35 |
org/apache/logging/log4j/core/appender/AbstractManager.java
| Violation | Message | Line |
|---|---|---|
| Name 'map' must match pattern '^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$|^capabilities$|^log$'. | 39 |
| Name 'lock' must match pattern '^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$|^capabilities$|^log$'. | 41 |
| Expected @param tag for '<T>'. | 63 |
org/apache/logging/log4j/core/appender/FailoversPlugin.java
| Violation | Message | Line |
|---|---|---|
| Name 'logger' must match pattern '^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$|^capabilities$|^log$'. | 32 |
org/apache/logging/log4j/core/appender/FileManager.java
| Violation | Message | Line |
|---|---|---|
| Name 'factory' must match pattern '^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$|^capabilities$|^log$'. | 34 |
org/apache/logging/log4j/core/appender/OutputStreamManager.java
| Violation | Message | Line |
|---|---|---|
| Expected @param tag for '<T>'. | 45 |
org/apache/logging/log4j/core/appender/SocketAppender.java
| Violation | Message | Line |
|---|---|---|
| Unused import - java.util.Locale. | 19 |
| Unused import - org.apache.logging.log4j.core.net.Facility. | 30 |
org/apache/logging/log4j/core/appender/SyslogAppender.java
| Violation | Message | Line |
|---|---|---|
| More than 15 parameters. | 79 |
org/apache/logging/log4j/core/appender/rolling/PatternProcessor.java
| Violation | Message | Line |
|---|---|---|
| Expected @param tag for 'modulus'. | 79 |
org/apache/logging/log4j/core/appender/rolling/TimeBasedTriggeringPolicy.java
| Violation | Message | Line |
|---|---|---|
| Expected @param tag for 'interval'. | 77 |
| Expected @param tag for 'modulate'. | 78 |
org/apache/logging/log4j/core/config/AppenderRef.java
| Violation | Message | Line |
|---|---|---|
| Unused import - java.util.Locale. | 19 |
org/apache/logging/log4j/core/config/BaseConfiguration.java
| Violation | Message | Line |
|---|---|---|
| Method length is 222 lines (max allowed is 150). | 497 |
org/apache/logging/log4j/core/config/ConfigurationFactory.java
| Violation | Message | Line |
|---|---|---|
| Line has trailing spaces. | 56 |
| Missing a Javadoc comment. | 431 |
org/apache/logging/log4j/core/config/DefaultConfiguration.java
| Violation | Message | Line |
|---|---|---|
| Line is longer than 120 characters. | 26 |
| Line is longer than 120 characters. | 27 |
org/apache/logging/log4j/core/config/JSONConfiguration.java
| Violation | Message | Line |
|---|---|---|
| Unused import - java.util.Locale. | 45 |
org/apache/logging/log4j/core/config/LoggerConfig.java
| Violation | Message | Line |
|---|---|---|
| Unused import - java.util.Locale. | 44 |
| Expected @param tag for 'properties'. | 350 |
| Expected @param tag for 'properties'. | 373 |
| Expected @param tag for 'config'. | 374 |
org/apache/logging/log4j/core/config/XMLConfiguration.java
| Violation | Message | Line |
|---|---|---|
| Unused import - java.util.Locale. | 59 |
org/apache/logging/log4j/core/config/plugins/PluginManager.java
| Violation | Message | Line |
|---|---|---|
| Name 'packages' must match pattern '^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$|^capabilities$|^log$'. | 50 |
org/apache/logging/log4j/core/config/plugins/PluginType.java
| Violation | Message | Line |
|---|---|---|
| Type Javadoc comment is missing an @param <T> tag. | 25 |
| Line has trailing spaces. | 28 |
org/apache/logging/log4j/core/config/plugins/ResolverUtil.java
| Violation | Message | Line |
|---|---|---|
| 'cast' is not followed by whitespace. | 279 |
org/apache/logging/log4j/core/filter/BurstFilter.java
| Violation | Message | Line |
|---|---|---|
| Unused import - java.util.Locale. | 29 |
org/apache/logging/log4j/core/filter/CompositeFilter.java
| Violation | Message | Line |
|---|---|---|
| Line has trailing spaces. | 114 |
| Line has trailing spaces. | 123 |
| Line has trailing spaces. | 132 |
| Line has trailing spaces. | 158 |
| Line has trailing spaces. | 184 |
| Line has trailing spaces. | 210 |
| Line has trailing spaces. | 245 |
org/apache/logging/log4j/core/filter/DynamicThresholdFilter.java
| Violation | Message | Line |
|---|---|---|
| Unused import - java.util.Locale. | 32 |
org/apache/logging/log4j/core/filter/MapFilter.java
| Violation | Message | Line |
|---|---|---|
| Unused import - java.util.Locale. | 34 |
org/apache/logging/log4j/core/filter/MarkerFilter.java
| Violation | Message | Line |
|---|---|---|
| Unused import - java.util.Locale. | 19 |
org/apache/logging/log4j/core/filter/RegexFilter.java
| Violation | Message | Line |
|---|---|---|
| Unused import - java.util.Locale. | 28 |
org/apache/logging/log4j/core/filter/StructuredDataFilter.java
| Violation | Message | Line |
|---|---|---|
| Unused import - java.util.Locale. | 33 |
org/apache/logging/log4j/core/filter/ThreadContextMapFilter.java
| Violation | Message | Line |
|---|---|---|
| Unused import - java.util.Locale. | 35 |
org/apache/logging/log4j/core/filter/ThresholdFilter.java
| Violation | Message | Line |
|---|---|---|
| Unused import - java.util.Locale. | 19 |
org/apache/logging/log4j/core/filter/TimeFilter.java
| Violation | Message | Line |
|---|---|---|
| Unused import - java.util.Locale. | 27 |
org/apache/logging/log4j/core/helpers/FileUtils.java
| Violation | Message | Line |
|---|---|---|
| Name 'logger' must match pattern '^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$|^capabilities$|^log$'. | 39 |
org/apache/logging/log4j/core/impl/Log4jContextFactory.java
| Violation | Message | Line |
|---|---|---|
| Name 'logger' must match pattern '^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$|^capabilities$|^log$'. | 32 |
org/apache/logging/log4j/core/impl/Log4jLogEvent.java
| Violation | Message | Line |
|---|---|---|
| Expected @param tag for 'properties'. | 76 |
| 'cast' is not followed by whitespace. | 105 |
org/apache/logging/log4j/core/layout/HTMLLayout.java
| Violation | Message | Line |
|---|---|---|
| Missing a Javadoc comment. | 66 |
| Expected @param tag for 'fontSize'. | 294 |
| Expected @param tag for 'font'. | 295 |
org/apache/logging/log4j/core/layout/RFC5424Layout.java
| Violation | Message | Line |
|---|---|---|
| Unused import - org.apache.logging.log4j.util.EnglishEnums. | 31 |
| Unused import - java.util.Locale. | 43 |
org/apache/logging/log4j/core/layout/SyslogLayout.java
| Violation | Message | Line |
|---|---|---|
| Unused import - org.apache.logging.log4j.util.EnglishEnums. | 25 |
org/apache/logging/log4j/core/net/DatagramSocketManager.java
| Violation | Message | Line |
|---|---|---|
| Name 'factory' must match pattern '^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$|^capabilities$|^log$'. | 28 |
org/apache/logging/log4j/core/net/Facility.java
| Violation | Message | Line |
|---|---|---|
| Line has trailing spaces. | 104 |
| Line has trailing spaces. | 114 |
| Instance variable definition in wrong order. | 123 |
| Constructor definition in wrong order. | 125 |
org/apache/logging/log4j/core/net/JMSQueueManager.java
| Violation | Message | Line |
|---|---|---|
| Name 'factory' must match pattern '^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$|^capabilities$|^log$'. | 37 |
org/apache/logging/log4j/core/net/JMSTopicManager.java
| Violation | Message | Line |
|---|---|---|
| Name 'factory' must match pattern '^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$|^capabilities$|^log$'. | 37 |
org/apache/logging/log4j/core/net/SocketServer.java
| Violation | Message | Line |
|---|---|---|
 | Comment matches to-do format 'TODO:'. | 69 |
org/apache/logging/log4j/core/net/TCPSocketManager.java
| Violation | Message | Line |
|---|---|---|
| Name 'factory' must match pattern '^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$|^capabilities$|^log$'. | 43 |
org/apache/logging/log4j/core/pattern/AnsiEscape.java
| Violation | Message | Line |
|---|---|---|
| Line is longer than 120 characters. | 27 |
| Missing a Javadoc comment. | 33 |
| Missing a Javadoc comment. | 34 |
| Missing a Javadoc comment. | 35 |
| Missing a Javadoc comment. | 41 |
| Missing a Javadoc comment. | 42 |
| Missing a Javadoc comment. | 43 |
| Missing a Javadoc comment. | 44 |
| Missing a Javadoc comment. | 45 |
| Missing a Javadoc comment. | 46 |
| Missing a Javadoc comment. | 52 |
| Missing a Javadoc comment. | 53 |
| Missing a Javadoc comment. | 54 |
| Missing a Javadoc comment. | 55 |
| Missing a Javadoc comment. | 56 |
| Missing a Javadoc comment. | 57 |
| Missing a Javadoc comment. | 58 |
| Missing a Javadoc comment. | 59 |
| Missing a Javadoc comment. | 60 |
| Missing a Javadoc comment. | 61 |
| Missing a Javadoc comment. | 62 |
| Missing a Javadoc comment. | 63 |
| Missing a Javadoc comment. | 64 |
| Missing a Javadoc comment. | 65 |
| Missing a Javadoc comment. | 66 |
| Missing a Javadoc comment. | 67 |
| Missing a Javadoc comment. | 68 |
| Missing a Javadoc comment. | 74 |
| Missing a Javadoc comment. | 75 |
| Missing a Javadoc comment. | 76 |
| Missing a Javadoc comment. | 77 |
| Missing a Javadoc comment. | 78 |
| Missing a Javadoc comment. | 79 |
| Missing a Javadoc comment. | 80 |
| Line has trailing spaces. | 83 |
| Line has trailing spaces. | 104 |
| Line has trailing spaces. | 108 |
| Line has trailing spaces. | 110 |
| Line has trailing spaces. | 114 |
| Line is longer than 120 characters. | 115 |
| Line has trailing spaces. | 117 |
| Line has trailing spaces. | 130 |
| Line has trailing spaces. | 134 |
| Line has trailing spaces. | 136 |
| Line has trailing spaces. | 140 |
| Line is longer than 120 characters. | 141 |
| Line has trailing spaces. | 143 |
| Line has trailing spaces. | 168 |
org/apache/logging/log4j/core/pattern/CachedDateFormat.java
| Violation | Message | Line |
|---|---|---|
| Variable access definition in wrong order. | 42 |
| Variable access definition in wrong order. | 48 |
org/apache/logging/log4j/core/pattern/DatePatternConverter.java
| Violation | Message | Line |
|---|---|---|
| Line has trailing spaces. | 38 |
| Line has trailing spaces. | 43 |
| Line has trailing spaces. | 53 |
| Line has trailing spaces. | 63 |
| Line has trailing spaces. | 68 |
| Line has trailing spaces. | 73 |
| Line has trailing spaces. | 78 |
| Line has trailing spaces. | 83 |
| Line has trailing spaces. | 128 |
| Line has trailing spaces. | 143 |
org/apache/logging/log4j/core/pattern/ExtendedThrowablePatternConverter.java
| Violation | Message | Line |
|---|---|---|
| Line has trailing spaces. | 48 |
org/apache/logging/log4j/core/pattern/HighlightConverter.java
| Violation | Message | Line |
|---|---|---|
| Line has trailing spaces. | 36 |
| Line has trailing spaces. | 41 |
| Line has trailing spaces. | 44 |
| Line is longer than 120 characters. | 46 |
| Line has trailing spaces. | 49 |
| Line has trailing spaces. | 52 |
| Line has trailing spaces. | 63 |
| Line is longer than 120 characters. | 65 |
| '{' is followed by whitespace. | 87 |
| '{' is followed by whitespace. | 88 |
| '{' is followed by whitespace. | 89 |
| '{' is followed by whitespace. | 90 |
| '{' is followed by whitespace. | 91 |
| '{' is followed by whitespace. | 92 |
| '{' is followed by whitespace. | 94 |
| '{' is followed by whitespace. | 95 |
| '{' is followed by whitespace. | 96 |
| '{' is followed by whitespace. | 97 |
| Line is longer than 120 characters. | 106 |
| Line has trailing spaces. | 109 |
| Line has trailing spaces. | 113 |
| Line has trailing spaces. | 115 |
| Line has trailing spaces. | 119 |
| Line is longer than 120 characters. | 120 |
| Line has trailing spaces. | 122 |
| '{' is followed by whitespace. | 131 |
| Line is longer than 120 characters. | 139 |
| Line is longer than 120 characters. | 146 |
| Line has trailing spaces. | 157 |
| Line is longer than 120 characters. | 161 |
| Instance variable definition in wrong order. | 178 |
| Instance variable definition in wrong order. | 180 |
| Line has trailing spaces. | 184 |
| Constructor definition in wrong order. | 188 |
| Line is longer than 120 characters. | 205 |
org/apache/logging/log4j/core/pattern/LevelPatternConverter.java
| Violation | Message | Line |
|---|---|---|
| Unused import - java.util.Locale. | 24 |
org/apache/logging/log4j/core/pattern/LogEventPatternConverter.java
| Violation | Message | Line |
|---|---|---|
| Line has trailing spaces. | 28 |
| Line has trailing spaces. | 33 |
org/apache/logging/log4j/core/pattern/SequenceNumberPatternConverter.java
| Violation | Message | Line |
|---|---|---|
| Line has trailing spaces. | 31 |
| Name 'sequence' must match pattern '^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$|^capabilities$|^log$'. | 32 |
| Line has trailing spaces. | 33 |
org/apache/logging/log4j/core/selector/BasicContextSelector.java
| Violation | Message | Line |
|---|---|---|
| Name 'context' must match pattern '^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$|^capabilities$|^log$'. | 31 |
org/apache/logging/log4j/core/selector/ClassLoaderContextSelector.java
| Violation | Message | Line |
|---|---|---|
| Name 'context' must match pattern '^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$|^capabilities$|^log$'. | 49 |
| Name 'logger' must match pattern '^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$|^capabilities$|^log$'. | 55 |
| Name 'contextMap' must match pattern '^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$|^capabilities$|^log$'. | 57 |