From 73fb82bbbbf1522222b7f1cb24a820c974bfb0dc Mon Sep 17 00:00:00 2001
From: Philip Whitehouse <philip@whiuk.com>
Date: Thu, 23 Apr 2020 17:09:25 +0100
Subject: [PATCH 1/4] Optimise session reset to reduce Calendar creation

---
 .../main/java/quickfix/CachedFileStore.java   |   8 ++
 .../java/quickfix/DefaultSessionSchedule.java |  24 +++-
 .../src/main/java/quickfix/FileStore.java     |   8 ++
 .../src/main/java/quickfix/JdbcStore.java     |   4 +
 .../src/main/java/quickfix/MemoryStore.java   |   4 +
 .../src/main/java/quickfix/MessageStore.java  |   9 ++
 .../src/main/java/quickfix/NoopStore.java     |   6 +
 .../src/main/java/quickfix/Session.java       |   2 +-
 .../src/main/java/quickfix/SessionState.java  |   9 +-
 .../main/java/quickfix/SleepycatStore.java    |  13 ++
 .../quickfix/DefaultSessionScheduleTest.java  | 120 ++++++++++++++++++
 .../src/test/java/quickfix/LogUtilTest.java   |   3 +-
 12 files changed, 199 insertions(+), 11 deletions(-)
 create mode 100644 quickfixj-core/src/test/java/quickfix/DefaultSessionScheduleTest.java

diff --git a/quickfixj-core/src/main/java/quickfix/CachedFileStore.java b/quickfixj-core/src/main/java/quickfix/CachedFileStore.java
index 7a05793915..37941ba97f 100644
--- a/quickfixj-core/src/main/java/quickfix/CachedFileStore.java
+++ b/quickfixj-core/src/main/java/quickfix/CachedFileStore.java
@@ -163,6 +163,14 @@ public Date getCreationTime() throws IOException {
         return cache.getCreationTime();
     }
 
+    /*
+     * (non-Javadoc)
+     * @see quickfix.MessageStore#getCreationTimeCalendar()
+     */
+    public Calendar getCreationTimeCalendar() throws IOException {
+        return cache.getCreationTimeCalendar();
+    }
+
     private void initializeSequenceNumbers() throws IOException {
         sequenceNumberFile.seek(0);
         if (sequenceNumberFile.length() > 0) {
diff --git a/quickfixj-core/src/main/java/quickfix/DefaultSessionSchedule.java b/quickfixj-core/src/main/java/quickfix/DefaultSessionSchedule.java
index 83d8bb5eab..184095f87f 100644
--- a/quickfixj-core/src/main/java/quickfix/DefaultSessionSchedule.java
+++ b/quickfixj-core/src/main/java/quickfix/DefaultSessionSchedule.java
@@ -41,10 +41,17 @@ public class DefaultSessionSchedule implements SessionSchedule {
     private final int[] weekdayOffsets;
     protected static final Logger LOG = LoggerFactory.getLogger(DefaultSessionSchedule.class);
 
+    //Cache recent time data to reduce creation of calendar objects
+    private ThreadLocal<Calendar> threadLocalCalendar;
+    private ThreadLocal<TimeInterval> threadLocalRecentTimeInterval;
+
     public DefaultSessionSchedule(SessionSettings settings, SessionID sessionID) throws ConfigError,
             FieldConvertError {
+        threadLocalCalendar = ThreadLocal.withInitial(SystemTime::getUtcCalendar);
+        threadLocalRecentTimeInterval = new ThreadLocal<>();
+        isNonStopSession = settings.isSetting(sessionID, Session.SETTING_NON_STOP_SESSION)
+            && settings.getBool(sessionID, Session.SETTING_NON_STOP_SESSION);
 
-        isNonStopSession = settings.isSetting(sessionID, Session.SETTING_NON_STOP_SESSION) && settings.getBool(sessionID, Session.SETTING_NON_STOP_SESSION);
         TimeZone defaultTimeZone = getDefaultTimeZone(settings, sessionID);
         if (isNonStopSession) {
             isWeekdaySession = false;
@@ -104,7 +111,7 @@ private TimeEndPoint getTimeEndPoint(SessionSettings settings, SessionID session
     }
 
     private TimeZone getDefaultTimeZone(SessionSettings settings, SessionID sessionID)
-            throws ConfigError, FieldConvertError {
+            throws ConfigError {
         TimeZone sessionTimeZone;
         if (settings.isSetting(sessionID, Session.SETTING_TIMEZONE)) {
             String sessionTimeZoneID = settings.getString(sessionID, Session.SETTING_TIMEZONE);
@@ -300,9 +307,16 @@ public boolean isSessionTime() {
         if(isNonStopSession()) {
             return true;
         }
-        Calendar now = SystemTime.getUtcCalendar();
-        TimeInterval interval = theMostRecentIntervalBefore(now);
-        return interval.isContainingTime(now);
+        Calendar now = threadLocalCalendar.get();
+        now.setTimeInMillis(SystemTime.currentTimeMillis());
+        TimeInterval mostRecentInterval = threadLocalRecentTimeInterval.get();
+        if (mostRecentInterval != null && mostRecentInterval.isContainingTime(now)) {
+            return true;
+        }
+        mostRecentInterval = theMostRecentIntervalBefore(now);
+        boolean result = mostRecentInterval.isContainingTime(now);
+        threadLocalRecentTimeInterval.set(mostRecentInterval);
+        return result;
     }
 
     public String toString() {
diff --git a/quickfixj-core/src/main/java/quickfix/FileStore.java b/quickfixj-core/src/main/java/quickfix/FileStore.java
index 20ec17f585..f9e3068a48 100644
--- a/quickfixj-core/src/main/java/quickfix/FileStore.java
+++ b/quickfixj-core/src/main/java/quickfix/FileStore.java
@@ -153,6 +153,14 @@ public Date getCreationTime() throws IOException {
         return cache.getCreationTime();
     }
 
+    /* (non-Javadoc)
+     * @see quickfix.MessageStore#getCreationTimeCalendar()
+     */
+    @Override
+    public Calendar getCreationTimeCalendar() throws IOException {
+        return cache.getCreationTimeCalendar();
+    }
+
     private void initializeSequenceNumbers() throws IOException {
         senderSequenceNumberFile.seek(0);
         if (senderSequenceNumberFile.length() > 0) {
diff --git a/quickfixj-core/src/main/java/quickfix/JdbcStore.java b/quickfixj-core/src/main/java/quickfix/JdbcStore.java
index 1874d0953b..235784e635 100644
--- a/quickfixj-core/src/main/java/quickfix/JdbcStore.java
+++ b/quickfixj-core/src/main/java/quickfix/JdbcStore.java
@@ -155,6 +155,10 @@ public Date getCreationTime() throws IOException {
         return cache.getCreationTime();
     }
 
+    public Calendar getCreationTimeCalendar() throws IOException {
+        return cache.getCreationTimeCalendar();
+    }
+
     public int getNextSenderMsgSeqNum() throws IOException {
         return cache.getNextSenderMsgSeqNum();
     }
diff --git a/quickfixj-core/src/main/java/quickfix/MemoryStore.java b/quickfixj-core/src/main/java/quickfix/MemoryStore.java
index f102056516..f3cb430ad4 100644
--- a/quickfixj-core/src/main/java/quickfix/MemoryStore.java
+++ b/quickfixj-core/src/main/java/quickfix/MemoryStore.java
@@ -70,6 +70,10 @@ public Date getCreationTime() throws IOException {
         return creationTime.getTime();
     }
 
+    public Calendar getCreationTimeCalendar() throws IOException {
+        return creationTime;
+    }
+
     /* package */void setCreationTime(Calendar creationTime) {
         this.creationTime = creationTime;
     }
diff --git a/quickfixj-core/src/main/java/quickfix/MessageStore.java b/quickfixj-core/src/main/java/quickfix/MessageStore.java
index 8ff35aa3c9..aaa61ed43a 100644
--- a/quickfixj-core/src/main/java/quickfix/MessageStore.java
+++ b/quickfixj-core/src/main/java/quickfix/MessageStore.java
@@ -19,6 +19,7 @@
 
 package quickfix;
 
+import java.util.Calendar;
 import java.util.Collection;
 import java.util.Date;
 import java.io.IOException;
@@ -73,6 +74,14 @@ public interface MessageStore {
      */
     Date getCreationTime() throws IOException;
 
+    /**
+     * Get the session creation time as a calendar object.
+     *
+     * @return the session creation time.
+     * @throws IOException IO error
+     */
+    Calendar getCreationTimeCalendar() throws IOException;
+
     /**
      * Reset the message store. Sequence numbers are set back to 1 and stored
      * messages are erased. The session creation time is also set to the time of
diff --git a/quickfixj-core/src/main/java/quickfix/NoopStore.java b/quickfixj-core/src/main/java/quickfix/NoopStore.java
index ddc33b54ca..8bdc4cc354 100644
--- a/quickfixj-core/src/main/java/quickfix/NoopStore.java
+++ b/quickfixj-core/src/main/java/quickfix/NoopStore.java
@@ -20,6 +20,7 @@
 
 package quickfix;
 
+import java.util.Calendar;
 import java.util.Collection;
 import java.util.Date;
 
@@ -31,6 +32,7 @@
 public class NoopStore implements MessageStore {
 
     private Date creationTime = new Date();
+    private Calendar creationTimeCalendar = SystemTime.getUtcCalendar(creationTime);
     private int nextSenderMsgSeqNum = 1;
     private int nextTargetMsgSeqNum = 1;
 
@@ -41,6 +43,10 @@ public Date getCreationTime() {
         return creationTime;
     }
 
+    public Calendar getCreationTimeCalendar() {
+        return creationTimeCalendar;
+    }
+
     public int getNextSenderMsgSeqNum() {
         return nextSenderMsgSeqNum;
     }
diff --git a/quickfixj-core/src/main/java/quickfix/Session.java b/quickfixj-core/src/main/java/quickfix/Session.java
index 897cc9bdf5..8fa06c3379 100644
--- a/quickfixj-core/src/main/java/quickfix/Session.java
+++ b/quickfixj-core/src/main/java/quickfix/Session.java
@@ -584,7 +584,7 @@ public String getRemoteAddress() {
     private boolean isCurrentSession(final long time)
             throws IOException {
         return sessionSchedule == null || sessionSchedule.isSameSession(
-                SystemTime.getUtcCalendar(time), SystemTime.getUtcCalendar(state.getCreationTime()));
+                SystemTime.getUtcCalendar(time), state.getCreationTimeCalendar());
     }
 
     /**
diff --git a/quickfixj-core/src/main/java/quickfix/SessionState.java b/quickfixj-core/src/main/java/quickfix/SessionState.java
index ef666c8520..653021d71c 100644
--- a/quickfixj-core/src/main/java/quickfix/SessionState.java
+++ b/quickfixj-core/src/main/java/quickfix/SessionState.java
@@ -20,10 +20,7 @@
 package quickfix;
 
 import java.io.IOException;
-import java.util.Collection;
-import java.util.Date;
-import java.util.LinkedHashMap;
-import java.util.Map;
+import java.util.*;
 import java.util.concurrent.atomic.AtomicInteger;
 import java.util.concurrent.locks.Lock;
 import java.util.concurrent.locks.ReentrantLock;
@@ -502,6 +499,10 @@ public Object getLock() {
         return lock;
     }
 
+    public Calendar getCreationTimeCalendar() throws IOException {
+        return messageStore.getCreationTimeCalendar();
+    }
+
     private final static class NullLog implements Log {
         public void onOutgoing(String message) {
         }
diff --git a/quickfixj-core/src/main/java/quickfix/SleepycatStore.java b/quickfixj-core/src/main/java/quickfix/SleepycatStore.java
index e9e7aae1c2..3fddd79f54 100644
--- a/quickfixj-core/src/main/java/quickfix/SleepycatStore.java
+++ b/quickfixj-core/src/main/java/quickfix/SleepycatStore.java
@@ -256,10 +256,23 @@ private void convertToIOExceptionAndRethrow(Exception e) throws IOException {
         throw ioe;
     }
 
+
+    /*
+     * (non-Javadoc)
+     * @see quickfix.MessageStore#getCreationTime()
+     */
     public Date getCreationTime() throws IOException {
         return info.getCreationTime().getTime();
     }
 
+    /*
+     * (non-Javadoc)
+     * @see quickfix.MessageStore#getCreationTimeCalendar()
+     */
+    public Calendar getCreationTimeCalendar() throws IOException {
+        return info.getCreationTime();
+    }
+
     public int getNextSenderMsgSeqNum() throws IOException {
         return info.getNextSenderMsgSeqNum();
     }
diff --git a/quickfixj-core/src/test/java/quickfix/DefaultSessionScheduleTest.java b/quickfixj-core/src/test/java/quickfix/DefaultSessionScheduleTest.java
new file mode 100644
index 0000000000..7ae6919656
--- /dev/null
+++ b/quickfixj-core/src/test/java/quickfix/DefaultSessionScheduleTest.java
@@ -0,0 +1,120 @@
+package quickfix;
+
+import org.junit.After;
+import org.junit.Before;
+import org.junit.Test;
+import org.mockito.Mock;
+import org.mockito.MockitoAnnotations;
+
+import java.io.ByteArrayInputStream;
+
+import static org.junit.Assert.assertFalse;
+import static org.junit.Assert.assertTrue;
+import static org.mockito.Mockito.when;
+
+public class DefaultSessionScheduleTest {
+
+    private SessionID sessionID;
+    @Mock
+    private SystemTimeSource mockTimeSource;
+
+    @Before
+    public void before() {
+        MockitoAnnotations.initMocks(this);
+
+        sessionID = new SessionID("FIX.4.2:A->B");
+        SystemTime.setTimeSource(mockTimeSource);
+    }
+
+    @After
+    public void after() {
+        SystemTime.setTimeSource(null);
+    }
+
+    @Test
+    public void isNonStopSession_returns_true_when_SETTING_NON_STOP_SESSION_Y() throws FieldConvertError, ConfigError {
+        String sessionSettingsString = ""
+            + "[DEFAULT]\n"
+            + "NonStopSession=Y\n"
+            + "\n"
+            + "[SESSION]\n"
+            + "BeginString=FIX.4.2\n"
+            + "SenderCompID=A\n"
+            + "TargetCompID=B\n";
+        SessionSettings sessionSettings = new SessionSettings(new ByteArrayInputStream(sessionSettingsString.getBytes()));
+        DefaultSessionSchedule schedule = new DefaultSessionSchedule(sessionSettings, sessionID);
+
+        assertTrue(schedule.isNonStopSession());
+    }
+
+    @Test
+    public void isNonStopSession_returns_false_when_SETTING_NON_STOP_SESSION_N() throws FieldConvertError, ConfigError {
+        String sessionSettingsString = ""
+            + "[DEFAULT]\n"
+            + "NonStopSession=N\n"
+            + "\n"
+            + "[SESSION]\n"
+            + "BeginString=FIX.4.2\n"
+            + "SenderCompID=A\n"
+            + "TargetCompID=B\n"
+            + "StartTime=00:00:00\n"
+            + "EndTime=00:00:01\n";
+        SessionSettings sessionSettings = new SessionSettings(new ByteArrayInputStream(sessionSettingsString.getBytes()));
+        DefaultSessionSchedule schedule = new DefaultSessionSchedule(sessionSettings, sessionID);
+
+        assertFalse(schedule.isNonStopSession());
+    }
+
+    @Test
+    public void isNonStopSession_returns_false_when_SETTING_NON_STOP_SESSION_not_present() throws FieldConvertError, ConfigError {
+        String sessionSettingsString = ""
+            + "[DEFAULT]\n"
+            + "\n"
+            + "[SESSION]\n"
+            + "BeginString=FIX.4.2\n"
+            + "SenderCompID=A\n"
+            + "TargetCompID=B\n"
+            + "StartTime=00:00:00\n"
+            + "EndTime=00:00:01\n";
+        SessionSettings sessionSettings = new SessionSettings(new ByteArrayInputStream(sessionSettingsString.getBytes()));
+        DefaultSessionSchedule schedule = new DefaultSessionSchedule(sessionSettings, sessionID);
+
+        assertFalse(schedule.isNonStopSession());
+    }
+
+    @Test
+    public void isSessionTime_returns_true_for_time_within_window() throws FieldConvertError, ConfigError {
+        when(mockTimeSource.getTime()).thenReturn(1L);
+        String sessionSettingsString = ""
+            + "[DEFAULT]\n"
+            + "\n"
+            + "[SESSION]\n"
+            + "BeginString=FIX.4.2\n"
+            + "SenderCompID=A\n"
+            + "TargetCompID=B\n"
+            + "StartTime=00:00:00\n"
+            + "EndTime=00:00:01\n";
+        SessionSettings sessionSettings = new SessionSettings(new ByteArrayInputStream(sessionSettingsString.getBytes()));
+        DefaultSessionSchedule schedule = new DefaultSessionSchedule(sessionSettings, sessionID);
+
+        assertTrue(schedule.isSessionTime());
+    }
+
+    @Test
+    public void isSessionTime_returns_false_for_time_outside_window() throws FieldConvertError, ConfigError {
+        when(mockTimeSource.getTime()).thenReturn(2000L);
+        String sessionSettingsString = ""
+            + "[DEFAULT]\n"
+            + "\n"
+            + "[SESSION]\n"
+            + "BeginString=FIX.4.2\n"
+            + "SenderCompID=A\n"
+            + "TargetCompID=B\n"
+            + "StartTime=00:00:00\n"
+            + "EndTime=00:00:01\n";
+        SessionSettings sessionSettings = new SessionSettings(new ByteArrayInputStream(sessionSettingsString.getBytes()));
+        DefaultSessionSchedule schedule = new DefaultSessionSchedule(sessionSettings, sessionID);
+
+        assertFalse(schedule.isSessionTime());
+    }
+}
diff --git a/quickfixj-core/src/test/java/quickfix/LogUtilTest.java b/quickfixj-core/src/test/java/quickfix/LogUtilTest.java
index f533c7c042..f6b5af42e4 100644
--- a/quickfixj-core/src/test/java/quickfix/LogUtilTest.java
+++ b/quickfixj-core/src/test/java/quickfix/LogUtilTest.java
@@ -22,6 +22,7 @@
 import java.io.ByteArrayOutputStream;
 import java.io.IOException;
 import java.io.PrintStream;
+import java.util.Calendar;
 import java.util.Date;
 import org.junit.After;
 import static org.junit.Assert.assertTrue;
@@ -60,7 +61,7 @@ private void createSessionAndGenerateException(LogFactory mockLogFactory) throws
         Session session = new Session(null, sessionID1 -> {
             try {
                 return new MemoryStore() {
-                    public Date getCreationTime() throws IOException {
+                    public Calendar getCreationTimeCalendar() throws IOException {
                         throw new IOException("test");
                     }
                 };

From 6edbc0bdb504a5c509212d3e1e9abbf48190b53c Mon Sep 17 00:00:00 2001
From: Philip Whitehouse <philip@whiuk.com>
Date: Tue, 28 Apr 2020 10:29:28 +0100
Subject: [PATCH 2/4] Fix imports

---
 quickfixj-core/src/main/java/quickfix/SessionState.java | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/quickfixj-core/src/main/java/quickfix/SessionState.java b/quickfixj-core/src/main/java/quickfix/SessionState.java
index 653021d71c..6d894e7b75 100644
--- a/quickfixj-core/src/main/java/quickfix/SessionState.java
+++ b/quickfixj-core/src/main/java/quickfix/SessionState.java
@@ -20,7 +20,11 @@
 package quickfix;
 
 import java.io.IOException;
-import java.util.*;
+import java.util.Calendar;
+import java.util.Collection;
+import java.util.Date;
+import java.util.LinkedHashMap;
+import java.util.Map;
 import java.util.concurrent.atomic.AtomicInteger;
 import java.util.concurrent.locks.Lock;
 import java.util.concurrent.locks.ReentrantLock;

From 6f20a92a8ce7179f96cf55275b9cfe57e809a28a Mon Sep 17 00:00:00 2001
From: Philip Whitehouse <philip@whiuk.com>
Date: Tue, 28 Apr 2020 11:15:40 +0100
Subject: [PATCH 3/4] Add CheckStyle

---
 checkstyle.xml | 313 +++++++++++++++++++++++++++++++++++++++++++++++++
 pom.xml        |  44 +++++++
 2 files changed, 357 insertions(+)
 create mode 100644 checkstyle.xml

diff --git a/checkstyle.xml b/checkstyle.xml
new file mode 100644
index 0000000000..5a7f8d5526
--- /dev/null
+++ b/checkstyle.xml
@@ -0,0 +1,313 @@
+<?xml version="1.0"?>
+<!DOCTYPE module PUBLIC
+        "-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
+        "https://checkstyle.org/dtds/configuration_1_3.dtd">
+
+<!--
+    Checkstyle configuration that checks the Google coding conventions from Google Java Style
+    that can be found at https://google.github.io/styleguide/javaguide.html
+    Checkstyle is very configurable. Be sure to read the documentation at
+    http://checkstyle.org (or in your downloaded distribution).
+    To completely disable a check, just comment it out or delete it from the file.
+    To suppress certain violations please review suppression filters.
+    Authors: Max Vetrenko, Ruslan Diachenko, Roman Ivanov.
+ -->
+
+<module name = "Checker">
+    <property name="charset" value="UTF-8"/>
+
+    <property name="severity" value="warning"/>
+
+    <property name="fileExtensions" value="java, properties, xml"/>
+
+    <!-- Checks for whitespace                               -->
+    <!-- See http://checkstyle.org/config_whitespace.html -->
+    <module name="FileTabCharacter">
+        <property name="eachLine" value="true"/>
+    </module>
+
+    <module name="LineLength">
+        <property name="fileExtensions" value="java"/>
+        <property name="max" value="100"/>
+        <property name="ignorePattern" value="^package.*|^import.*|a href|href|http://|https://|ftp://"/>
+    </module>
+
+    <module name="TreeWalker">
+        <module name="OuterTypeFilename"/>
+        <module name="IllegalTokenText">
+            <property name="tokens" value="STRING_LITERAL, CHAR_LITERAL"/>
+            <property name="format"
+                      value="\\u00(09|0(a|A)|0(c|C)|0(d|D)|22|27|5(C|c))|\\(0(10|11|12|14|15|42|47)|134)"/>
+            <property name="message"
+                      value="Consider using special escape sequence instead of octal value or Unicode escaped value."/>
+        </module>
+        <module name="AvoidEscapedUnicodeCharacters">
+            <property name="allowEscapesForControlCharacters" value="true"/>
+            <property name="allowByTailComment" value="true"/>
+            <property name="allowNonPrintableEscapes" value="true"/>
+        </module>
+        <module name="AvoidStarImport"/>
+        <module name="OneTopLevelClass"/>
+        <module name="NoLineWrap">
+            <property name="tokens" value="PACKAGE_DEF, IMPORT, STATIC_IMPORT"/>
+        </module>
+        <module name="EmptyBlock">
+            <property name="option" value="TEXT"/>
+            <property name="tokens"
+                      value="LITERAL_TRY, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE, LITERAL_SWITCH"/>
+        </module>
+        <module name="NeedBraces">
+            <property name="tokens"
+                      value="LITERAL_DO, LITERAL_ELSE, LITERAL_FOR, LITERAL_IF, LITERAL_WHILE"/>
+        </module>
+        <module name="LeftCurly">
+            <property name="tokens"
+                      value="ANNOTATION_DEF, CLASS_DEF, CTOR_DEF, ENUM_CONSTANT_DEF, ENUM_DEF,
+                    INTERFACE_DEF, LAMBDA, LITERAL_CASE, LITERAL_CATCH, LITERAL_DEFAULT,
+                    LITERAL_DO, LITERAL_ELSE, LITERAL_FINALLY, LITERAL_FOR, LITERAL_IF,
+                    LITERAL_SWITCH, LITERAL_SYNCHRONIZED, LITERAL_TRY, LITERAL_WHILE, METHOD_DEF,
+                    OBJBLOCK, STATIC_INIT"/>
+        </module>
+        <module name="RightCurly">
+            <property name="id" value="RightCurlySame"/>
+            <property name="tokens"
+                      value="LITERAL_TRY, LITERAL_CATCH, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE,
+                    LITERAL_DO"/>
+        </module>
+        <module name="RightCurly">
+            <property name="id" value="RightCurlyAlone"/>
+            <property name="option" value="alone"/>
+            <property name="tokens"
+                      value="CLASS_DEF, METHOD_DEF, CTOR_DEF, LITERAL_FOR, LITERAL_WHILE, STATIC_INIT,
+                    INSTANCE_INIT, ANNOTATION_DEF, ENUM_DEF"/>
+        </module>
+        <module name="SuppressionXpathSingleFilter">
+            <!-- suppresion is required till https://github.com/checkstyle/checkstyle/issues/7541 -->
+            <property name="id" value="RightCurlyAlone"/>
+            <property name="query" value="//RCURLY[parent::SLIST[count(./*)=1]
+                                                 or preceding-sibling::*[last()][self::LCURLY]]"/>
+        </module>
+        <module name="WhitespaceAfter">
+            <property name="tokens"
+                      value="COMMA, SEMI, TYPECAST, LITERAL_IF, LITERAL_ELSE,
+                    LITERAL_WHILE, LITERAL_DO, LITERAL_FOR, DO_WHILE"/>
+        </module>
+        <module name="WhitespaceAround">
+            <property name="allowEmptyConstructors" value="true"/>
+            <property name="allowEmptyLambdas" value="true"/>
+            <property name="allowEmptyMethods" value="true"/>
+            <property name="allowEmptyTypes" value="true"/>
+            <property name="allowEmptyLoops" value="true"/>
+            <property name="tokens"
+                      value="ASSIGN, BAND, BAND_ASSIGN, BOR, BOR_ASSIGN, BSR, BSR_ASSIGN, BXOR,
+                    BXOR_ASSIGN, COLON, DIV, DIV_ASSIGN, DO_WHILE, EQUAL, GE, GT, LAMBDA, LAND,
+                    LCURLY, LE, LITERAL_CATCH, LITERAL_DO, LITERAL_ELSE, LITERAL_FINALLY,
+                    LITERAL_FOR, LITERAL_IF, LITERAL_RETURN, LITERAL_SWITCH, LITERAL_SYNCHRONIZED,
+                     LITERAL_TRY, LITERAL_WHILE, LOR, LT, MINUS, MINUS_ASSIGN, MOD, MOD_ASSIGN,
+                     NOT_EQUAL, PLUS, PLUS_ASSIGN, QUESTION, RCURLY, SL, SLIST, SL_ASSIGN, SR,
+                     SR_ASSIGN, STAR, STAR_ASSIGN, LITERAL_ASSERT, TYPE_EXTENSION_AND"/>
+            <message key="ws.notFollowed"
+                     value="WhitespaceAround: ''{0}'' is not followed by whitespace. Empty blocks may only be represented as '{}' when not part of a multi-block statement (4.1.3)"/>
+            <message key="ws.notPreceded"
+                     value="WhitespaceAround: ''{0}'' is not preceded with whitespace."/>
+        </module>
+        <module name="OneStatementPerLine"/>
+        <module name="MultipleVariableDeclarations"/>
+        <module name="ArrayTypeStyle"/>
+        <module name="MissingSwitchDefault"/>
+        <module name="FallThrough"/>
+        <module name="UpperEll"/>
+        <module name="ModifierOrder"/>
+        <module name="EmptyLineSeparator">
+            <property name="tokens"
+                      value="PACKAGE_DEF, IMPORT, STATIC_IMPORT, CLASS_DEF, INTERFACE_DEF, ENUM_DEF,
+                    STATIC_INIT, INSTANCE_INIT, METHOD_DEF, CTOR_DEF, VARIABLE_DEF"/>
+            <property name="allowNoEmptyLineBetweenFields" value="true"/>
+        </module>
+        <module name="SeparatorWrap">
+            <property name="id" value="SeparatorWrapDot"/>
+            <property name="tokens" value="DOT"/>
+            <property name="option" value="nl"/>
+        </module>
+        <module name="SeparatorWrap">
+            <property name="id" value="SeparatorWrapComma"/>
+            <property name="tokens" value="COMMA"/>
+            <property name="option" value="EOL"/>
+        </module>
+        <module name="SeparatorWrap">
+            <!-- ELLIPSIS is EOL until https://github.com/google/styleguide/issues/258 -->
+            <property name="id" value="SeparatorWrapEllipsis"/>
+            <property name="tokens" value="ELLIPSIS"/>
+            <property name="option" value="EOL"/>
+        </module>
+        <module name="SeparatorWrap">
+            <!-- ARRAY_DECLARATOR is EOL until https://github.com/google/styleguide/issues/259 -->
+            <property name="id" value="SeparatorWrapArrayDeclarator"/>
+            <property name="tokens" value="ARRAY_DECLARATOR"/>
+            <property name="option" value="EOL"/>
+        </module>
+        <module name="SeparatorWrap">
+            <property name="id" value="SeparatorWrapMethodRef"/>
+            <property name="tokens" value="METHOD_REF"/>
+            <property name="option" value="nl"/>
+        </module>
+        <module name="PackageName">
+            <property name="format" value="^[a-z]+(\.[a-z][a-z0-9]*)*$"/>
+            <message key="name.invalidPattern"
+                     value="Package name ''{0}'' must match pattern ''{1}''."/>
+        </module>
+        <module name="TypeName">
+            <property name="tokens" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, ANNOTATION_DEF"/>
+            <message key="name.invalidPattern"
+                     value="Type name ''{0}'' must match pattern ''{1}''."/>
+        </module>
+        <module name="MemberName">
+            <property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$"/>
+            <message key="name.invalidPattern"
+                     value="Member name ''{0}'' must match pattern ''{1}''."/>
+        </module>
+        <module name="ParameterName">
+            <property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
+            <message key="name.invalidPattern"
+                     value="Parameter name ''{0}'' must match pattern ''{1}''."/>
+        </module>
+        <module name="LambdaParameterName">
+            <property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
+            <message key="name.invalidPattern"
+                     value="Lambda parameter name ''{0}'' must match pattern ''{1}''."/>
+        </module>
+        <module name="CatchParameterName">
+            <property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
+            <message key="name.invalidPattern"
+                     value="Catch parameter name ''{0}'' must match pattern ''{1}''."/>
+        </module>
+        <module name="LocalVariableName">
+            <property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
+            <message key="name.invalidPattern"
+                     value="Local variable name ''{0}'' must match pattern ''{1}''."/>
+        </module>
+        <module name="ClassTypeParameterName">
+            <property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
+            <message key="name.invalidPattern"
+                     value="Class type name ''{0}'' must match pattern ''{1}''."/>
+        </module>
+        <module name="MethodTypeParameterName">
+            <property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
+            <message key="name.invalidPattern"
+                     value="Method type name ''{0}'' must match pattern ''{1}''."/>
+        </module>
+        <module name="InterfaceTypeParameterName">
+            <property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
+            <message key="name.invalidPattern"
+                     value="Interface type name ''{0}'' must match pattern ''{1}''."/>
+        </module>
+        <module name="NoFinalizer"/>
+        <module name="GenericWhitespace">
+            <message key="ws.followed"
+                     value="GenericWhitespace ''{0}'' is followed by whitespace."/>
+            <message key="ws.preceded"
+                     value="GenericWhitespace ''{0}'' is preceded with whitespace."/>
+            <message key="ws.illegalFollow"
+                     value="GenericWhitespace ''{0}'' should followed by whitespace."/>
+            <message key="ws.notPreceded"
+                     value="GenericWhitespace ''{0}'' is not preceded with whitespace."/>
+        </module>
+        <module name="Indentation">
+            <property name="basicOffset" value="2"/>
+            <property name="braceAdjustment" value="0"/>
+            <property name="caseIndent" value="2"/>
+            <property name="throwsIndent" value="4"/>
+            <property name="lineWrappingIndentation" value="4"/>
+            <property name="arrayInitIndent" value="2"/>
+        </module>
+        <module name="AbbreviationAsWordInName">
+            <property name="ignoreFinal" value="false"/>
+            <property name="allowedAbbreviationLength" value="1"/>
+            <property name="tokens"
+                      value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, ANNOTATION_DEF, ANNOTATION_FIELD_DEF,
+                    PARAMETER_DEF, VARIABLE_DEF, METHOD_DEF"/>
+        </module>
+        <module name="OverloadMethodsDeclarationOrder"/>
+        <module name="VariableDeclarationUsageDistance"/>
+        <module name="CustomImportOrder">
+            <property name="sortImportsInGroupAlphabetically" value="true"/>
+            <property name="separateLineBetweenGroups" value="true"/>
+            <property name="customImportOrderRules" value="STATIC###THIRD_PARTY_PACKAGE"/>
+            <property name="tokens" value="IMPORT, STATIC_IMPORT, PACKAGE_DEF"/>
+        </module>
+        <module name="MethodParamPad">
+            <property name="tokens"
+                      value="CTOR_DEF, LITERAL_NEW, METHOD_CALL, METHOD_DEF,
+                    SUPER_CTOR_CALL, ENUM_CONSTANT_DEF"/>
+        </module>
+        <module name="NoWhitespaceBefore">
+            <property name="tokens"
+                      value="COMMA, SEMI, POST_INC, POST_DEC, DOT, ELLIPSIS,
+                    LABELED_STAT, METHOD_REF"/>
+            <property name="allowLineBreaks" value="true"/>
+        </module>
+        <module name="ParenPad">
+            <property name="tokens"
+                      value="ANNOTATION, ANNOTATION_FIELD_DEF, CTOR_CALL, CTOR_DEF, DOT, ENUM_CONSTANT_DEF,
+                    EXPR, LITERAL_CATCH, LITERAL_DO, LITERAL_FOR, LITERAL_IF, LITERAL_NEW,
+                    LITERAL_SWITCH, LITERAL_SYNCHRONIZED, LITERAL_WHILE, METHOD_CALL,
+                    METHOD_DEF, QUESTION, RESOURCE_SPECIFICATION, SUPER_CTOR_CALL, LAMBDA"/>
+        </module>
+        <module name="OperatorWrap">
+            <property name="option" value="NL"/>
+            <property name="tokens"
+                      value="BAND, BOR, BSR, BXOR, DIV, EQUAL, GE, GT, LAND, LE, LITERAL_INSTANCEOF, LOR,
+                    LT, MINUS, MOD, NOT_EQUAL, PLUS, QUESTION, SL, SR, STAR, METHOD_REF "/>
+        </module>
+        <module name="AnnotationLocation">
+            <property name="id" value="AnnotationLocationMostCases"/>
+            <property name="tokens"
+                      value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF"/>
+        </module>
+        <module name="AnnotationLocation">
+            <property name="id" value="AnnotationLocationVariables"/>
+            <property name="tokens" value="VARIABLE_DEF"/>
+            <property name="allowSamelineMultipleAnnotations" value="true"/>
+        </module>
+        <module name="NonEmptyAtclauseDescription"/>
+        <module name="InvalidJavadocPosition"/>
+        <module name="JavadocTagContinuationIndentation"/>
+        <module name="SummaryJavadoc">
+            <property name="forbiddenSummaryFragments"
+                      value="^@return the *|^This method returns |^A [{]@code [a-zA-Z0-9]+[}]( is a )"/>
+        </module>
+        <module name="JavadocParagraph"/>
+        <module name="AtclauseOrder">
+            <property name="tagOrder" value="@param, @return, @throws, @deprecated"/>
+            <property name="target"
+                      value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF, VARIABLE_DEF"/>
+        </module>
+        <module name="JavadocMethod">
+            <property name="scope" value="public"/>
+            <property name="allowMissingParamTags" value="true"/>
+            <property name="allowMissingReturnTag" value="true"/>
+            <property name="allowedAnnotations" value="Override, Test"/>
+            <property name="tokens" value="METHOD_DEF, CTOR_DEF, ANNOTATION_FIELD_DEF"/>
+        </module>
+        <module name="MissingJavadocMethod">
+            <property name="scope" value="public"/>
+            <property name="minLineCount" value="2"/>
+            <property name="allowedAnnotations" value="Override, Test"/>
+            <property name="tokens" value="METHOD_DEF, CTOR_DEF, ANNOTATION_FIELD_DEF"/>
+        </module>
+        <module name="MethodName">
+            <property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9_]*$"/>
+            <message key="name.invalidPattern"
+                     value="Method name ''{0}'' must match pattern ''{1}''."/>
+        </module>
+        <module name="SingleLineJavadoc">
+            <property name="ignoreInlineTags" value="false"/>
+        </module>
+        <module name="EmptyCatchBlock">
+            <property name="exceptionVariableName" value="expected"/>
+        </module>
+        <module name="CommentsIndentation">
+            <property name="tokens" value="SINGLE_LINE_COMMENT, BLOCK_COMMENT_BEGIN"/>
+        </module>
+    </module>
+</module>
\ No newline at end of file
diff --git a/pom.xml b/pom.xml
index 470c2c5f98..afc870d1a6 100644
--- a/pom.xml
+++ b/pom.xml
@@ -85,13 +85,37 @@
 		<maven-bundle-plugin-version>3.5.1</maven-bundle-plugin-version>
 		<maven-gpg-plugin-version>1.6</maven-gpg-plugin-version>
 		<maven-deploy-plugin-version>2.8.2</maven-deploy-plugin-version>
+		<maven-checkstyle-plugin-version>3.1.1</maven-checkstyle-plugin-version>
 		<nexus-staging-maven-plugin-version>1.6.8</nexus-staging-maven-plugin-version>
 		<build-helper-maven-plugin-version>3.0.0</build-helper-maven-plugin-version>
+		<checkstyle-version>8.32</checkstyle-version>
 	</properties>
 
 	<build>
 		<pluginManagement>
 			<plugins>
+				<plugin>
+					<groupId>org.apache.maven.plugins</groupId>
+					<artifactId>maven-checkstyle-plugin</artifactId>
+					<version>${maven-checkstyle-plugin-version}</version>
+					<dependencies>
+						<dependency>
+							<groupId>com.puppycrawl.tools</groupId>
+							<artifactId>checkstyle</artifactId>
+							<version>${checkstyle-version}</version>
+						</dependency>
+					</dependencies>
+					<configuration>
+						<configLocation>checkstyle.xml</configLocation>
+					</configuration>
+					<executions>
+						<execution>
+							<goals>
+								<goal>check</goal>
+							</goals>
+						</execution>
+					</executions>
+				</plugin>
 				<plugin>
 					<groupId>org.apache.maven.plugins</groupId>
 					<artifactId>maven-deploy-plugin</artifactId>
@@ -293,6 +317,26 @@
 		</profile>
 	</profiles>
 
+	<reporting>
+		<plugins>
+			<plugin>
+				<groupId>org.apache.maven.plugins</groupId>
+				<artifactId>maven-checkstyle-plugin</artifactId>
+				<version>${maven-checkstyle-plugin-version}</version>
+				<dependencies>
+					<dependency>
+						<groupId>com.puppycrawl.tools</groupId>
+						<artifactId>checkstyle</artifactId>
+						<version>${checkstyle-version}</version>
+					</dependency>
+				</dependencies>
+				<configuration>
+					<configLocation>checkstyle.xml</configLocation>
+				</configuration>
+			</plugin>
+		</plugins>
+	</reporting>
+
 	<distributionManagement>
 		<snapshotRepository>
 			<id>ossrh</id>

From f93e84df3dadac8a5d585c7818a31aba9aed4a68 Mon Sep 17 00:00:00 2001
From: Christoph John <christoph.john@macd.com>
Date: Tue, 28 Apr 2020 14:52:51 +0200
Subject: [PATCH 4/4] commented unsupported tags

---
 pom.xml | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/pom.xml b/pom.xml
index afc870d1a6..90e06a0793 100644
--- a/pom.xml
+++ b/pom.xml
@@ -323,6 +323,7 @@
 				<groupId>org.apache.maven.plugins</groupId>
 				<artifactId>maven-checkstyle-plugin</artifactId>
 				<version>${maven-checkstyle-plugin-version}</version>
+				<!--
 				<dependencies>
 					<dependency>
 						<groupId>com.puppycrawl.tools</groupId>
@@ -333,6 +334,7 @@
 				<configuration>
 					<configLocation>checkstyle.xml</configLocation>
 				</configuration>
+				-->
 			</plugin>
 		</plugins>
 	</reporting>