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:14 UTC
[james-project] 27/36: [REFACTORING] Clean protocols-imap 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 d46ec94b34e7afbafcdc2f6bbf6e8487f4cd1cbf
Author: Benoit Tellier <bt...@linagora.com>
AuthorDate: Thu Nov 7 11:46:49 2019 +0700
[REFACTORING] Clean protocols-imap javadoc
- Solve IntellijJ warnings related to javaDoc
- Remove verbose, meaningless entries
---
.../org/apache/james/imap/api/display/CharsetUtil.java | 10 +++-------
.../java/org/apache/james/imap/api/message/IdRange.java | 11 ++---------
.../org/apache/james/imap/api/process/ImapSession.java | 7 -------
.../org/apache/james/imap/api/process/SearchResUtil.java | 9 ---------
.../apache/james/imap/api/process/SelectedMailbox.java | 11 -----------
.../apache/james/imap/decode/ImapRequestLineReader.java | 16 ++--------------
.../decode/parser/AbstractSelectionCommandParser.java | 10 ----------
.../james/imap/decode/parser/FetchCommandParser.java | 4 +---
.../james/imap/decode/parser/GetACLCommandParser.java | 1 -
.../apache/james/imap/encode/ImapResponseComposer.java | 14 ++------------
.../org/apache/james/imap/encode/ImapResponseWriter.java | 2 --
.../imap/encode/base/AbstractChainedImapEncoder.java | 5 -----
.../org/apache/james/imap/message/response/Literal.java | 2 --
.../james/imap/processor/AbstractMailboxProcessor.java | 4 ----
.../james/imap/processor/AuthenticateProcessor.java | 8 --------
.../imap/processor/CapabilityImplementingProcessor.java | 3 +--
.../org/apache/james/imap/processor/EnableProcessor.java | 5 -----
.../org/apache/james/imap/processor/GetACLProcessor.java | 1 -
.../org/apache/james/imap/processor/ListProcessor.java | 7 -------
.../imap/processor/PermitEnableCapabilityProcessor.java | 14 --------------
.../org/apache/james/imap/processor/SetACLProcessor.java | 1 -
.../org/apache/james/protocols/imap/IMAPRequest.java | 4 ----
.../apache/james/protocols/imap/utils/DecoderUtils.java | 5 +----
23 files changed, 12 insertions(+), 142 deletions(-)
diff --git a/protocols/imap/src/main/java/org/apache/james/imap/api/display/CharsetUtil.java b/protocols/imap/src/main/java/org/apache/james/imap/api/display/CharsetUtil.java
index bdb32db..b8ec77c 100644
--- a/protocols/imap/src/main/java/org/apache/james/imap/api/display/CharsetUtil.java
+++ b/protocols/imap/src/main/java/org/apache/james/imap/api/display/CharsetUtil.java
@@ -29,9 +29,7 @@ import com.beetstra.jutf7.CharsetProvider;
/**
* Utility class which can be used to get a list of supported {@link Charset}'s
*
- * Beside this it has some methods included which helps to encode/decode modified UTF7
- *
- *
+ * Beside this it has some methods included which helps to encode/decode modified UTF7
*/
public class CharsetUtil {
@@ -78,8 +76,7 @@ public class CharsetUtil {
/**
* Decode the given UTF7 encoded <code>String</code>
- *
- * @param string
+ *
* @return decoded
*/
public static String decodeModifiedUTF7(String string) {
@@ -91,8 +88,7 @@ public class CharsetUtil {
/**
* Encode the given <code>String</code> to modified UTF7.
* See RFC3501 for more details
- *
- * @param string
+ *
* @return encoded
*/
diff --git a/protocols/imap/src/main/java/org/apache/james/imap/api/message/IdRange.java b/protocols/imap/src/main/java/org/apache/james/imap/api/message/IdRange.java
index 69f6d86..0fbf92b 100644
--- a/protocols/imap/src/main/java/org/apache/james/imap/api/message/IdRange.java
+++ b/protocols/imap/src/main/java/org/apache/james/imap/api/message/IdRange.java
@@ -80,9 +80,7 @@ public final class IdRange implements Iterable<Long>, Comparable<IdRange> {
/**
* Return true if the {@link IdRange} includes the given value
- *
- * @param value
- * @return include
+ *
*/
public boolean includes(long value) {
return lowVal <= value && value <= highVal;
@@ -138,9 +136,7 @@ public final class IdRange implements Iterable<Long>, Comparable<IdRange> {
/**
* Utility method which will copy the given {@link List} and try to merge
* the {@link IdRange} in the copy before return it.
- *
- *
- * @param ranges
+ *
* @return mergedRanges
*/
public static List<IdRange> mergeRanges(List<IdRange> ranges) {
@@ -180,8 +176,6 @@ public final class IdRange implements Iterable<Long>, Comparable<IdRange> {
/**
* Return a read-only {@link Iterator} which contains all msn/uid which fail in the specified range.
- *
- * @return rangeIt
*/
@Override
public Iterator<Long> iterator() {
@@ -195,7 +189,6 @@ public final class IdRange implements Iterable<Long>, Comparable<IdRange> {
/**
* {@link Iterator} of a range of msn/uid
- *
*/
private final class RangeIterator implements Iterator<Long> {
diff --git a/protocols/imap/src/main/java/org/apache/james/imap/api/process/ImapSession.java b/protocols/imap/src/main/java/org/apache/james/imap/api/process/ImapSession.java
index 8128285..9bbf27a 100644
--- a/protocols/imap/src/main/java/org/apache/james/imap/api/process/ImapSession.java
+++ b/protocols/imap/src/main/java/org/apache/james/imap/api/process/ImapSession.java
@@ -139,29 +139,22 @@ public interface ImapSession {
/**
* Push in a new {@link ImapLineHandler} which is called for the next line received
- *
- * @param lineHandler
*/
void pushLineHandler(ImapLineHandler lineHandler);
/**
* Pop the current {@link ImapLineHandler}
- *
*/
void popLineHandler();
/**
* Return true if multiple namespaces are supported
- *
- * @return multipleNamespaces
*/
boolean supportMultipleNamespaces();
/**
* Return true if the login / authentication via plain username / password is
* disallowed
- *
- * @return plainDisallowed
*/
boolean isPlainAuthDisallowed();
diff --git a/protocols/imap/src/main/java/org/apache/james/imap/api/process/SearchResUtil.java b/protocols/imap/src/main/java/org/apache/james/imap/api/process/SearchResUtil.java
index 9931322..4e9c522 100644
--- a/protocols/imap/src/main/java/org/apache/james/imap/api/process/SearchResUtil.java
+++ b/protocols/imap/src/main/java/org/apache/james/imap/api/process/SearchResUtil.java
@@ -25,7 +25,6 @@ import org.apache.james.imap.api.message.IdRange;
/**
* Utility class which is used to support the SEARCHRES extension
- *
*/
public class SearchResUtil {
@@ -34,9 +33,6 @@ public class SearchResUtil {
/**
* Return the saved sequence-set which you can refer to with $. This method will
* return a IdRange[0] If no sequence-set is saved
- *
- * @param session
- * @return sequenceSet
*/
public static IdRange[] getSavedSequenceSet(ImapSession session) {
Object obj = session.getAttribute(SEARCHRES_SAVED_SET);
@@ -49,9 +45,6 @@ public class SearchResUtil {
/**
* Save the given sequence-set which you can refer to later with $.
- *
- * @param session
- * @param ranges
*/
public static void saveSequenceSet(ImapSession session, IdRange[] ranges) {
session.setAttribute(SEARCHRES_SAVED_SET, IdRange.mergeRanges(Arrays.asList(ranges)).toArray(new IdRange[0]));
@@ -59,8 +52,6 @@ public class SearchResUtil {
/**
* Reset the saved sequence-set
- *
- * @param session
*/
public static void resetSavedSequenceSet(ImapSession session) {
session.setAttribute(SEARCHRES_SAVED_SET, null);
diff --git a/protocols/imap/src/main/java/org/apache/james/imap/api/process/SelectedMailbox.java b/protocols/imap/src/main/java/org/apache/james/imap/api/process/SelectedMailbox.java
index a0a1425..c16bdbc 100644
--- a/protocols/imap/src/main/java/org/apache/james/imap/api/process/SelectedMailbox.java
+++ b/protocols/imap/src/main/java/org/apache/james/imap/api/process/SelectedMailbox.java
@@ -73,22 +73,16 @@ public interface SelectedMailbox {
/**
* Return the count of all recent uids
- *
- * @return recentCount
*/
int recentCount();
/**
* Return the count of all existing uids
- *
- * @return existsCount
*/
long existsCount();
/**
* Return the path of the selected Mailbox
- *
- * @return path
*/
MailboxPath getPath() throws MailboxException;
@@ -128,9 +122,6 @@ public interface SelectedMailbox {
*/
boolean isRecentUidRemoved();
- /**
- *
- */
void resetRecentUidRemoved();
@@ -178,8 +169,6 @@ public interface SelectedMailbox {
/**
* Return all applicable Flags for the selected mailbox
- *
- * @return flags
*/
Flags getApplicableFlags();
diff --git a/protocols/imap/src/main/java/org/apache/james/imap/decode/ImapRequestLineReader.java b/protocols/imap/src/main/java/org/apache/james/imap/decode/ImapRequestLineReader.java
index 1006bc7..121ec3b 100644
--- a/protocols/imap/src/main/java/org/apache/james/imap/decode/ImapRequestLineReader.java
+++ b/protocols/imap/src/main/java/org/apache/james/imap/decode/ImapRequestLineReader.java
@@ -173,8 +173,6 @@ public abstract class ImapRequestLineReader {
/**
* Consume the rest of the line
- *
- * @throws DecodingException
*/
public void consumeLine() throws DecodingException {
char next = nextChar();
@@ -265,9 +263,6 @@ public abstract class ImapRequestLineReader {
* as an astring.
*
* Be aware that mailbox names are encoded via a modified UTF7. For more information RFC3501
- *
- *
- *
*/
public String mailboxUTF7() throws DecodingException {
String mailbox = astring();
@@ -282,7 +277,6 @@ public abstract class ImapRequestLineReader {
* Reads one <code>date</code> argument from the request.
*
* @return <code>DayMonthYear</code>, not null
- * @throws DecodingException
*/
public DayMonthYear date() throws DecodingException {
@@ -443,9 +437,6 @@ public abstract class ImapRequestLineReader {
/**
* Consumes a CRLF from the request. TODO: This is too liberal, the spec
* insists on \r\n for new lines.
- *
- * @param request
- * @throws DecodingException
*/
private void consumeCRLF() throws DecodingException {
char next = nextChar();
@@ -528,10 +519,9 @@ public abstract class ImapRequestLineReader {
}
/**
- * Calls {@link #number()} with argument of false
+ * Calls {@link #number(boolean)} with argument of false
*
* @return number
- * @throws DecodingException
*/
public long number() throws DecodingException {
return number(false);
@@ -723,10 +713,8 @@ public abstract class ImapRequestLineReader {
/**
* Parse a range which use a ":" as delimiter
- *
- * @param range
+ *
* @return idRange
- * @throws DecodingException
*/
private IdRange parseRange(String range) throws DecodingException {
int pos = range.indexOf(':');
diff --git a/protocols/imap/src/main/java/org/apache/james/imap/decode/parser/AbstractSelectionCommandParser.java b/protocols/imap/src/main/java/org/apache/james/imap/decode/parser/AbstractSelectionCommandParser.java
index fb773be..d83a855 100644
--- a/protocols/imap/src/main/java/org/apache/james/imap/decode/parser/AbstractSelectionCommandParser.java
+++ b/protocols/imap/src/main/java/org/apache/james/imap/decode/parser/AbstractSelectionCommandParser.java
@@ -163,11 +163,6 @@ public abstract class AbstractSelectionCommandParser extends AbstractImapCommand
* ;; set of UIDs corresponding to the messages in
* ;; known-sequence-set, in ascending order.
* ;; * is not allowed.
- *
- *
- * @param ranges
- * @param checkOrder
- * @throws DecodingException
*/
private void checkIdRanges(IdRange[] ranges, boolean checkOrder) throws DecodingException {
long last = 0;
@@ -205,11 +200,6 @@ public abstract class AbstractSelectionCommandParser extends AbstractImapCommand
* ;; set of UIDs corresponding to the messages in
* ;; known-sequence-set, in ascending order.
* ;; * is not allowed.
- *
- *
- * @param ranges
- * @param checkOrder
- * @throws DecodingException
*/
private void checkUidRanges(UidRange[] ranges, boolean checkOrder) throws DecodingException {
MessageUid last = MessageUid.MIN_VALUE;
diff --git a/protocols/imap/src/main/java/org/apache/james/imap/decode/parser/FetchCommandParser.java b/protocols/imap/src/main/java/org/apache/james/imap/decode/parser/FetchCommandParser.java
index d87a58c..a061d7f 100644
--- a/protocols/imap/src/main/java/org/apache/james/imap/decode/parser/FetchCommandParser.java
+++ b/protocols/imap/src/main/java/org/apache/james/imap/decode/parser/FetchCommandParser.java
@@ -48,10 +48,8 @@ public class FetchCommandParser extends AbstractUidCommandParser {
/**
* Create a {@link FetchData} by reading from the
* {@link ImapRequestLineReader}
- *
- * @param request
+ *
* @return fetchData
- * @throws DecodingException
*/
protected FetchData fetchRequest(ImapRequestLineReader request) throws DecodingException {
FetchData fetch = new FetchData();
diff --git a/protocols/imap/src/main/java/org/apache/james/imap/decode/parser/GetACLCommandParser.java b/protocols/imap/src/main/java/org/apache/james/imap/decode/parser/GetACLCommandParser.java
index da3dc0c..7f6b168 100644
--- a/protocols/imap/src/main/java/org/apache/james/imap/decode/parser/GetACLCommandParser.java
+++ b/protocols/imap/src/main/java/org/apache/james/imap/decode/parser/GetACLCommandParser.java
@@ -30,7 +30,6 @@ import org.apache.james.protocols.imap.DecodingException;
/**
* GETACL Parser
- *
*/
public class GetACLCommandParser extends AbstractImapCommandParser {
diff --git a/protocols/imap/src/main/java/org/apache/james/imap/encode/ImapResponseComposer.java b/protocols/imap/src/main/java/org/apache/james/imap/encode/ImapResponseComposer.java
index d40a8cd..6df18b2 100644
--- a/protocols/imap/src/main/java/org/apache/james/imap/encode/ImapResponseComposer.java
+++ b/protocols/imap/src/main/java/org/apache/james/imap/encode/ImapResponseComposer.java
@@ -52,19 +52,15 @@ public interface ImapResponseComposer {
/**
* Composes a <code>NIL</code>.
- *
- * @throws IOException
*/
ImapResponseComposer nil() throws IOException;
/**
* Compose a response which contains the {@link ImapCommand} to which the
* response belongs
- *
- * @param command
+ *
* @param message
* @return self
- * @throws IOException
*/
ImapResponseComposer commandResponse(ImapCommand command, String message) throws IOException;
@@ -90,24 +86,18 @@ public interface ImapResponseComposer {
* Write a '*'
*
* @return composer
- * @throws IOException
*/
ImapResponseComposer untagged() throws IOException;
/**
- *
- * @param name
* @return composer
- * @throws IOException
*/
ImapResponseComposer commandName(String name) throws IOException;
/**
* Write the message of type <code>String</code>
- *
- * @param message
+ *
* @return composer
- * @throws IOException
*/
ImapResponseComposer message(String message) throws IOException;
diff --git a/protocols/imap/src/main/java/org/apache/james/imap/encode/ImapResponseWriter.java b/protocols/imap/src/main/java/org/apache/james/imap/encode/ImapResponseWriter.java
index 35bfaa0..d3bc42f 100644
--- a/protocols/imap/src/main/java/org/apache/james/imap/encode/ImapResponseWriter.java
+++ b/protocols/imap/src/main/java/org/apache/james/imap/encode/ImapResponseWriter.java
@@ -38,7 +38,6 @@ public interface ImapResponseWriter {
*
* @param literal
* <code>Literal</code> to be written, not null
- * @throws IOException
*/
void write(Literal literal) throws IOException;
@@ -47,7 +46,6 @@ public interface ImapResponseWriter {
*
* @param buffer
* <code>byte array</code> to be written, not null
- * @throws IOException
*/
void write(byte[] buffer) throws IOException;
diff --git a/protocols/imap/src/main/java/org/apache/james/imap/encode/base/AbstractChainedImapEncoder.java b/protocols/imap/src/main/java/org/apache/james/imap/encode/base/AbstractChainedImapEncoder.java
index 65e750e..1c454c7 100644
--- a/protocols/imap/src/main/java/org/apache/james/imap/encode/base/AbstractChainedImapEncoder.java
+++ b/protocols/imap/src/main/java/org/apache/james/imap/encode/base/AbstractChainedImapEncoder.java
@@ -57,11 +57,6 @@ public abstract class AbstractChainedImapEncoder implements ImapEncoder {
/**
* Call next Encoder in the chain
- *
- * @param message
- * @param composer
- * @param session
- * @throws IOException
*/
protected void chainEncode(ImapMessage message, ImapResponseComposer composer, ImapSession session) throws IOException {
next.encode(message, composer, session);
diff --git a/protocols/imap/src/main/java/org/apache/james/imap/message/response/Literal.java b/protocols/imap/src/main/java/org/apache/james/imap/message/response/Literal.java
index fe59629..6b95df9 100644
--- a/protocols/imap/src/main/java/org/apache/james/imap/message/response/Literal.java
+++ b/protocols/imap/src/main/java/org/apache/james/imap/message/response/Literal.java
@@ -28,7 +28,6 @@ public interface Literal {
*
* @return number of octets which will be
* put onto the channel
- * @throws IOException
*/
long size() throws IOException;
@@ -37,7 +36,6 @@ public interface Literal {
* Return the Literal as {@link InputStream}
*
* @return elementIn
- * @throws IOException
*/
InputStream getInputStream() throws IOException;
}
diff --git a/protocols/imap/src/main/java/org/apache/james/imap/processor/AbstractMailboxProcessor.java b/protocols/imap/src/main/java/org/apache/james/imap/processor/AbstractMailboxProcessor.java
index fcebc73..435f67a 100644
--- a/protocols/imap/src/main/java/org/apache/james/imap/processor/AbstractMailboxProcessor.java
+++ b/protocols/imap/src/main/java/org/apache/james/imap/processor/AbstractMailboxProcessor.java
@@ -373,9 +373,6 @@ public abstract class AbstractMailboxProcessor<M extends ImapRequest> extends Ab
/**
* Joins the elements of a mailboxPath together and returns them as a string
- *
- * @param mailboxPath
- * @return
*/
private String joinMailboxPath(MailboxPath mailboxPath, char delimiter) {
StringBuilder sb = new StringBuilder("");
@@ -513,7 +510,6 @@ public abstract class AbstractMailboxProcessor<M extends ImapRequest> extends Ab
* @param range
* input range
* @return normalized message range
- * @throws MessageRangeException
*/
protected MessageRange normalizeMessageRange(SelectedMailbox selected, MessageRange range) throws MessageRangeException {
Type rangeType = range.getType();
diff --git a/protocols/imap/src/main/java/org/apache/james/imap/processor/AuthenticateProcessor.java b/protocols/imap/src/main/java/org/apache/james/imap/processor/AuthenticateProcessor.java
index 3660f68..04cc360 100644
--- a/protocols/imap/src/main/java/org/apache/james/imap/processor/AuthenticateProcessor.java
+++ b/protocols/imap/src/main/java/org/apache/james/imap/processor/AuthenticateProcessor.java
@@ -44,8 +44,6 @@ import com.google.common.collect.ImmutableList;
/**
* Processor which handles the AUTHENTICATE command. Only authtype of PLAIN is supported ATM.
- *
- *
*/
public class AuthenticateProcessor extends AbstractAuthProcessor<AuthenticateRequest> implements CapabilityImplementingProcessor {
private static final Logger LOGGER = LoggerFactory.getLogger(AuthenticateProcessor.class);
@@ -88,12 +86,6 @@ public class AuthenticateProcessor extends AbstractAuthProcessor<AuthenticateReq
/**
* Parse the initialClientResponse and do a PLAIN AUTH with it
- *
- * @param initialClientResponse
- * @param session
- * @param tag
- * @param command
- * @param responder
*/
protected void doPlainAuth(String initialClientResponse, ImapSession session, String tag, ImapCommand command, Responder responder) {
AuthenticationAttempt authenticationAttempt = parseDelegationAttempt(initialClientResponse);
diff --git a/protocols/imap/src/main/java/org/apache/james/imap/processor/CapabilityImplementingProcessor.java b/protocols/imap/src/main/java/org/apache/james/imap/processor/CapabilityImplementingProcessor.java
index bfb63d9..042bf2f 100644
--- a/protocols/imap/src/main/java/org/apache/james/imap/processor/CapabilityImplementingProcessor.java
+++ b/protocols/imap/src/main/java/org/apache/james/imap/processor/CapabilityImplementingProcessor.java
@@ -31,8 +31,7 @@ public interface CapabilityImplementingProcessor extends ImapProcessor {
/**
* Return a list of all Capabilities that are implemented by the Processor
- *
- * @param session
+ *
* @return list not null
*/
List<String> getImplementedCapabilities(ImapSession session);
diff --git a/protocols/imap/src/main/java/org/apache/james/imap/processor/EnableProcessor.java b/protocols/imap/src/main/java/org/apache/james/imap/processor/EnableProcessor.java
index 76b8ac0..0a25ac3 100644
--- a/protocols/imap/src/main/java/org/apache/james/imap/processor/EnableProcessor.java
+++ b/protocols/imap/src/main/java/org/apache/james/imap/processor/EnableProcessor.java
@@ -103,8 +103,6 @@ public class EnableProcessor extends AbstractMailboxProcessor<EnableRequest> imp
/**
* Add a {@link PermitEnableCapabilityProcessor} which can be enabled
- *
- * @param implementor
*/
public void addProcessor(PermitEnableCapabilityProcessor implementor) {
capabilities.add(implementor);
@@ -112,9 +110,6 @@ public class EnableProcessor extends AbstractMailboxProcessor<EnableRequest> imp
/**
* Return all enabled <code>CAPABILITIES</code> for this {@link ImapSession}
- *
- * @param session
- * @return enabled
*/
@SuppressWarnings("unchecked")
public static Set<String> getEnabledCapabilities(ImapSession session) {
diff --git a/protocols/imap/src/main/java/org/apache/james/imap/processor/GetACLProcessor.java b/protocols/imap/src/main/java/org/apache/james/imap/processor/GetACLProcessor.java
index 2599dc7..988b383 100644
--- a/protocols/imap/src/main/java/org/apache/james/imap/processor/GetACLProcessor.java
+++ b/protocols/imap/src/main/java/org/apache/james/imap/processor/GetACLProcessor.java
@@ -50,7 +50,6 @@ import com.google.common.collect.ImmutableList;
/**
* GETACL Processor.
- *
*/
public class GetACLProcessor extends AbstractMailboxProcessor<GetACLRequest> implements CapabilityImplementingProcessor {
private static final Logger LOGGER = LoggerFactory.getLogger(GetACLProcessor.class);
diff --git a/protocols/imap/src/main/java/org/apache/james/imap/processor/ListProcessor.java b/protocols/imap/src/main/java/org/apache/james/imap/processor/ListProcessor.java
index e0569c1..f1972bd 100644
--- a/protocols/imap/src/main/java/org/apache/james/imap/processor/ListProcessor.java
+++ b/protocols/imap/src/main/java/org/apache/james/imap/processor/ListProcessor.java
@@ -81,13 +81,6 @@ public class ListProcessor extends AbstractMailboxProcessor<ListRequest> {
* the hierarchy delimiter and the root name of the name given in the
* reference. The value returned as the root MAY be the empty string if the
* reference is non-rooted or is an empty string.
- *
- * @param referenceName
- * @param mailboxName
- * @param session
- * @param tag
- * @param command
- * @param responder
*/
protected final void doProcess(String referenceName, String mailboxName, ImapSession session, String tag, ImapCommand command, Responder responder, MailboxTyper mailboxTyper) {
String user = ImapSessionUtils.getUserName(session);
diff --git a/protocols/imap/src/main/java/org/apache/james/imap/processor/PermitEnableCapabilityProcessor.java b/protocols/imap/src/main/java/org/apache/james/imap/processor/PermitEnableCapabilityProcessor.java
index 3c02fb4..52e6242 100644
--- a/protocols/imap/src/main/java/org/apache/james/imap/processor/PermitEnableCapabilityProcessor.java
+++ b/protocols/imap/src/main/java/org/apache/james/imap/processor/PermitEnableCapabilityProcessor.java
@@ -32,32 +32,18 @@ public interface PermitEnableCapabilityProcessor extends CapabilityImplementingP
* Return the capabilities which supports to get ENABLED.
*
* Be sure that these are also returned by {@link #getImplementedCapabilities(ImapSession)}
- *
- * @param session
- * @return permitCaps
*/
List<String> getPermitEnableCapabilities(ImapSession session);
/**
* Callback which is used when a ENABLED command was used to enable on of the CAPABILITIES which is managed by this implementation
- *
- * @param message
- * @param responder
- * @param session
- * @param capability
- * @throws EnableException
*/
void enable(ImapMessage message, Responder responder, ImapSession session, String capability) throws EnableException;
/**
* Exception which should get thrown if for whatever reason its not possible to enable a capability
- *
- *
*/
final class EnableException extends Exception {
- /**
- *
- */
private static final long serialVersionUID = -4456052968041000753L;
public EnableException(String msg, Throwable e) {
diff --git a/protocols/imap/src/main/java/org/apache/james/imap/processor/SetACLProcessor.java b/protocols/imap/src/main/java/org/apache/james/imap/processor/SetACLProcessor.java
index 841c61f..2ff8c9b 100644
--- a/protocols/imap/src/main/java/org/apache/james/imap/processor/SetACLProcessor.java
+++ b/protocols/imap/src/main/java/org/apache/james/imap/processor/SetACLProcessor.java
@@ -49,7 +49,6 @@ import org.slf4j.LoggerFactory;
/**
* SETACL Processor.
-
*/
public class SetACLProcessor extends AbstractMailboxProcessor<SetACLRequest> implements CapabilityImplementingProcessor {
private static final Logger LOGGER = LoggerFactory.getLogger(SetACLProcessor.class);
diff --git a/protocols/imap/src/main/java/org/apache/james/protocols/imap/IMAPRequest.java b/protocols/imap/src/main/java/org/apache/james/protocols/imap/IMAPRequest.java
index 85025a2..3d1de81 100644
--- a/protocols/imap/src/main/java/org/apache/james/protocols/imap/IMAPRequest.java
+++ b/protocols/imap/src/main/java/org/apache/james/protocols/imap/IMAPRequest.java
@@ -64,8 +64,6 @@ public class IMAPRequest implements Request {
/**
* Return the tag of the request
- *
- * @return tag
*/
public String getTag() {
return tag;
@@ -108,8 +106,6 @@ public class IMAPRequest implements Request {
/**
* Return an {@link Iterator} which holds all argument lines. The returned {@link ByteBuffer}'s will be
* rewind by calling {@link ByteBuffer#rewind()} before return them
- *
- * @return arguments
*/
public Iterator<ByteBuffer> getArguments() {
return new Iterator<ByteBuffer>() {
diff --git a/protocols/imap/src/main/java/org/apache/james/protocols/imap/utils/DecoderUtils.java b/protocols/imap/src/main/java/org/apache/james/protocols/imap/utils/DecoderUtils.java
index 00dbc21..e819816 100644
--- a/protocols/imap/src/main/java/org/apache/james/protocols/imap/utils/DecoderUtils.java
+++ b/protocols/imap/src/main/java/org/apache/james/protocols/imap/utils/DecoderUtils.java
@@ -228,7 +228,6 @@ public final class DecoderUtils {
* @param yearChar
* forth digit
* @return {@link Calendar} year
- * @throws DecodingException
*/
public static int decodeYear(char milleniumChar, char centuryChar, char decadeChar, char yearChar) throws DecodingException {
return (decodeDigit(milleniumChar) * 1000) + (decodeDigit(centuryChar) * 100) + (decodeDigit(decadeChar) * 10) + decodeDigit(yearChar);
@@ -244,7 +243,6 @@ public final class DecoderUtils {
* @param monthThirdChar
* third character in a month triple
* @return {@link Calendar} month (<code>JAN</code>=0)
- * @throws DecodingException
*/
public static int decodeMonth(char monthFirstChar, char monthSecondChar, char monthThirdChar) throws DecodingException {
final int result;
@@ -423,8 +421,7 @@ public final class DecoderUtils {
/**
* Decodes a number character into a <code>0-9</code> digit.
- *
- * @param character
+ *
* @return a digit
* @throws DecodingException
* if the char is not a digit
---------------------------------------------------------------------
To unsubscribe, e-mail: server-dev-unsubscribe@james.apache.org
For additional commands, e-mail: server-dev-help@james.apache.org