From da464b82717f53e87d5017941041f3e9242767e8 Mon Sep 17 00:00:00 2001
From: Gary Gregory <garydgregory@gmail.com>
Date: Sat, 4 May 2024 15:50:47 -0400
Subject: [PATCH] Add Checkstyle rules

---
 src/conf/checkstyle.xml                        | 18 +++---------------
 .../net/examples/mail/IMAPExportMbox.java      |  2 +-
 .../commons/net/examples/unix/rexec.java       |  3 ++-
 .../commons/net/examples/unix/rlogin.java      |  3 ++-
 .../commons/net/examples/unix/rshell.java      |  3 ++-
 .../net/ftp/parser/MLSxEntryParser.java        |  2 +-
 .../net/ftp/parser/MVSFTPEntryParser.java      |  2 +-
 7 files changed, 12 insertions(+), 21 deletions(-)

diff --git a/src/conf/checkstyle.xml b/src/conf/checkstyle.xml
index c3e029339..407714a92 100644
--- a/src/conf/checkstyle.xml
+++ b/src/conf/checkstyle.xml
@@ -19,20 +19,16 @@ limitations under the License.
 <!DOCTYPE module PUBLIC
     "-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
     "https://checkstyle.org/dtds/configuration_1_3.dtd">
-
 <!-- Commons Net customization of default Checkstyle behavior -->
 <module name="Checker">
-
   <property name="localeLanguage" value="en"/>
   <module name="JavadocPackage">
     <!-- setting allowLegacy means it will check for package.html instead of just package-info.java -->
     <property name="allowLegacy" value="true"/>
   </module>
-
   <module name="FileTabCharacter">
     <property name="fileExtensions" value="java,xml"/>
   </module>
-
   <!-- Checks for white space at the end of the line -->
   <!-- See http://checkstyle.sourceforge.net/config_regexp.html -->
   <module name="RegexpSingleline">
@@ -40,18 +36,15 @@ limitations under the License.
     <property name="message" value="Line has trailing spaces." />
     <property name="fileExtensions" value="java" />
   </module>
-
   <!-- @author tags are deprecated -->
   <module name="RegexpSingleline">
     <property name="format" value="^\s+\*\s+@author\s" />
     <property name="message" value="Deprecated @author tag" />
     <property name="fileExtensions" value="java" />
   </module>
-
   <module name="LineLength">
     <property name="max" value="160"/>
   </module>
-
   <module name="TreeWalker">
     <module name="AvoidStarImport">
       <property name="excludes" value="org.junit.Assert"/>
@@ -59,13 +52,10 @@ limitations under the License.
     <module name="RedundantImport"/>
     <module name="UnusedImports"/>
     <module name="NeedBraces"/>
-
     <!-- Modifier Checks                                    -->
     <!-- See http://checkstyle.sf.net/config_modifiers.html -->
     <module name="ModifierOrder"/>
-
     <!--module name="RedundantModifier"/-->
-
     <!-- Checks for blocks. You know, those {}'s         -->
     <!-- See http://checkstyle.sf.net/config_blocks.html -->
     <!--module name="AvoidNestedBlocks"/-->
@@ -73,14 +63,11 @@ limitations under the License.
       <property name="option" value="text"/>
     </module>
     <module name="EmptyCatchBlock"></module>
-
     <module name="JavadocMethod">
       <property name="accessModifiers" value="public"/>
       <property name="allowMissingParamTags" value="true"/>
     </module>
-
     <module name="SuppressionCommentFilter"/>
-
     <!--
         Allow comment to suppress checkstyle for a single line
         e.g. // CHECKSTYLE IGNORE MagicNumber
@@ -95,9 +82,10 @@ limitations under the License.
       <property name="ordered" value="true"/>
       <property name="separated" value="true"/>
     </module>
-
+    <module name="WhitespaceAfter" />
+    <module name="WhitespaceAround" />
+    <module name="WhitespaceAroundCheck" />
   </module>
-
   <module name="SuppressionFilter">
     <!-- config_loc is used by Eclipse plugin -->
     <property name="file" value="${config_loc}/checkstyle-suppressions.xml"/>
diff --git a/src/main/java/org/apache/commons/net/examples/mail/IMAPExportMbox.java b/src/main/java/org/apache/commons/net/examples/mail/IMAPExportMbox.java
index fa54cf56d..18cfa9cc3 100644
--- a/src/main/java/org/apache/commons/net/examples/mail/IMAPExportMbox.java
+++ b/src/main/java/org/apache/commons/net/examples/mail/IMAPExportMbox.java
@@ -129,7 +129,7 @@ public boolean chunkReceived(final IMAP imap) {
                 final String line = replyStrings[i];
                 if (line.startsWith("Return-Path: ")) {
                     final String[] parts = line.split(" ", 2);
-                    if (!parts[1].equals("<>")) {// Don't replace default with blank
+                    if (!parts[1].equals("<>")) { // Don't replace default with blank
                         replyTo = parts[1];
                         if (replyTo.startsWith("<")) {
                             if (replyTo.endsWith(">")) {
diff --git a/src/main/java/org/apache/commons/net/examples/unix/rexec.java b/src/main/java/org/apache/commons/net/examples/unix/rexec.java
index ec159054d..602887da4 100644
--- a/src/main/java/org/apache/commons/net/examples/unix/rexec.java
+++ b/src/main/java/org/apache/commons/net/examples/unix/rexec.java
@@ -63,7 +63,8 @@ public static void main(final String[] args) {
             try {
                 client.disconnect();
             } catch (final IOException f) {
-                /* ignored */}
+                /* ignored */
+            }
             e.printStackTrace();
             System.err.println("Could not execute command.");
             System.exit(1);
diff --git a/src/main/java/org/apache/commons/net/examples/unix/rlogin.java b/src/main/java/org/apache/commons/net/examples/unix/rlogin.java
index 4293cc6d7..83a6aa18b 100644
--- a/src/main/java/org/apache/commons/net/examples/unix/rlogin.java
+++ b/src/main/java/org/apache/commons/net/examples/unix/rlogin.java
@@ -70,7 +70,8 @@ public static void main(final String[] args) {
             try {
                 client.disconnect();
             } catch (final IOException f) {
-                /* ignored */}
+                /* ignored */
+            }
             e.printStackTrace();
             System.err.println("rlogin authentication failed.");
             System.exit(1);
diff --git a/src/main/java/org/apache/commons/net/examples/unix/rshell.java b/src/main/java/org/apache/commons/net/examples/unix/rshell.java
index 0ed9fb493..462ce6edb 100644
--- a/src/main/java/org/apache/commons/net/examples/unix/rshell.java
+++ b/src/main/java/org/apache/commons/net/examples/unix/rshell.java
@@ -65,7 +65,8 @@ public static void main(final String[] args) {
             try {
                 client.disconnect();
             } catch (final IOException f) {
-                /* ignored */}
+                /* ignored */
+            }
             e.printStackTrace();
             System.err.println("Could not execute command.");
             System.exit(1);
diff --git a/src/main/java/org/apache/commons/net/ftp/parser/MLSxEntryParser.java b/src/main/java/org/apache/commons/net/ftp/parser/MLSxEntryParser.java
index 0687b5ff9..73a51c27c 100644
--- a/src/main/java/org/apache/commons/net/ftp/parser/MLSxEntryParser.java
+++ b/src/main/java/org/apache/commons/net/ftp/parser/MLSxEntryParser.java
@@ -184,7 +184,7 @@ private void doUnixPerms(final FTPFile file, final String valueLowerCase) {
 
     @Override
     public FTPFile parseFTPEntry(final String entry) {
-        if (entry.startsWith(" ")) {// leading space means no facts are present
+        if (entry.startsWith(" ")) { // leading space means no facts are present
             if (entry.length() > 1) { // is there a path name?
                 final FTPFile file = new FTPFile();
                 file.setRawListing(entry);
diff --git a/src/main/java/org/apache/commons/net/ftp/parser/MVSFTPEntryParser.java b/src/main/java/org/apache/commons/net/ftp/parser/MVSFTPEntryParser.java
index fc2bdb563..e0ec87ff4 100644
--- a/src/main/java/org/apache/commons/net/ftp/parser/MVSFTPEntryParser.java
+++ b/src/main/java/org/apache/commons/net/ftp/parser/MVSFTPEntryParser.java
@@ -462,7 +462,7 @@ public List<String> preParse(final List<String> orig) {
             } else if (header.indexOf("Spool Files") >= 30) {
                 setType(JES_LEVEL_1_LIST_TYPE);
                 super.setRegex(JES_LEVEL_1_LIST_REGEX);
-            } else if (header.startsWith("JOBNAME") && header.indexOf("JOBID") > 8) {// header contains JOBNAME JOBID OWNER // STATUS CLASS
+            } else if (header.startsWith("JOBNAME") && header.indexOf("JOBID") > 8) { // header contains JOBNAME JOBID OWNER // STATUS CLASS
                 setType(JES_LEVEL_2_LIST_TYPE);
                 super.setRegex(JES_LEVEL_2_LIST_REGEX);
             } else {