Fixes minor code-cleanup and -format issues

greenmail-mail-test · May 28, 2024 · df592ca · df592ca
1 parent 033ee3a
commit df592ca
Show file tree

Hide file tree

Showing 25 changed files with 91 additions and 117 deletions.
diff --git a/greenmail-core/src/main/java/com/icegreen/greenmail/base/GreenMailOperations.java b/greenmail-core/src/main/java/com/icegreen/greenmail/base/GreenMailOperations.java
@@ -171,8 +171,8 @@ public interface GreenMailOperations {
      * <ul>
      *   <li>
      *     Expected structure in provided path, containing EML (rfc0822) mail files
-     *     <p>Pattern: <pre>&lt;EMAIL&gt; / &lt;FOLDER*&gt; / &lt;*.eml&gt;</pre></p>
-     *     <p>Example:</p>
+     *     <p>Pattern: <pre>&lt;EMAIL&gt; / &lt;FOLDER*&gt; / &lt;*.eml&gt;</pre>
+     *     <p>Example:
      *     <pre>
      *    ├── bar@localhost (directory)
      *    │   └── INBOX (directory)

diff --git a/greenmail-core/src/main/java/com/icegreen/greenmail/imap/commands/CommandParser.java b/greenmail-core/src/main/java/com/icegreen/greenmail/imap/commands/CommandParser.java
@@ -117,7 +117,7 @@ public String nstring(ImapRequestLineReader request) throws ProtocolException {
      * Reads a "mailbox" argument from the request. Not implemented *exactly* as per spec,
      * since a quoted or literal "inbox" still yeilds "INBOX"
      * (ie still case-insensitive if quoted or literal). I think this makes sense.
-     * <p/>
+     * <p>
      * mailbox         ::= "INBOX" / astring
      * ;; INBOX is case-insensitive.  All case variants of
      * ;; INBOX (e.g. "iNbOx") MUST be interpreted as INBOX

diff --git a/greenmail-core/src/main/java/com/icegreen/greenmail/imap/commands/CommandTemplate.java b/greenmail-core/src/main/java/com/icegreen/greenmail/imap/commands/CommandTemplate.java
@@ -32,7 +32,7 @@ abstract class CommandTemplate
     }
 
     /**
-     * By default, valid in any state (unless overridden by subclass.
+     * By default, valid in any state (unless overridden by subclass).
      *
      * @see com.icegreen.greenmail.imap.commands.ImapCommand#validForState
      */
@@ -95,7 +95,7 @@ protected String getExpectedMessage() {
         syntax.append(getName());
 
         String args = getArgSyntax();
-        if (args != null && args.length() > 0) {
+        if (args != null && !args.isEmpty()) {
             syntax.append(' ');
             syntax.append(args);
         }
@@ -106,7 +106,7 @@ protected String getExpectedMessage() {
     /**
      * Provides the syntax for the command arguments if any. This value is used
      * to provide user feedback in the case of a malformed request.
-     * <p/>
+     * <p>
      * For commands which do not allow any arguments, <code>null</code> should
      * be returned.
      *

diff --git a/greenmail-core/src/main/java/com/icegreen/greenmail/imap/commands/IdRange.java b/greenmail-core/src/main/java/com/icegreen/greenmail/imap/commands/IdRange.java
@@ -12,7 +12,7 @@
 /**
  * Represents a range of UID values.
  * <p>
- * From https://tools.ietf.org/html/rfc3501 :
+ * From <a href="https://tools.ietf.org/html/rfc3501">rfc3501</a> :
  * <p>
  * seq-number      = nz-number / "*"
  * ; message sequence number (COPY, FETCH, STORE
@@ -92,7 +92,7 @@ public boolean includes(long uid) {
     /**
      * Parses an uid sequence, a comma separated list of uid ranges.
      * Note that the wildcard '*' denotes the largest number in use.
-     * <p/>
+     * <p>
      * Example: 1,2:5,8:*
      *
      * @param idRangeSequence the sequence

diff --git a/greenmail-core/src/main/java/com/icegreen/greenmail/imap/commands/ImapCommand.java b/greenmail-core/src/main/java/com/icegreen/greenmail/imap/commands/ImapCommand.java
@@ -13,7 +13,7 @@
 
 /**
  * Represents a processor for a particular Imap command. Implementations of this
- * interface should encpasulate all command specific processing.
+ * interface should encapsulate all commands specific processing.
  *
  * @author Darrell DeBoer <darrell@apache.org>
  * @version $Revision: 109034 $

diff --git a/greenmail-core/src/main/java/com/icegreen/greenmail/imap/commands/QuotaRootCommand.java b/greenmail-core/src/main/java/com/icegreen/greenmail/imap/commands/QuotaRootCommand.java
@@ -11,11 +11,10 @@
 
 /**
  * Implements IMAP Quota Extension.
- * <p/>
- * See <a href="https://datatracker.ietf.org/doc/html/rfc2087#section-4-1">rfc2087</a>
- *
+ * <p>
  * Supports MESSAGES and STORAGE.
- * @author mm
+ * <p>
+ * See <a href="https://datatracker.ietf.org/doc/html/rfc2087#section-4-1">rfc2087</a>
  */
 public class QuotaRootCommand extends QuotaCommand {
     public static final String NAME = "GETQUOTAROOT";

diff --git a/greenmail-core/src/main/java/com/icegreen/greenmail/imap/commands/SetQuotaCommand.java b/greenmail-core/src/main/java/com/icegreen/greenmail/imap/commands/SetQuotaCommand.java
@@ -9,7 +9,7 @@
 
 /**
  * Implements IMAP Quota Extension.
- * <p/>
+ * <p>
  * See <a href="https://datatracker.ietf.org/doc/html/rfc2087#section-4-1">rfc2087</a>
  *
  * @author mm

diff --git a/greenmail-core/src/main/java/com/icegreen/greenmail/smtp/commands/AuthCommand.java b/greenmail-core/src/main/java/com/icegreen/greenmail/smtp/commands/AuthCommand.java
@@ -19,17 +19,18 @@
 import java.io.IOException;
 import java.util.Arrays;
 
-
 /**
  * AUTH command.
- * <p/>
+ * <p>
+ * <pre>
  * Supported: PLAIN, LOGIN
  * AUTH mechanism [initial-response]
  * or
  * AUTH LOGIN [initial-response]
+ * </pre>
  * <a href="https://tools.ietf.org/html/rfc4954">RFC4954</a>
  * <a href="https://tools.ietf.org/html/rfc2554">RFC2554</a>
- * <a href="http://www.iana.org/assignments/sasl-mechanisms/sasl-mechanisms.xhtml">SASL mechanisms</a></a>
+ * <a href="http://www.iana.org/assignments/sasl-mechanisms/sasl-mechanisms.xhtml">SASL mechanisms</a>
  * <a href="https://datatracker.ietf.org/doc/draft-murchison-sasl-login/">SASL LOGIN</a>
  */
 public class AuthCommand extends SmtpCommand {
@@ -83,7 +84,7 @@ private void authPlain(SmtpConnection conn, SmtpState state, SmtpManager manager
         } else {
             initialResponse = commandParts[2];
         }
-        
+
         SaslMessage saslMessage = parseInitialResponse(initialResponse);
         AuthenticationState authenticationContext = new PlainAuthenticationState(saslMessage);
         state.getMessage().setAuthenticationState(authenticationContext);
@@ -124,7 +125,7 @@ private void authLogin(SmtpConnection conn, SmtpState state, SmtpManager manager
     private boolean authenticate(UserManager userManager, SaslMessage saslMessage) {
         return userManager.test(saslMessage.getAuthcid(), saslMessage.getPasswd());
     }
-    
+
     private SaslMessage parseInitialResponse(String initialReponse) {
         String value = EncodingUtil.decodeBase64(initialReponse);
         // authorization-id\0authentication-id\0passwd

diff --git a/greenmail-core/src/main/java/com/icegreen/greenmail/smtp/commands/DataCommand.java b/greenmail-core/src/main/java/com/icegreen/greenmail/smtp/commands/DataCommand.java
@@ -18,11 +18,9 @@
 
 /**
  * DATA command.
- * <p/>
- * The spec is at <a
- * href="https://tools.ietf.org/html/rfc2821.html#section-4.1.1.4">
+ * <p>
+ * <a href="https://tools.ietf.org/html/rfc2821.html#section-4.1.1.4">
  * https://tools.ietf.org/html/rfc2821.html#section-4.1.1.4</a>.
- * </p>
  */
 public class DataCommand extends SmtpCommand {
     @Override

diff --git a/greenmail-core/src/main/java/com/icegreen/greenmail/smtp/commands/HeloCommand.java b/greenmail-core/src/main/java/com/icegreen/greenmail/smtp/commands/HeloCommand.java
@@ -13,10 +13,10 @@
 
 /**
  * EHLO/HELO command.
- * <p/>
+ * <p>
  * TODO: What does HELO do if it's already been called before?
- * <p/>
- * <a https://tools.ietf.org/html/rfc2821#section-4.1.1.1">RFC2821</a>
+ * <p>
+ * <a href="https://tools.ietf.org/html/rfc2821#section-4.1.1.1">RFC2821</a>
  * <a href="https://tools.ietf.org/html/rfc4954">RFC4954</a>
  * <a href="https://tools.ietf.org/html/rfc2554">RFC2554</a>
  */
@@ -42,4 +42,4 @@ private void extractHeloName(SmtpConnection conn,
 
         conn.setHeloName(heloName);
     }
-}
+}
diff --git a/greenmail-core/src/main/java/com/icegreen/greenmail/smtp/commands/MailCommand.java b/greenmail-core/src/main/java/com/icegreen/greenmail/smtp/commands/MailCommand.java
@@ -6,23 +6,20 @@
  */
 package com.icegreen.greenmail.smtp.commands;
 
-import java.util.regex.Matcher;
-import java.util.regex.Pattern;
-
 import com.icegreen.greenmail.mail.MailAddress;
 import com.icegreen.greenmail.smtp.SmtpConnection;
 import com.icegreen.greenmail.smtp.SmtpManager;
 import com.icegreen.greenmail.smtp.SmtpState;
 
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+
 
 /**
  * MAIL command.
- * <p/>
- * <p/>
- * The spec is at <a
- * href="https://tools.ietf.org/html/rfc2821.html#section-4.1.1.2">
+ * <p>
+ * <a href="https://tools.ietf.org/html/rfc2821.html#section-4.1.1.2">
  * https://tools.ietf.org/html/rfc2821.html#section-4.1.1.2</a>
- * </p>
  */
 public class MailCommand
         extends SmtpCommand {
@@ -58,4 +55,4 @@ public void execute(SmtpConnection conn, SmtpState state,
             conn.send("501 Required syntax: 'MAIL FROM:<email@host>'");
         }
     }
-}
+}
diff --git a/greenmail-core/src/main/java/com/icegreen/greenmail/smtp/commands/NoopCommand.java b/greenmail-core/src/main/java/com/icegreen/greenmail/smtp/commands/NoopCommand.java
@@ -10,16 +10,12 @@
 import com.icegreen.greenmail.smtp.SmtpManager;
 import com.icegreen.greenmail.smtp.SmtpState;
 
-
 /**
  * NOOP command.
- * <p/>
- * <p/>
- * The spec is at <a
- * href="https://tools.ietf.org/html/rfc2821.html#section-4.1.1.9">
- * https://tools.ietf.org/html/rfc2821.html#section-4.1.1.9</a>.
- * </p>
- * <p>"NOOP" [ SP String ] CRLF</p>
+ * <p>
+ * <a href="https://tools.ietf.org/html/rfc2821.html#section-4.1.1.9">
+ * https://tools.ietf.org/html/rfc2821.html#section-4.1.1.9</a>
+ * <pre>"NOOP" [ SP String ] CRLF</pre>
  */
 public class NoopCommand
         extends SmtpCommand {
@@ -28,4 +24,4 @@ public void execute(SmtpConnection conn, SmtpState state,
                         SmtpManager manager, String commandLine) {
         conn.send("250 Is that all?");
     }
-}
+}
diff --git a/greenmail-core/src/main/java/com/icegreen/greenmail/smtp/commands/QuitCommand.java b/greenmail-core/src/main/java/com/icegreen/greenmail/smtp/commands/QuitCommand.java
@@ -10,16 +10,12 @@
 import com.icegreen.greenmail.smtp.SmtpManager;
 import com.icegreen.greenmail.smtp.SmtpState;
 
-
 /**
  * QUIT command.
- * <p/>
- * <p/>
- * The spec is at <a
- * https://tools.ietf.org/html/rfc2821.html#section-4.1.1.10">
- * https://tools.ietf.org/html/rfc2821.html#section-4.1.1.10</a>.
- * </p>
- * <p>"QUIT" CRLF</p>
+ * <p>
+ * <a href="https://tools.ietf.org/html/rfc2821.html#section-4.1.1.10">
+ * https://tools.ietf.org/html/rfc2821.html#section-4.1.1.10</a>
+ * <pre>"QUIT" CRLF</pre>
  */
 public class QuitCommand
         extends SmtpCommand {
@@ -31,4 +27,4 @@ public void execute(SmtpConnection conn, SmtpState state,
                 " Service closing transmission channel");
         conn.quit();
     }
-}
+}
diff --git a/greenmail-core/src/main/java/com/icegreen/greenmail/smtp/commands/RcptCommand.java b/greenmail-core/src/main/java/com/icegreen/greenmail/smtp/commands/RcptCommand.java
@@ -6,27 +6,23 @@
  */
 package com.icegreen.greenmail.smtp.commands;
 
-import java.util.regex.Matcher;
-import java.util.regex.Pattern;
-
 import com.icegreen.greenmail.mail.MailAddress;
 import com.icegreen.greenmail.smtp.SmtpConnection;
 import com.icegreen.greenmail.smtp.SmtpManager;
 import com.icegreen.greenmail.smtp.SmtpState;
 
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
 
 /**
  * RCPT command.
- * <p/>
- * <p/>
- * The spec is at <a
- * href="https://tools.ietf.org/html/rfc2821.html#section-4.1.1.3">
- * https://tools.ietf.org/html/rfc2821.html#section-4.1.1.3</a>.
- * </p>
  * <p>
+ * <a href="https://tools.ietf.org/html/rfc2821.html#section-4.1.1.3">
+ * https://tools.ietf.org/html/rfc2821.html#section-4.1.1.3</a>
+ * <pre>
  * "RCPT TO:" ("<Postmaster@" domain ">" / "<Postmaster>" / Forward-Path)
  *            [SP Rcpt-parameters] CRLF
- * </p>
+ * </pre>
  */
 public class RcptCommand
         extends SmtpCommand {
@@ -60,4 +56,4 @@ public void execute(SmtpConnection conn, SmtpState state,
             conn.send("501 Required syntax: 'RCPT TO:<email@host>'");
         }
     }
-}
+}
diff --git a/greenmail-core/src/main/java/com/icegreen/greenmail/smtp/commands/RsetCommand.java b/greenmail-core/src/main/java/com/icegreen/greenmail/smtp/commands/RsetCommand.java
@@ -10,15 +10,11 @@
 import com.icegreen.greenmail.smtp.SmtpManager;
 import com.icegreen.greenmail.smtp.SmtpState;
 
-
 /**
  * RSET command.
- * <p/>
- * <p/>
- * The spec is at <a
- * href="https://tools.ietf.org/html/rfc2821.html#section-4.1.1.5">
- * https://tools.ietf.org/html/rfc2821.html#section-4.1.1.5</a>.
- * </p>
+ * <p>
+ * <a href="https://tools.ietf.org/html/rfc2821.html#section-4.1.1.5">
+ * https://tools.ietf.org/html/rfc2821.html#section-4.1.1.5</a>
  */
 public class RsetCommand
         extends SmtpCommand {
@@ -28,4 +24,4 @@ public void execute(SmtpConnection conn, SmtpState state,
         state.clearMessage();
         conn.send("250 OK");
     }
-}
+}
diff --git a/greenmail-core/src/main/java/com/icegreen/greenmail/smtp/commands/SmtpCommandRegistry.java b/greenmail-core/src/main/java/com/icegreen/greenmail/smtp/commands/SmtpCommandRegistry.java
@@ -9,7 +9,6 @@
 import java.util.HashMap;
 import java.util.Map;
 
-
 public class SmtpCommandRegistry {
     private static final Map<String, SmtpCommand> commands = new HashMap<>();
 
@@ -29,4 +28,4 @@ public class SmtpCommandRegistry {
     public SmtpCommand getCommand(String name) {
         return commands.get(name);
     }
-}
+}
diff --git a/greenmail-core/src/main/java/com/icegreen/greenmail/smtp/commands/VrfyCommand.java b/greenmail-core/src/main/java/com/icegreen/greenmail/smtp/commands/VrfyCommand.java
@@ -10,15 +10,11 @@
 import com.icegreen.greenmail.smtp.SmtpManager;
 import com.icegreen.greenmail.smtp.SmtpState;
 
-
 /**
  * VRFY command.
- * <p/>
- * <p/>
- * The spec is at <a
- * href="http://asg.web.cmu.edu/rfc/rfc2821.html#sec-4.1.1.6">
+ * <p>
+ * <a href="http://asg.web.cmu.edu/rfc/rfc2821.html#sec-4.1.1.6">
  * http://asg.web.cmu.edu/rfc/rfc2821.html#sec-4.1.1.6</a>.
- * </p>
  */
 public class VrfyCommand
         extends SmtpCommand {
@@ -27,4 +23,4 @@ public void execute(SmtpConnection conn, SmtpState state,
                         SmtpManager manager, String commandLine) {
         conn.send("252 Cannot VRFY user, but will accept message and attempt delivery");
     }
-}
+}