Add checkstyle rule for java import statements

Related issue: logfellow#556
brenuart · Jul 7, 2021 · 6cc21ee · 6cc21ee
1 parent fa81678
commit 6cc21ee
Show file tree

Hide file tree

Showing 146 changed files with 329 additions and 361 deletions.
diff --git a/src/checkstyle/checkstyle.xml b/src/checkstyle/checkstyle.xml
@@ -36,7 +36,14 @@
         <module name="AvoidStarImport"/>
         <module name="IllegalImport"/> <!-- defaults to sun.* packages -->
         <module name="RedundantImport"/>
-
+        <module name="ImportOrder">
+            <property name="groups" value="java,javax,net.logstash"/>
+            <property name="ordered" value="true"/>
+            <property name="separated" value="true"/>
+            <property name="option" value="above"/>
+            <property name="sortStaticImportsAlphabetically" value="true"/>
+        </module>
+
         <!-- Checks for whitespace                             -->
         <!-- See https://checkstyle.org/config_whitespace.html -->
         <module name="EmptyForIteratorPad"/>

diff --git a/src/main/java/net/logstash/logback/LogstashAccessFormatter.java b/src/main/java/net/logstash/logback/LogstashAccessFormatter.java
@@ -15,9 +15,6 @@
 
 import java.util.Collections;
 
-import ch.qos.logback.access.spi.IAccessEvent;
-import ch.qos.logback.core.joran.spi.DefaultClass;
-import ch.qos.logback.core.spi.ContextAware;
 import net.logstash.logback.composite.ContextJsonProvider;
 import net.logstash.logback.composite.FieldNamesAware;
 import net.logstash.logback.composite.GlobalCustomFieldsJsonProvider;
@@ -44,6 +41,9 @@
 import net.logstash.logback.composite.accessevent.StatusCodeJsonProvider;
 import net.logstash.logback.fieldnames.LogstashAccessFieldNames;
 
+import ch.qos.logback.access.spi.IAccessEvent;
+import ch.qos.logback.core.joran.spi.DefaultClass;
+import ch.qos.logback.core.spi.ContextAware;
 import com.fasterxml.jackson.core.JsonProcessingException;
 import com.fasterxml.jackson.databind.JsonNode;
 import com.fasterxml.jackson.databind.ObjectMapper;

diff --git a/src/main/java/net/logstash/logback/LogstashFormatter.java b/src/main/java/net/logstash/logback/LogstashFormatter.java
@@ -38,13 +38,11 @@
 import net.logstash.logback.composite.loggingevent.ThreadNameJsonProvider;
 import net.logstash.logback.fieldnames.LogstashFieldNames;
 
-import org.slf4j.MDC;
-
 import ch.qos.logback.classic.pattern.ThrowableHandlingConverter;
 import ch.qos.logback.classic.spi.ILoggingEvent;
 import ch.qos.logback.core.spi.ContextAware;
-
 import com.fasterxml.jackson.databind.JsonNode;
+import org.slf4j.MDC;
 
 /**
  * A {@link LoggingEventCompositeJsonFormatter} that contains a common

diff --git a/src/main/java/net/logstash/logback/appender/AbstractLogstashTcpSocketAppender.java b/src/main/java/net/logstash/logback/appender/AbstractLogstashTcpSocketAppender.java
@@ -50,10 +50,6 @@
 import net.logstash.logback.encoder.SeparatorParser;
 import net.logstash.logback.encoder.StreamingEncoder;
 
-import com.lmax.disruptor.EventHandler;
-import com.lmax.disruptor.LifecycleAware;
-import com.lmax.disruptor.RingBuffer;
-
 import ch.qos.logback.core.encoder.Encoder;
 import ch.qos.logback.core.joran.spi.DefaultClass;
 import ch.qos.logback.core.net.ssl.ConfigurableSSLSocketFactory;
@@ -63,6 +59,9 @@
 import ch.qos.logback.core.spi.DeferredProcessingAware;
 import ch.qos.logback.core.util.CloseUtil;
 import ch.qos.logback.core.util.Duration;
+import com.lmax.disruptor.EventHandler;
+import com.lmax.disruptor.LifecycleAware;
+import com.lmax.disruptor.RingBuffer;
 
 /**
  * An {@link AsyncDisruptorAppender} appender that writes

diff --git a/src/main/java/net/logstash/logback/appender/AbstractLogstashUdpSocketAppender.java b/src/main/java/net/logstash/logback/appender/AbstractLogstashUdpSocketAppender.java
@@ -20,11 +20,12 @@
 import java.util.List;
 import java.util.Objects;
 
+import net.logstash.logback.appender.listener.AppenderListener;
+
 import ch.qos.logback.core.Layout;
 import ch.qos.logback.core.net.SyslogAppenderBase;
 import ch.qos.logback.core.net.SyslogOutputStream;
 import ch.qos.logback.core.spi.DeferredProcessingAware;
-import net.logstash.logback.appender.listener.AppenderListener;
 
 /**
  * An appender that sends events over UDP using a custom {@link Layout}.

diff --git a/src/main/java/net/logstash/logback/appender/AccessEventAsyncDisruptorAppender.java b/src/main/java/net/logstash/logback/appender/AccessEventAsyncDisruptorAppender.java
@@ -14,6 +14,7 @@
 package net.logstash.logback.appender;
 
 import net.logstash.logback.appender.listener.AppenderListener;
+
 import ch.qos.logback.access.spi.IAccessEvent;
 
 /**

diff --git a/src/main/java/net/logstash/logback/appender/AsyncDisruptorAppender.java b/src/main/java/net/logstash/logback/appender/AsyncDisruptorAppender.java
@@ -25,16 +25,16 @@
 import java.util.concurrent.atomic.AtomicInteger;
 import java.util.concurrent.atomic.AtomicLong;
 
-import ch.qos.logback.core.status.OnConsoleStatusListener;
-import ch.qos.logback.core.status.Status;
 import net.logstash.logback.appender.listener.AppenderListener;
+import net.logstash.logback.status.LevelFilteringStatusListener;
+
 import ch.qos.logback.access.spi.IAccessEvent;
 import ch.qos.logback.classic.AsyncAppender;
 import ch.qos.logback.classic.spi.ILoggingEvent;
 import ch.qos.logback.core.UnsynchronizedAppenderBase;
 import ch.qos.logback.core.spi.DeferredProcessingAware;
-import net.logstash.logback.status.LevelFilteringStatusListener;
-
+import ch.qos.logback.core.status.OnConsoleStatusListener;
+import ch.qos.logback.core.status.Status;
 import com.lmax.disruptor.BlockingWaitStrategy;
 import com.lmax.disruptor.EventFactory;
 import com.lmax.disruptor.EventHandler;

diff --git a/src/main/java/net/logstash/logback/appender/DelegatingAsyncDisruptorAppender.java b/src/main/java/net/logstash/logback/appender/DelegatingAsyncDisruptorAppender.java
@@ -19,8 +19,7 @@
 import java.util.Iterator;
 import java.util.concurrent.BlockingQueue;
 
-import com.lmax.disruptor.EventHandler;
-import com.lmax.disruptor.RingBuffer;
+import net.logstash.logback.appender.listener.AppenderListener;
 
 import ch.qos.logback.access.spi.IAccessEvent;
 import ch.qos.logback.classic.spi.ILoggingEvent;
@@ -30,7 +29,8 @@
 import ch.qos.logback.core.spi.AppenderAttachable;
 import ch.qos.logback.core.spi.AppenderAttachableImpl;
 import ch.qos.logback.core.spi.DeferredProcessingAware;
-import net.logstash.logback.appender.listener.AppenderListener;
+import com.lmax.disruptor.EventHandler;
+import com.lmax.disruptor.RingBuffer;
 
 /**
  * An {@link AsyncDisruptorAppender} that delegates appending of an event

diff --git a/src/main/java/net/logstash/logback/appender/LoggingEventAsyncDisruptorAppender.java b/src/main/java/net/logstash/logback/appender/LoggingEventAsyncDisruptorAppender.java
@@ -14,8 +14,8 @@
 package net.logstash.logback.appender;
 
 import net.logstash.logback.appender.listener.AppenderListener;
-import ch.qos.logback.classic.spi.ILoggingEvent;
 
+import ch.qos.logback.classic.spi.ILoggingEvent;
 import com.lmax.disruptor.RingBuffer;
 
 /**

diff --git a/src/main/java/net/logstash/logback/appender/LogstashAccessTcpSocketAppender.java b/src/main/java/net/logstash/logback/appender/LogstashAccessTcpSocketAppender.java
@@ -14,6 +14,7 @@
 package net.logstash.logback.appender;
 
 import net.logstash.logback.appender.listener.TcpAppenderListener;
+
 import ch.qos.logback.access.spi.IAccessEvent;
 
 /**

diff --git a/src/main/java/net/logstash/logback/appender/LogstashTcpSocketAppender.java b/src/main/java/net/logstash/logback/appender/LogstashTcpSocketAppender.java
@@ -14,8 +14,8 @@
 package net.logstash.logback.appender;
 
 import net.logstash.logback.appender.listener.TcpAppenderListener;
-import ch.qos.logback.classic.spi.ILoggingEvent;
 
+import ch.qos.logback.classic.spi.ILoggingEvent;
 import com.lmax.disruptor.RingBuffer;
 
 /**

diff --git a/...in/java/net/logstash/logback/appender/listener/FailureSummaryLoggingAppenderListener.java b/...in/java/net/logstash/logback/appender/listener/FailureSummaryLoggingAppenderListener.java
@@ -19,8 +19,9 @@
 import java.util.Objects;
 import java.util.TimeZone;
 
-import ch.qos.logback.core.spi.DeferredProcessingAware;
 import net.logstash.logback.argument.StructuredArguments;
+
+import ch.qos.logback.core.spi.DeferredProcessingAware;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 

diff --git a/src/main/java/net/logstash/logback/argument/DeferredStructuredArgument.java b/src/main/java/net/logstash/logback/argument/DeferredStructuredArgument.java
@@ -17,11 +17,11 @@
 import java.util.Objects;
 import java.util.function.Supplier;
 
-import ch.qos.logback.classic.spi.LoggingEvent;
 import net.logstash.logback.marker.EmptyLogstashMarker;
-import org.slf4j.Logger;
 
+import ch.qos.logback.classic.spi.LoggingEvent;
 import com.fasterxml.jackson.core.JsonGenerator;
+import org.slf4j.Logger;
 
 /**
  * A {@link StructuredArgument} that defers the creation of another {@link StructuredArgument} until

diff --git a/src/main/java/net/logstash/logback/argument/StructuredArgument.java b/src/main/java/net/logstash/logback/argument/StructuredArgument.java
@@ -15,11 +15,10 @@
 
 import java.io.IOException;
 
-import org.slf4j.Logger;
-
 import net.logstash.logback.composite.loggingevent.ArgumentsJsonProvider;
 
 import com.fasterxml.jackson.core.JsonGenerator;
+import org.slf4j.Logger;
 
 /**
  * A wrapper for an argument passed to a log method (e.g. {@link Logger#info(String, Object...)})

diff --git a/src/main/java/net/logstash/logback/argument/StructuredArguments.java b/src/main/java/net/logstash/logback/argument/StructuredArguments.java
@@ -17,13 +17,14 @@
 import java.util.Map;
 import java.util.function.Supplier;
 
-import ch.qos.logback.core.Context;
-import ch.qos.logback.core.status.StatusManager;
-import ch.qos.logback.core.status.WarnStatus;
 import net.logstash.logback.marker.MapEntriesAppendingMarker;
 import net.logstash.logback.marker.ObjectAppendingMarker;
 import net.logstash.logback.marker.ObjectFieldsAppendingMarker;
 import net.logstash.logback.marker.RawJsonAppendingMarker;
+
+import ch.qos.logback.core.Context;
+import ch.qos.logback.core.status.StatusManager;
+import ch.qos.logback.core.status.WarnStatus;
 import org.slf4j.ILoggerFactory;
 import org.slf4j.LoggerFactory;
 

diff --git a/src/main/java/net/logstash/logback/composite/AbstractNestedJsonProvider.java b/src/main/java/net/logstash/logback/composite/AbstractNestedJsonProvider.java
@@ -15,12 +15,11 @@
 
 import java.io.IOException;
 
-import com.fasterxml.jackson.core.JsonFactory;
-import com.fasterxml.jackson.core.JsonGenerator;
-
 import ch.qos.logback.access.spi.IAccessEvent;
 import ch.qos.logback.classic.spi.ILoggingEvent;
 import ch.qos.logback.core.spi.DeferredProcessingAware;
+import com.fasterxml.jackson.core.JsonFactory;
+import com.fasterxml.jackson.core.JsonGenerator;
 
 /**
  * A {@link JsonProvider} that nests other providers within a subobject.

diff --git a/src/main/java/net/logstash/logback/composite/AbstractPatternJsonProvider.java b/src/main/java/net/logstash/logback/composite/AbstractPatternJsonProvider.java
@@ -17,10 +17,10 @@
 
 import net.logstash.logback.pattern.AbstractJsonPatternParser;
 import net.logstash.logback.pattern.NodeWriter;
+
 import ch.qos.logback.access.spi.IAccessEvent;
 import ch.qos.logback.classic.spi.ILoggingEvent;
 import ch.qos.logback.core.spi.DeferredProcessingAware;
-
 import com.fasterxml.jackson.core.JsonFactory;
 import com.fasterxml.jackson.core.JsonGenerator;
 

diff --git a/src/main/java/net/logstash/logback/composite/CompositeJsonFormatter.java b/src/main/java/net/logstash/logback/composite/CompositeJsonFormatter.java
@@ -23,18 +23,17 @@
 import net.logstash.logback.decorate.NullJsonFactoryDecorator;
 import net.logstash.logback.decorate.NullJsonGeneratorDecorator;
 
-import com.fasterxml.jackson.core.JsonEncoding;
-import com.fasterxml.jackson.core.JsonFactory;
-import com.fasterxml.jackson.core.JsonGenerator;
-import com.fasterxml.jackson.databind.ObjectMapper;
-import com.fasterxml.jackson.databind.SerializationFeature;
-
 import ch.qos.logback.access.spi.IAccessEvent;
 import ch.qos.logback.classic.spi.ILoggingEvent;
 import ch.qos.logback.core.spi.ContextAware;
 import ch.qos.logback.core.spi.ContextAwareBase;
 import ch.qos.logback.core.spi.DeferredProcessingAware;
 import ch.qos.logback.core.spi.LifeCycle;
+import com.fasterxml.jackson.core.JsonEncoding;
+import com.fasterxml.jackson.core.JsonFactory;
+import com.fasterxml.jackson.core.JsonGenerator;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.SerializationFeature;
 
 /**
  * Formats logstash Events as JSON using {@link JsonProvider}s.

diff --git a/src/main/java/net/logstash/logback/composite/ContextJsonProvider.java b/src/main/java/net/logstash/logback/composite/ContextJsonProvider.java
@@ -17,11 +17,11 @@
 
 import net.logstash.logback.fieldnames.LogstashCommonFieldNames;
 import net.logstash.logback.fieldnames.LogstashFieldNames;
+
 import ch.qos.logback.access.spi.IAccessEvent;
 import ch.qos.logback.classic.spi.ILoggingEvent;
 import ch.qos.logback.core.Context;
 import ch.qos.logback.core.spi.DeferredProcessingAware;
-
 import com.fasterxml.jackson.core.JsonGenerator;
 
 /**

diff --git a/src/main/java/net/logstash/logback/composite/FormattedTimestampJsonProvider.java b/src/main/java/net/logstash/logback/composite/FormattedTimestampJsonProvider.java
@@ -20,9 +20,9 @@
 import java.time.format.DateTimeFormatter;
 import java.util.TimeZone;
 
-import ch.qos.logback.core.spi.DeferredProcessingAware;
 import net.logstash.logback.fieldnames.LogstashCommonFieldNames;
 
+import ch.qos.logback.core.spi.DeferredProcessingAware;
 import com.fasterxml.jackson.core.JsonGenerator;
 
 /**

diff --git a/src/main/java/net/logstash/logback/composite/GlobalCustomFieldsJsonProvider.java b/src/main/java/net/logstash/logback/composite/GlobalCustomFieldsJsonProvider.java
@@ -18,7 +18,6 @@
 import java.util.Map.Entry;
 
 import ch.qos.logback.core.spi.DeferredProcessingAware;
-
 import com.fasterxml.jackson.core.JsonFactory;
 import com.fasterxml.jackson.core.JsonGenerator;
 import com.fasterxml.jackson.databind.JsonNode;

diff --git a/src/main/java/net/logstash/logback/composite/JsonProvider.java b/src/main/java/net/logstash/logback/composite/JsonProvider.java
@@ -20,7 +20,6 @@
 import ch.qos.logback.core.spi.ContextAware;
 import ch.qos.logback.core.spi.DeferredProcessingAware;
 import ch.qos.logback.core.spi.LifeCycle;
-
 import com.fasterxml.jackson.core.JsonGenerator;
 
 /**

diff --git a/src/main/java/net/logstash/logback/composite/JsonProviders.java b/src/main/java/net/logstash/logback/composite/JsonProviders.java
@@ -22,7 +22,6 @@
 import ch.qos.logback.classic.spi.ILoggingEvent;
 import ch.qos.logback.core.Context;
 import ch.qos.logback.core.spi.DeferredProcessingAware;
-
 import com.fasterxml.jackson.core.JsonFactory;
 import com.fasterxml.jackson.core.JsonGenerator;
 

diff --git a/src/main/java/net/logstash/logback/composite/LogstashVersionJsonProvider.java b/src/main/java/net/logstash/logback/composite/LogstashVersionJsonProvider.java
@@ -17,11 +17,10 @@
 
 import net.logstash.logback.fieldnames.LogstashCommonFieldNames;
 
-import com.fasterxml.jackson.core.JsonGenerator;
-
 import ch.qos.logback.access.spi.IAccessEvent;
 import ch.qos.logback.classic.spi.ILoggingEvent;
 import ch.qos.logback.core.spi.DeferredProcessingAware;
+import com.fasterxml.jackson.core.JsonGenerator;
 
 /**
  * Writes a version field as a string value (by default) or a numeric value (if {@link #isWriteAsInteger()} is true).

diff --git a/...in/java/net/logstash/logback/composite/accessevent/AccessEventCompositeJsonFormatter.java b/...in/java/net/logstash/logback/composite/accessevent/AccessEventCompositeJsonFormatter.java
@@ -15,6 +15,7 @@
 
 import net.logstash.logback.composite.CompositeJsonFormatter;
 import net.logstash.logback.composite.JsonProviders;
+
 import ch.qos.logback.access.spi.IAccessEvent;
 import ch.qos.logback.core.joran.spi.DefaultClass;
 import ch.qos.logback.core.spi.ContextAware;

diff --git a/...net/logstash/logback/composite/accessevent/AccessEventFormattedTimestampJsonProvider.java b/...net/logstash/logback/composite/accessevent/AccessEventFormattedTimestampJsonProvider.java
@@ -15,6 +15,7 @@
 
 import net.logstash.logback.composite.FormattedTimestampJsonProvider;
 import net.logstash.logback.fieldnames.LogstashAccessFieldNames;
+
 import ch.qos.logback.access.spi.IAccessEvent;
 
 public class AccessEventFormattedTimestampJsonProvider extends FormattedTimestampJsonProvider<IAccessEvent, LogstashAccessFieldNames> {

diff --git a/src/main/java/net/logstash/logback/composite/accessevent/AccessEventJsonProviders.java b/src/main/java/net/logstash/logback/composite/accessevent/AccessEventJsonProviders.java
@@ -17,6 +17,7 @@
 import net.logstash.logback.composite.GlobalCustomFieldsJsonProvider;
 import net.logstash.logback.composite.JsonProviders;
 import net.logstash.logback.composite.LogstashVersionJsonProvider;
+
 import ch.qos.logback.access.spi.IAccessEvent;
 
 /**

diff --git a/src/main/java/net/logstash/logback/composite/accessevent/AccessEventNestedJsonProvider.java b/src/main/java/net/logstash/logback/composite/accessevent/AccessEventNestedJsonProvider.java
@@ -15,6 +15,7 @@
 
 import net.logstash.logback.composite.AbstractNestedJsonProvider;
 import net.logstash.logback.composite.JsonProviders;
+
 import ch.qos.logback.access.spi.IAccessEvent;
 import ch.qos.logback.core.joran.spi.DefaultClass;
 

diff --git a/src/main/java/net/logstash/logback/composite/accessevent/AccessEventPatternJsonProvider.java b/src/main/java/net/logstash/logback/composite/accessevent/AccessEventPatternJsonProvider.java
@@ -16,6 +16,7 @@
 import net.logstash.logback.composite.AbstractPatternJsonProvider;
 import net.logstash.logback.pattern.AbstractJsonPatternParser;
 import net.logstash.logback.pattern.AccessEventJsonPatternParser;
+
 import ch.qos.logback.access.spi.IAccessEvent;
 
 /**

diff --git a/src/main/java/net/logstash/logback/composite/accessevent/AccessMessageJsonProvider.java b/src/main/java/net/logstash/logback/composite/accessevent/AccessMessageJsonProvider.java
@@ -18,8 +18,8 @@
 import net.logstash.logback.composite.JsonWritingUtils;
 import net.logstash.logback.composite.loggingevent.MessageJsonProvider;
 import net.logstash.logback.fieldnames.LogstashAccessFieldNames;
-import ch.qos.logback.access.spi.IAccessEvent;
 
+import ch.qos.logback.access.spi.IAccessEvent;
 import com.fasterxml.jackson.core.JsonGenerator;
 
 public class AccessMessageJsonProvider extends AccessEventFormattedTimestampJsonProvider {

diff --git a/src/main/java/net/logstash/logback/composite/accessevent/ContentLengthJsonProvider.java b/src/main/java/net/logstash/logback/composite/accessevent/ContentLengthJsonProvider.java
@@ -15,14 +15,14 @@
 
 import java.io.IOException;
 
-import com.fasterxml.jackson.core.JsonGenerator;
-
-import ch.qos.logback.access.spi.IAccessEvent;
 import net.logstash.logback.composite.AbstractFieldJsonProvider;
 import net.logstash.logback.composite.FieldNamesAware;
 import net.logstash.logback.composite.JsonWritingUtils;
 import net.logstash.logback.fieldnames.LogstashAccessFieldNames;
 
+import ch.qos.logback.access.spi.IAccessEvent;
+import com.fasterxml.jackson.core.JsonGenerator;
+
 public class ContentLengthJsonProvider extends AbstractFieldJsonProvider<IAccessEvent> implements FieldNamesAware<LogstashAccessFieldNames> {
 
     public static final String FIELD_CONTENT_LENGTH = "content_length";