You are viewing a plain text version of this content. The canonical link for it is here.
Posted to server-dev@james.apache.org by bt...@apache.org on 2019/11/08 03:12:15 UTC
[james-project] 28/36: [REFACTORING] Clean protocols-pop3 javadoc
This is an automated email from the ASF dual-hosted git repository.
btellier pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/james-project.git
commit bf902d90e3e44f926936451cf7fd63b6aba48fce
Author: Benoit Tellier <bt...@linagora.com>
AuthorDate: Thu Nov 7 11:52:42 2019 +0700
[REFACTORING] Clean protocols-pop3 javadoc
- Solve IntellijJ warnings related to javaDoc
- Remove verbose, meaningless entries
---
.../james/protocols/lmtp/LMTPConfiguration.java | 3 ---
.../james/protocols/lmtp/LMTPMultiResponse.java | 5 ++---
.../protocols/lmtp/LMTPProtocolHandlerChain.java | 2 --
.../lmtp/core/DataLineMessageHookHandler.java | 2 --
.../lmtp/core/ReceivedDataLineFilter.java | 2 --
.../protocols/lmtp/core/WelcomeMessageHandler.java | 2 --
.../lmtp/hook/DeliverToRecipientHook.java | 5 +----
.../james/protocols/pop3/POP3Configuration.java | 1 -
.../apache/james/protocols/pop3/POP3Protocol.java | 1 -
.../protocols/pop3/POP3ProtocolHandlerChain.java | 3 ---
.../apache/james/protocols/pop3/POP3Response.java | 2 --
.../james/protocols/pop3/POP3StartTlsResponse.java | 2 --
.../james/protocols/pop3/POP3StreamResponse.java | 1 -
.../pop3/core/AbstractApopCmdHandler.java | 7 +------
.../pop3/core/AbstractPassCmdHandler.java | 14 +++----------
.../james/protocols/pop3/core/CapaCapability.java | 4 ----
.../protocols/pop3/core/MessageMetaDataUtils.java | 7 -------
.../protocols/pop3/mailbox/AbstractMailbox.java | 5 ++---
.../james/protocols/pop3/mailbox/ImapMailbox.java | 16 ---------------
.../james/protocols/pop3/mailbox/Mailbox.java | 24 ----------------------
.../protocols/pop3/mailbox/MessageMetaData.java | 8 --------
21 files changed, 9 insertions(+), 107 deletions(-)
diff --git a/protocols/lmtp/src/main/java/org/apache/james/protocols/lmtp/LMTPConfiguration.java b/protocols/lmtp/src/main/java/org/apache/james/protocols/lmtp/LMTPConfiguration.java
index d397699..fa3f374 100644
--- a/protocols/lmtp/src/main/java/org/apache/james/protocols/lmtp/LMTPConfiguration.java
+++ b/protocols/lmtp/src/main/java/org/apache/james/protocols/lmtp/LMTPConfiguration.java
@@ -24,11 +24,8 @@ import org.apache.james.protocols.smtp.SMTPConfiguration;
/**
* A {@link ProtocolConfigurationImpl} which is used in the context of LMTP
- *
*/
public abstract class LMTPConfiguration extends ProtocolConfigurationImpl implements SMTPConfiguration {
-
-
@Override
public boolean isRelayingAllowed(String remoteIP) {
diff --git a/protocols/lmtp/src/main/java/org/apache/james/protocols/lmtp/LMTPMultiResponse.java b/protocols/lmtp/src/main/java/org/apache/james/protocols/lmtp/LMTPMultiResponse.java
index 6c3f0c0..af212c9 100644
--- a/protocols/lmtp/src/main/java/org/apache/james/protocols/lmtp/LMTPMultiResponse.java
+++ b/protocols/lmtp/src/main/java/org/apache/james/protocols/lmtp/LMTPMultiResponse.java
@@ -25,9 +25,8 @@ import java.util.List;
import org.apache.james.protocols.api.Response;
/**
- * After the message message is submitted via the 'CRLF.CLRF' sequence the LMTP Server will return a response line for every recipient. This special {@link Response} can be used for this
- *
- *
+ * After the message message is submitted via the 'CRLF.CLRF' sequence the LMTP Server will return a response line for
+ * every recipient. This special {@link Response} can be used for this
*/
public class LMTPMultiResponse implements Response {
diff --git a/protocols/lmtp/src/main/java/org/apache/james/protocols/lmtp/LMTPProtocolHandlerChain.java b/protocols/lmtp/src/main/java/org/apache/james/protocols/lmtp/LMTPProtocolHandlerChain.java
index 5af64b8..7a21cca 100644
--- a/protocols/lmtp/src/main/java/org/apache/james/protocols/lmtp/LMTPProtocolHandlerChain.java
+++ b/protocols/lmtp/src/main/java/org/apache/james/protocols/lmtp/LMTPProtocolHandlerChain.java
@@ -48,8 +48,6 @@ import org.apache.james.protocols.smtp.hook.Hook;
/**
* Special {@link SMTPProtocolHandlerChain} sub-class which should be used to build the chain for LMTP.
- *
- *
*/
public class LMTPProtocolHandlerChain extends SMTPProtocolHandlerChain {
diff --git a/protocols/lmtp/src/main/java/org/apache/james/protocols/lmtp/core/DataLineMessageHookHandler.java b/protocols/lmtp/src/main/java/org/apache/james/protocols/lmtp/core/DataLineMessageHookHandler.java
index 75c9000..1e971cf 100644
--- a/protocols/lmtp/src/main/java/org/apache/james/protocols/lmtp/core/DataLineMessageHookHandler.java
+++ b/protocols/lmtp/src/main/java/org/apache/james/protocols/lmtp/core/DataLineMessageHookHandler.java
@@ -36,8 +36,6 @@ import org.apache.james.protocols.smtp.dsn.DSNStatus;
/**
* {@link DataLineMessageHookHandler} which will use the wired {@link DeliverToRecipientHook}'s to deliver the message to all the valid recipients.
- *
- *
*/
public class DataLineMessageHookHandler extends org.apache.james.protocols.smtp.core.DataLineMessageHookHandler {
diff --git a/protocols/lmtp/src/main/java/org/apache/james/protocols/lmtp/core/ReceivedDataLineFilter.java b/protocols/lmtp/src/main/java/org/apache/james/protocols/lmtp/core/ReceivedDataLineFilter.java
index bbaefbf..a7fe568 100644
--- a/protocols/lmtp/src/main/java/org/apache/james/protocols/lmtp/core/ReceivedDataLineFilter.java
+++ b/protocols/lmtp/src/main/java/org/apache/james/protocols/lmtp/core/ReceivedDataLineFilter.java
@@ -22,8 +22,6 @@ import org.apache.james.protocols.smtp.SMTPSession;
/**
* {@link ReceivedDataLineFilter} which will add the Received header to the message
- *
- *
*/
public class ReceivedDataLineFilter extends org.apache.james.protocols.smtp.core.ReceivedDataLineFilter {
diff --git a/protocols/lmtp/src/main/java/org/apache/james/protocols/lmtp/core/WelcomeMessageHandler.java b/protocols/lmtp/src/main/java/org/apache/james/protocols/lmtp/core/WelcomeMessageHandler.java
index c0ffb73..9ff612e 100644
--- a/protocols/lmtp/src/main/java/org/apache/james/protocols/lmtp/core/WelcomeMessageHandler.java
+++ b/protocols/lmtp/src/main/java/org/apache/james/protocols/lmtp/core/WelcomeMessageHandler.java
@@ -23,8 +23,6 @@ import org.apache.james.protocols.smtp.SMTPSession;
/**
* Returns the WELCOME response to the client after it established a connection
- *
- *
*/
public class WelcomeMessageHandler extends org.apache.james.protocols.smtp.core.WelcomeMessageHandler {
diff --git a/protocols/lmtp/src/main/java/org/apache/james/protocols/lmtp/hook/DeliverToRecipientHook.java b/protocols/lmtp/src/main/java/org/apache/james/protocols/lmtp/hook/DeliverToRecipientHook.java
index 7053cf8..2acc4a2 100644
--- a/protocols/lmtp/src/main/java/org/apache/james/protocols/lmtp/hook/DeliverToRecipientHook.java
+++ b/protocols/lmtp/src/main/java/org/apache/james/protocols/lmtp/hook/DeliverToRecipientHook.java
@@ -34,10 +34,7 @@ public interface DeliverToRecipientHook extends Hook {
/**
* Deliver the message to the recipient
- *
- * @param session
- * @param recipient
- * @param envelope
+ *
* @return response
*/
HookResult deliver(SMTPSession session, MailAddress recipient, MailEnvelope envelope);
diff --git a/protocols/pop3/src/main/java/org/apache/james/protocols/pop3/POP3Configuration.java b/protocols/pop3/src/main/java/org/apache/james/protocols/pop3/POP3Configuration.java
index 7d5b5d5..b63a3a0 100644
--- a/protocols/pop3/src/main/java/org/apache/james/protocols/pop3/POP3Configuration.java
+++ b/protocols/pop3/src/main/java/org/apache/james/protocols/pop3/POP3Configuration.java
@@ -22,7 +22,6 @@ import org.apache.james.protocols.api.ProtocolConfigurationImpl;
/**
* {@link ProtocolConfigurationImpl} which adds some default configuration for POP3
- *
*/
public class POP3Configuration extends ProtocolConfigurationImpl {
diff --git a/protocols/pop3/src/main/java/org/apache/james/protocols/pop3/POP3Protocol.java b/protocols/pop3/src/main/java/org/apache/james/protocols/pop3/POP3Protocol.java
index e25f90d..08f2e36 100644
--- a/protocols/pop3/src/main/java/org/apache/james/protocols/pop3/POP3Protocol.java
+++ b/protocols/pop3/src/main/java/org/apache/james/protocols/pop3/POP3Protocol.java
@@ -27,7 +27,6 @@ import org.apache.james.protocols.api.handler.ProtocolHandlerChain;
/**
* {@link ProtocolImpl} which implements the POP3 Protocol
- *
*/
public class POP3Protocol extends ProtocolImpl {
diff --git a/protocols/pop3/src/main/java/org/apache/james/protocols/pop3/POP3ProtocolHandlerChain.java b/protocols/pop3/src/main/java/org/apache/james/protocols/pop3/POP3ProtocolHandlerChain.java
index d7e57c0..fc25553 100644
--- a/protocols/pop3/src/main/java/org/apache/james/protocols/pop3/POP3ProtocolHandlerChain.java
+++ b/protocols/pop3/src/main/java/org/apache/james/protocols/pop3/POP3ProtocolHandlerChain.java
@@ -58,9 +58,6 @@ public class POP3ProtocolHandlerChain extends ProtocolHandlerChainImpl {
/**
* The {@link AbstractPassCmdHandler}'s to use. If at least one {@link AbstractPassCmdHandler} is given, the {@link POP3ProtocolHandlerChain}
* will add all default handlers
- *
- * @param authHandlers
- * @throws WiringException
*/
public POP3ProtocolHandlerChain(AbstractPassCmdHandler... authHandlers) throws WiringException {
if (authHandlers != null && authHandlers.length > 0) {
diff --git a/protocols/pop3/src/main/java/org/apache/james/protocols/pop3/POP3Response.java b/protocols/pop3/src/main/java/org/apache/james/protocols/pop3/POP3Response.java
index 451161d..d4e73b2 100644
--- a/protocols/pop3/src/main/java/org/apache/james/protocols/pop3/POP3Response.java
+++ b/protocols/pop3/src/main/java/org/apache/james/protocols/pop3/POP3Response.java
@@ -80,8 +80,6 @@ public class POP3Response extends AbstractResponse {
/**
* Return a List of all responseLines stored in this POP3Response
- *
- * @return all responseLines
*/
@Override
public List<CharSequence> getLines() {
diff --git a/protocols/pop3/src/main/java/org/apache/james/protocols/pop3/POP3StartTlsResponse.java b/protocols/pop3/src/main/java/org/apache/james/protocols/pop3/POP3StartTlsResponse.java
index 1c98cd0..cf5f65f 100644
--- a/protocols/pop3/src/main/java/org/apache/james/protocols/pop3/POP3StartTlsResponse.java
+++ b/protocols/pop3/src/main/java/org/apache/james/protocols/pop3/POP3StartTlsResponse.java
@@ -26,8 +26,6 @@ import org.apache.james.protocols.api.StartTlsResponse;
/**
* Special sub-type of {@link POP3Response} which will trigger the start of TLS after the response was written to the client
- *
- *
*/
public class POP3StartTlsResponse extends POP3Response implements StartTlsResponse {
diff --git a/protocols/pop3/src/main/java/org/apache/james/protocols/pop3/POP3StreamResponse.java b/protocols/pop3/src/main/java/org/apache/james/protocols/pop3/POP3StreamResponse.java
index 28745a2..e57dc01 100644
--- a/protocols/pop3/src/main/java/org/apache/james/protocols/pop3/POP3StreamResponse.java
+++ b/protocols/pop3/src/main/java/org/apache/james/protocols/pop3/POP3StreamResponse.java
@@ -28,7 +28,6 @@ import org.apache.james.protocols.api.StreamResponse;
/**
* {@link StreamResponse} implementation which allows to write back big-data to the client for POP3
- *
*/
public class POP3StreamResponse extends POP3Response implements StreamResponse {
diff --git a/protocols/pop3/src/main/java/org/apache/james/protocols/pop3/core/AbstractApopCmdHandler.java b/protocols/pop3/src/main/java/org/apache/james/protocols/pop3/core/AbstractApopCmdHandler.java
index 50665aa..990562c 100644
--- a/protocols/pop3/src/main/java/org/apache/james/protocols/pop3/core/AbstractApopCmdHandler.java
+++ b/protocols/pop3/src/main/java/org/apache/james/protocols/pop3/core/AbstractApopCmdHandler.java
@@ -85,13 +85,8 @@ public abstract class AbstractApopCmdHandler extends AbstractPassCmdHandler {
/**
* Authenticate a {@link POP3Session} and returns the {@link Mailbox} for it. If it can not get authenticated it will return <code>null</code>.
- *
- * @param session
- * @param apopTimestamp
- * @param user
- * @param digest
+ *
* @return mailbox
- * @throws Exception
*/
protected abstract Mailbox auth(POP3Session session, String apopTimestamp, String user, String digest) throws Exception;
}
diff --git a/protocols/pop3/src/main/java/org/apache/james/protocols/pop3/core/AbstractPassCmdHandler.java b/protocols/pop3/src/main/java/org/apache/james/protocols/pop3/core/AbstractPassCmdHandler.java
index e099700..915b455 100644
--- a/protocols/pop3/src/main/java/org/apache/james/protocols/pop3/core/AbstractPassCmdHandler.java
+++ b/protocols/pop3/src/main/java/org/apache/james/protocols/pop3/core/AbstractPassCmdHandler.java
@@ -58,11 +58,6 @@ public abstract class AbstractPassCmdHandler extends RsetCmdHandler {
/**
* Authenticate a user and return the {@link Response}
- *
- * @param session
- * @param user
- * @param pass
- * @return response
*/
protected final Response doAuth(POP3Session session, String user, String pass) {
try {
@@ -94,13 +89,10 @@ public abstract class AbstractPassCmdHandler extends RsetCmdHandler {
}
/**
- * Authenticate a {@link POP3Session} and returns the {@link Mailbox} for it. If it can not get authenticated it will return <code>null</code>.
- *
- * @param session
- * @param user
- * @param password
+ * Authenticate a {@link POP3Session} and returns the {@link Mailbox} for it. If it can not get authenticated it
+ * will return <code>null</code>.
+ *
* @return mailbox
- *
*/
protected abstract Mailbox auth(POP3Session session, String username, String password) throws Exception;
}
diff --git a/protocols/pop3/src/main/java/org/apache/james/protocols/pop3/core/CapaCapability.java b/protocols/pop3/src/main/java/org/apache/james/protocols/pop3/core/CapaCapability.java
index 5035182..725b506 100644
--- a/protocols/pop3/src/main/java/org/apache/james/protocols/pop3/core/CapaCapability.java
+++ b/protocols/pop3/src/main/java/org/apache/james/protocols/pop3/core/CapaCapability.java
@@ -23,7 +23,6 @@ import java.util.Set;
import org.apache.james.protocols.pop3.POP3Session;
-
/**
* A handler which support the POP3 Extension Mechanism should implement this
* interface
@@ -33,9 +32,6 @@ public interface CapaCapability {
/**
* Return a List of responses which should get returned when a client issue
* the CAPA command
- *
- * @param session
- * @return list
*/
Set<String> getImplementedCapabilities(POP3Session session);
}
diff --git a/protocols/pop3/src/main/java/org/apache/james/protocols/pop3/core/MessageMetaDataUtils.java b/protocols/pop3/src/main/java/org/apache/james/protocols/pop3/core/MessageMetaDataUtils.java
index 9680eaa..477f5cf 100644
--- a/protocols/pop3/src/main/java/org/apache/james/protocols/pop3/core/MessageMetaDataUtils.java
+++ b/protocols/pop3/src/main/java/org/apache/james/protocols/pop3/core/MessageMetaDataUtils.java
@@ -31,10 +31,6 @@ public class MessageMetaDataUtils {
/**
* Returns the {@link MessageMetaData} for the given message number or <code>null</code> if it can not be
* found.
- *
- * @param session
- * @param number
- * @return data
*/
public static MessageMetaData getMetaData(POP3Session session, int number) {
@SuppressWarnings("unchecked")
@@ -48,9 +44,6 @@ public class MessageMetaDataUtils {
/**
* Check whether POP3 UID is compatible with RFC1939
- *
- * @param uid
- * @return
*/
public static boolean isRFC1939Compatible(String uid) {
if (uid == null) {
diff --git a/protocols/pop3/src/main/java/org/apache/james/protocols/pop3/mailbox/AbstractMailbox.java b/protocols/pop3/src/main/java/org/apache/james/protocols/pop3/mailbox/AbstractMailbox.java
index 5e5b6ee..5b4bd5a 100644
--- a/protocols/pop3/src/main/java/org/apache/james/protocols/pop3/mailbox/AbstractMailbox.java
+++ b/protocols/pop3/src/main/java/org/apache/james/protocols/pop3/mailbox/AbstractMailbox.java
@@ -25,9 +25,8 @@ import java.io.InputStream;
import org.apache.james.protocols.api.CombinedInputStream;
/**
- * A {@link Mailbox} implementation which use a {@link CombinedInputStream} over {@link #getMessageHeaders(long)} and {@link #getMessageBody(long)} to return the full message.
- *
- *
+ * A {@link Mailbox} implementation which use a {@link CombinedInputStream} over {@link #getMessageHeaders(String)} (long)}
+ * and {@link #getMessageBody(String)} (long)} to return the full message.
*/
public abstract class AbstractMailbox implements Mailbox {
diff --git a/protocols/pop3/src/main/java/org/apache/james/protocols/pop3/mailbox/ImapMailbox.java b/protocols/pop3/src/main/java/org/apache/james/protocols/pop3/mailbox/ImapMailbox.java
index 05af522..2c46dcd 100644
--- a/protocols/pop3/src/main/java/org/apache/james/protocols/pop3/mailbox/ImapMailbox.java
+++ b/protocols/pop3/src/main/java/org/apache/james/protocols/pop3/mailbox/ImapMailbox.java
@@ -24,8 +24,6 @@ import java.util.Arrays;
/**
* An IMAP Mailbox adapter which is used in POP3 to retrieve messages
- *
- *
*/
@Deprecated
public abstract class ImapMailbox implements Mailbox {
@@ -33,10 +31,6 @@ public abstract class ImapMailbox implements Mailbox {
/**
* Returns the message body as {@link InputStream} or <code>null</code> if
* no message can be found for the given <code>uid</code>
- *
- * @param uid
- * @return body
- * @throws IOException
*/
public abstract InputStream getMessageBody(long uid) throws IOException;
@@ -48,10 +42,6 @@ public abstract class ImapMailbox implements Mailbox {
/**
* Returns the message headers as {@link InputStream} or <code>null</code>
* if no message can be found for the given <code>uid</code>
- *
- * @param uid
- * @return headers
- * @throws IOException
*/
public abstract InputStream getMessageHeaders(long uid) throws IOException;
@@ -64,10 +54,6 @@ public abstract class ImapMailbox implements Mailbox {
* Return the full message (headers + body) as {@link InputStream} or
* <code>null</code> if no message can be found for the given
* <code>uid</code>
- *
- * @param uid
- * @return message
- * @throws IOException
*/
public abstract InputStream getMessage(long uid) throws IOException;
@@ -78,8 +64,6 @@ public abstract class ImapMailbox implements Mailbox {
/**
* Remove the messages with the given uids
- *
- * @param uids
*/
public abstract void remove(long... uids) throws IOException;
diff --git a/protocols/pop3/src/main/java/org/apache/james/protocols/pop3/mailbox/Mailbox.java b/protocols/pop3/src/main/java/org/apache/james/protocols/pop3/mailbox/Mailbox.java
index ee96d5c..ec3b5ef 100644
--- a/protocols/pop3/src/main/java/org/apache/james/protocols/pop3/mailbox/Mailbox.java
+++ b/protocols/pop3/src/main/java/org/apache/james/protocols/pop3/mailbox/Mailbox.java
@@ -24,28 +24,18 @@ import java.util.List;
/**
* A Mailbox which is used in POP3 to retrieve messages
- *
- *
*/
public interface Mailbox {
/**
* Returns the message body as {@link InputStream} or <code>null</code> if
* no message can be found for the given <code>uid</code>
- *
- * @param uid
- * @return body
- * @throws IOException
*/
InputStream getMessageBody(String uid) throws IOException;
/**
* Returns the message headers as {@link InputStream} or <code>null</code>
* if no message can be found for the given <code>uid</code>
- *
- * @param uid
- * @return headers
- * @throws IOException
*/
InputStream getMessageHeaders(String uid) throws IOException;
@@ -53,42 +43,28 @@ public interface Mailbox {
* Return the full message (headers + body) as {@link InputStream} or
* <code>null</code> if no message can be found for the given
* <code>uid</code>
- *
- * @param uid
- * @return message
- * @throws IOException
*/
InputStream getMessage(String uid) throws IOException;
/**
* Return a immutable {@link List} which holds the {@link MessageMetaData}
* for all messages in the {@link Mailbox}
- *
- * @return messages
- * @throws IOException
*/
List<MessageMetaData> getMessages() throws IOException;
/**
* Remove the messages with the given uids
- *
- * @param uids
*/
void remove(String... uids) throws IOException;
/**
* Return the identifier for the mailbox. This MUST not change
- *
- * @return identifer
- * @throws IOException
*/
String getIdentifier() throws IOException;
/**
* Close the mailbox, Any futher attempt to access or change the
* {@link Mailbox}'s content will fail
- *
- * @throws IOException
*/
void close() throws IOException;
diff --git a/protocols/pop3/src/main/java/org/apache/james/protocols/pop3/mailbox/MessageMetaData.java b/protocols/pop3/src/main/java/org/apache/james/protocols/pop3/mailbox/MessageMetaData.java
index c087373..ab4ad90 100644
--- a/protocols/pop3/src/main/java/org/apache/james/protocols/pop3/mailbox/MessageMetaData.java
+++ b/protocols/pop3/src/main/java/org/apache/james/protocols/pop3/mailbox/MessageMetaData.java
@@ -39,8 +39,6 @@ public class MessageMetaData {
/**
* Return the uid of the message
- *
- * @return uid
*/
public String getUid() {
return uid;
@@ -49,10 +47,6 @@ public class MessageMetaData {
/**
* Return the uid of the message. This method uses extra Mailbox ID argument to make
* UID unique when it is not globally unique. By default assuming UID globally unique.
- *
- * @param mailboxId
- * Mailbox ID
- * @return
*/
public String getUid(String mailboxId) {
return uid;
@@ -60,8 +54,6 @@ public class MessageMetaData {
/**
* Return the size of a message
- *
- * @return size
*/
public long getSize() {
return size;
---------------------------------------------------------------------
To unsubscribe, e-mail: server-dev-unsubscribe@james.apache.org
For additional commands, e-mail: server-dev-help@james.apache.org