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/11 08:05:02 UTC
[james-project] 02/09: [Refactoring] Resolve most warnings for
mailbox-api 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 7ce29aae3a8b970d4717d17a21b1885a2655895c
Author: Benoit Tellier <bt...@linagora.com>
AuthorDate: Fri Nov 8 13:48:57 2019 +0700
[Refactoring] Resolve most warnings for mailbox-api javadoc
---
.../org/apache/james/mailbox/MailboxManager.java | 15 +-------------
.../apache/james/mailbox/MailboxPathLocker.java | 11 +----------
.../org/apache/james/mailbox/MailboxSession.java | 8 --------
.../james/mailbox/MailboxSessionIdGenerator.java | 4 ----
.../org/apache/james/mailbox/MessageManager.java | 9 +--------
.../org/apache/james/mailbox/RequestAware.java | 4 ----
.../james/mailbox/acl/GroupMembershipResolver.java | 4 ----
.../james/mailbox/acl/MailboxACLResolver.java | 10 +---------
.../mailbox/acl/SimpleGroupMembershipResolver.java | 2 --
.../james/mailbox/acl/UnionMailboxACLResolver.java | 23 ++--------------------
.../apache/james/mailbox/copier/MailboxCopier.java | 4 ----
.../exception/InsufficientRightsException.java | 5 -----
.../exception/MailboxNotFoundException.java | 4 ++--
.../exception/MailboxSecurityException.java | 5 -----
.../org/apache/james/mailbox/model/Content.java | 6 ------
.../org/apache/james/mailbox/model/Mailbox.java | 4 ----
.../org/apache/james/mailbox/model/MailboxACL.java | 17 ----------------
.../james/mailbox/model/MailboxConstants.java | 2 --
.../james/mailbox/model/MailboxMetaData.java | 4 ----
.../apache/james/mailbox/model/MailboxPath.java | 16 ++-------------
.../apache/james/mailbox/model/MessageRange.java | 2 +-
.../apache/james/mailbox/model/MessageResult.java | 10 ----------
.../james/mailbox/model/MessageResultIterator.java | 2 --
.../apache/james/mailbox/model/SearchQuery.java | 12 +----------
.../apache/james/mailbox/model/UpdatedFlags.java | 10 ----------
.../model/search/MailboxNameExpression.java | 3 ---
.../james/mailbox/model/search/MailboxQuery.java | 7 -------
.../apache/james/mailbox/quota/QuotaManager.java | 4 ----
.../james/mailbox/quota/QuotaRootResolver.java | 1 -
29 files changed, 12 insertions(+), 196 deletions(-)
diff --git a/mailbox/api/src/main/java/org/apache/james/mailbox/MailboxManager.java b/mailbox/api/src/main/java/org/apache/james/mailbox/MailboxManager.java
index 08f70d8..c298a8f 100644
--- a/mailbox/api/src/main/java/org/apache/james/mailbox/MailboxManager.java
+++ b/mailbox/api/src/main/java/org/apache/james/mailbox/MailboxManager.java
@@ -146,8 +146,7 @@ public interface MailboxManager extends RequestAware, RightManager, MailboxAnnot
/**
* Creates a new mailbox. Any intermediary mailboxes missing from the
* hierarchy should be created.
- *
- * @param mailboxPath
+ *
* @param mailboxSession
* the context for this call, not null
* @throws MailboxException
@@ -159,10 +158,6 @@ public interface MailboxManager extends RequestAware, RightManager, MailboxAnnot
/**
* Delete the mailbox with the name
- *
- * @param mailboxPath
- * @param session
- * @throws MailboxException
*/
void deleteMailbox(MailboxPath mailboxPath, MailboxSession session) throws MailboxException;
@@ -227,7 +222,6 @@ public interface MailboxManager extends RequestAware, RightManager, MailboxAnnot
* not null
* @param session
* the context for this call, not null
- * @throws MailboxException
*/
List<MailboxMetaData> search(MailboxQuery expression, MailboxSession session) throws MailboxException;
@@ -238,7 +232,6 @@ public interface MailboxManager extends RequestAware, RightManager, MailboxAnnot
* not null
* @param session
* the context for this call, not null
- * @throws MailboxException
*/
List<MessageId> search(MultimailboxesSearchQuery expression, MailboxSession session, long limit) throws MailboxException;
@@ -251,7 +244,6 @@ public interface MailboxManager extends RequestAware, RightManager, MailboxAnnot
* the context for this call, not null
* @return true when the mailbox exists and is accessible for the given
* user, false otherwise
- * @throws MailboxException
*/
boolean mailboxExists(MailboxPath mailboxPath, MailboxSession session) throws MailboxException;
@@ -262,7 +254,6 @@ public interface MailboxManager extends RequestAware, RightManager, MailboxAnnot
* the context for this call, not null
* @return true when the INBOX exists and is accessible for the given
* user, false otherwise
- * @throws MailboxException
*/
default boolean hasInbox(MailboxSession session) throws MailboxException {
return mailboxExists(MailboxPath.inbox(session), session);
@@ -349,10 +340,6 @@ public interface MailboxManager extends RequestAware, RightManager, MailboxAnnot
/**
* Return a unmodifiable {@link List} of {@link MailboxPath} objects
- *
- * @param session
- * @return pathList
- * @throws MailboxException
*/
List<MailboxPath> list(MailboxSession session) throws MailboxException;
diff --git a/mailbox/api/src/main/java/org/apache/james/mailbox/MailboxPathLocker.java b/mailbox/api/src/main/java/org/apache/james/mailbox/MailboxPathLocker.java
index d355793..ff68c76 100644
--- a/mailbox/api/src/main/java/org/apache/james/mailbox/MailboxPathLocker.java
+++ b/mailbox/api/src/main/java/org/apache/james/mailbox/MailboxPathLocker.java
@@ -42,14 +42,7 @@ public interface MailboxPathLocker {
/**
* Execute the {@link LockAwareExecution} while holding a lock on the
* {@link MailboxPath}. If writeLock is true the implementation need to make sure that no other threads can read and write while the lock
- * is hold. The contract is the same as documented in {@link ReadWriteLock}.
- *
- * @param session
- * @param path
- * @param execution
- * @param writeLock
- *
- * @throws MailboxException
+ * is hold. The contract is the same as documented in {@link ReadWriteLock}.
*/
<T> T executeWithLock(MailboxSession session, MailboxPath path, LockAwareExecution<T> execution, boolean writeLock) throws MailboxException;
@@ -60,8 +53,6 @@ public interface MailboxPathLocker {
/**
* Execute code block
- *
- * @throws MailboxException
*/
T execute() throws MailboxException;
}
diff --git a/mailbox/api/src/main/java/org/apache/james/mailbox/MailboxSession.java b/mailbox/api/src/main/java/org/apache/james/mailbox/MailboxSession.java
index e4302d7..79770c6 100644
--- a/mailbox/api/src/main/java/org/apache/james/mailbox/MailboxSession.java
+++ b/mailbox/api/src/main/java/org/apache/james/mailbox/MailboxSession.java
@@ -129,8 +129,6 @@ public class MailboxSession {
/**
* Return if the {@link MailboxSession} is of type {@link SessionType#User} or {@link SessionType#System}
- *
- * @return type
*/
public SessionType getType() {
return type;
@@ -138,8 +136,6 @@ public class MailboxSession {
/**
* Gets the session ID.
- *
- * @return session id
*/
public SessionId getSessionId() {
return sessionId;
@@ -220,8 +216,6 @@ public class MailboxSession {
/**
* Return the stored attributes for this {@link MailboxSession}.
- *
- * @return attributes
*/
public Map<Object, Object> getAttributes() {
return attributes;
@@ -229,8 +223,6 @@ public class MailboxSession {
/**
* Return server side, folder path separator
- *
- * @return path separator
*/
public char getPathDelimiter() {
return pathSeparator;
diff --git a/mailbox/api/src/main/java/org/apache/james/mailbox/MailboxSessionIdGenerator.java b/mailbox/api/src/main/java/org/apache/james/mailbox/MailboxSessionIdGenerator.java
index a87ea77..7e66733 100644
--- a/mailbox/api/src/main/java/org/apache/james/mailbox/MailboxSessionIdGenerator.java
+++ b/mailbox/api/src/main/java/org/apache/james/mailbox/MailboxSessionIdGenerator.java
@@ -22,8 +22,6 @@ package org.apache.james.mailbox;
/**
* Generator for id's which should used for new {@link MailboxSession} instances
- *
- *
*/
public interface MailboxSessionIdGenerator {
@@ -32,8 +30,6 @@ public interface MailboxSessionIdGenerator {
* while the server is running and can be any long except {@link MailboxSession#SYSTEM_SESSION_ID}.
*
* The returned ids can be in any specific order.
- *
- * @return id
*/
long nextId();
}
diff --git a/mailbox/api/src/main/java/org/apache/james/mailbox/MessageManager.java b/mailbox/api/src/main/java/org/apache/james/mailbox/MessageManager.java
index 29d17b0..73b967d 100644
--- a/mailbox/api/src/main/java/org/apache/james/mailbox/MessageManager.java
+++ b/mailbox/api/src/main/java/org/apache/james/mailbox/MessageManager.java
@@ -134,7 +134,6 @@ public interface MessageManager {
* @param set the range of messages
* @param mailboxSession not null
* @return new flags indexed by UID
- * @throws MailboxException
*/
Map<MessageUid, Flags> setFlags(Flags flags, FlagsUpdateMode flagsUpdateMode, MessageRange set, MailboxSession mailboxSession) throws MailboxException;
@@ -272,23 +271,17 @@ public interface MessageManager {
* the-hood in batches so the caller should check if
* {@link MessageResultIterator#getException()} returns <code>null</code>
* after {@link MessageResultIterator#hasNext()} returns <code>false</code>.
- *
- *
- * @param set
+ *
* @param fetchGroup
* data to fetch
* @param mailboxSession
* not null
* @return MessageResult with the fields defined by FetchGroup
- * @throws MailboxException
*/
MessageResultIterator getMessages(MessageRange set, FetchGroup fetchGroup, MailboxSession mailboxSession) throws MailboxException;
/**
* Return the underlying {@link Mailbox}
- *
- * @return mailbox
- * @throws MailboxException
*/
Mailbox getMailboxEntity() throws MailboxException;
diff --git a/mailbox/api/src/main/java/org/apache/james/mailbox/RequestAware.java b/mailbox/api/src/main/java/org/apache/james/mailbox/RequestAware.java
index 843060d..02ed694 100644
--- a/mailbox/api/src/main/java/org/apache/james/mailbox/RequestAware.java
+++ b/mailbox/api/src/main/java/org/apache/james/mailbox/RequestAware.java
@@ -26,16 +26,12 @@ public interface RequestAware {
/**
* Start the processing of a request for the given MailboxSession. If the
* user is not logged in already then the MailboxSession will be null
- *
- * @param session
*/
void startProcessingRequest(MailboxSession session);
/**
* End the processing of a request for the given MailboxSession. If the user
* is not logged in already then the MailboxSession will be null
- *
- * @param session
*/
void endProcessingRequest(MailboxSession session);
}
diff --git a/mailbox/api/src/main/java/org/apache/james/mailbox/acl/GroupMembershipResolver.java b/mailbox/api/src/main/java/org/apache/james/mailbox/acl/GroupMembershipResolver.java
index 6896a93..8f5a285 100644
--- a/mailbox/api/src/main/java/org/apache/james/mailbox/acl/GroupMembershipResolver.java
+++ b/mailbox/api/src/main/java/org/apache/james/mailbox/acl/GroupMembershipResolver.java
@@ -25,10 +25,6 @@ public interface GroupMembershipResolver {
/**
* Tests if the given user is a member of the given group.
- *
- * @param user
- * @param group
- * @return
*/
boolean isMember(String user, String group);
diff --git a/mailbox/api/src/main/java/org/apache/james/mailbox/acl/MailboxACLResolver.java b/mailbox/api/src/main/java/org/apache/james/mailbox/acl/MailboxACLResolver.java
index 76691b0..e913ba2 100644
--- a/mailbox/api/src/main/java/org/apache/james/mailbox/acl/MailboxACLResolver.java
+++ b/mailbox/api/src/main/java/org/apache/james/mailbox/acl/MailboxACLResolver.java
@@ -45,11 +45,6 @@ public interface MailboxACLResolver {
* Applies global ACL to the given <code>resourceACL</code>. From RFC 4314:
* An implementation [...] MAY force rights to always or never be granted to
* particular identifiers.
- *
- * @param resourceACL
- * @param resourceOwnerIsGroup
- * @return
- * @throws UnsupportedRightException
*/
MailboxACL applyGlobalACL(MailboxACL resourceACL, boolean resourceOwnerIsGroup) throws UnsupportedRightException;
@@ -61,18 +56,16 @@ public interface MailboxACLResolver {
*
* @param key
* the identifier from the LISTRIGHTS command
- * @param groupMembershipResolver
* @param resourceOwner
* the owner of the mailbox named in the LISTRIGHTS command. User
* name or group name.
* @param resourceOwnerIsGroup
* true if the {@code resourceOwner} is a group of users, false
* otherwise.
- * @return an array of {@link MailboxACLRights}. The first element is the
+ * @return an array of {@link MailboxACL.Rfc4314Rights}. The first element is the
* set of implicit (global) rights which does not need to be set
* explicitly for the given identifier. Further elements are groups
* of rights which can be set for the given identifier and resource.
- * @throws UnsupportedRightException
*/
MailboxACL.Rfc4314Rights[] listRights(MailboxACL.EntryKey key, GroupMembershipResolver groupMembershipResolver, String resourceOwner, boolean resourceOwnerIsGroup) throws UnsupportedRightException;
@@ -97,7 +90,6 @@ public interface MailboxACLResolver {
* true if the resourceOwner is a group of users, false
* otherwise.
* @return the rights applicable for the given user and resource.
- * @throws UnsupportedRightException
*/
MailboxACL.Rfc4314Rights resolveRights(String requestUser, GroupMembershipResolver groupMembershipResolver, MailboxACL resourceACL, String resourceOwner, boolean resourceOwnerIsGroup) throws UnsupportedRightException;
diff --git a/mailbox/api/src/main/java/org/apache/james/mailbox/acl/SimpleGroupMembershipResolver.java b/mailbox/api/src/main/java/org/apache/james/mailbox/acl/SimpleGroupMembershipResolver.java
index 79b2a57..95890bf 100644
--- a/mailbox/api/src/main/java/org/apache/james/mailbox/acl/SimpleGroupMembershipResolver.java
+++ b/mailbox/api/src/main/java/org/apache/james/mailbox/acl/SimpleGroupMembershipResolver.java
@@ -26,11 +26,9 @@ import java.util.Set;
import com.google.common.base.MoreObjects;
import com.google.common.base.Objects;
-
/**
* In memory {@link GroupMembershipResolver} implementation. There is no
* persistence. You will get only what you add.
- *
*/
public class SimpleGroupMembershipResolver implements GroupMembershipResolver {
diff --git a/mailbox/api/src/main/java/org/apache/james/mailbox/acl/UnionMailboxACLResolver.java b/mailbox/api/src/main/java/org/apache/james/mailbox/acl/UnionMailboxACLResolver.java
index 7e620f1..498686e 100644
--- a/mailbox/api/src/main/java/org/apache/james/mailbox/acl/UnionMailboxACLResolver.java
+++ b/mailbox/api/src/main/java/org/apache/james/mailbox/acl/UnionMailboxACLResolver.java
@@ -87,10 +87,8 @@ public class UnionMailboxACLResolver implements MailboxACLResolver {
/**
* Creates a new instance of UnionMailboxACLResolver with the given
* globalACL.
- *
- * @param groupGlobalACL
- *
- * @param globalACL
+ *
+ * @param userGlobalACL
* see {@link #userGlobalACL}, cannot be null.
* @throws NullPointerException
* when globalACL is null.
@@ -128,13 +126,6 @@ public class UnionMailboxACLResolver implements MailboxACLResolver {
* proper subset of the cases handled in (2). See the javadoc on
* {@link #listRights(EntryKey, GroupMembershipResolver, String, boolean)}
* for more details.
- *
- * @param aclKey
- * @param queryKey
- * @param groupMembershipResolver
- * @param resourceOwner
- * @param resourceOwnerIsGroup
- * @return
*/
protected static boolean applies(EntryKey aclKey, EntryKey queryKey, GroupMembershipResolver groupMembershipResolver, String resourceOwner, boolean resourceOwnerIsGroup) {
final String aclKeyName = aclKey.getName();
@@ -272,8 +263,6 @@ public class UnionMailboxACLResolver implements MailboxACLResolver {
* performed only either with user == null (only "anybody" rights will
* apply) or with a user name which is there only after the user was
* authenticated.
- *
- * @see org.apache.james.mailbox.acl.MailboxACLResolver#listRightsDefault(boolean)
*/
@Override
public Rfc4314Rights[] listRights(EntryKey queryKey, GroupMembershipResolver groupMembershipResolver, String resourceOwner, boolean resourceOwnerIsGroup) throws UnsupportedRightException {
@@ -316,14 +305,6 @@ public class UnionMailboxACLResolver implements MailboxACLResolver {
/**
* What needs to be done for both global ACL and the given mailboxe's ACL.
- *
- * @param requestUser
- * @param groupMembershipResolver
- * @param entries
- * @param resourceOwner
- * @param resourceOwnerIsGroup
- * @param positiveNegativePair
- * @throws UnsupportedRightException
*/
private void resolveRights(EntryKey queryKey, GroupMembershipResolver groupMembershipResolver, Map<EntryKey, Rfc4314Rights> entries, String resourceOwner, boolean resourceOwnerIsGroup, Rfc4314Rights[] positiveNegativePair)
throws UnsupportedRightException {
diff --git a/mailbox/api/src/main/java/org/apache/james/mailbox/copier/MailboxCopier.java b/mailbox/api/src/main/java/org/apache/james/mailbox/copier/MailboxCopier.java
index 1cd5e6b..5cc7893 100644
--- a/mailbox/api/src/main/java/org/apache/james/mailbox/copier/MailboxCopier.java
+++ b/mailbox/api/src/main/java/org/apache/james/mailbox/copier/MailboxCopier.java
@@ -26,7 +26,6 @@ import org.apache.james.mailbox.exception.MailboxException;
/**
* Interface that exposes a method aimed to copy all mailboxes from a source
* mailbox manager to a destination mailbox manager.
- *
*/
public interface MailboxCopier {
@@ -34,9 +33,6 @@ public interface MailboxCopier {
* Copy the mailboxes from a mailbox manager to another mailbox manager. The
* implementation is responsible to read all mailboxes form the injected
* srcMailboxManager and to copy all its contents to the dstMailboxManager.
- *
- * @param src
- * @param dest
*/
void copyMailboxes(MailboxManager src, MailboxManager dest) throws MailboxException, IOException;
diff --git a/mailbox/api/src/main/java/org/apache/james/mailbox/exception/InsufficientRightsException.java b/mailbox/api/src/main/java/org/apache/james/mailbox/exception/InsufficientRightsException.java
index ebb2429..ae8a644 100644
--- a/mailbox/api/src/main/java/org/apache/james/mailbox/exception/InsufficientRightsException.java
+++ b/mailbox/api/src/main/java/org/apache/james/mailbox/exception/InsufficientRightsException.java
@@ -24,13 +24,8 @@ package org.apache.james.mailbox.exception;
/**
* Thrown when the rights granted to the given authenticated user do not suffice
* for the given action.
- *
*/
public class InsufficientRightsException extends MailboxSecurityException {
-
- /**
- *
- */
private static final long serialVersionUID = 7310501567640913596L;
public InsufficientRightsException() {
diff --git a/mailbox/api/src/main/java/org/apache/james/mailbox/exception/MailboxNotFoundException.java b/mailbox/api/src/main/java/org/apache/james/mailbox/exception/MailboxNotFoundException.java
index 9c96733..264d8f1 100644
--- a/mailbox/api/src/main/java/org/apache/james/mailbox/exception/MailboxNotFoundException.java
+++ b/mailbox/api/src/main/java/org/apache/james/mailbox/exception/MailboxNotFoundException.java
@@ -31,8 +31,8 @@ public class MailboxNotFoundException extends MailboxException {
private static final long serialVersionUID = -8493370806722264915L;
/**
- * @param mailboxName
- * name of the mailbox, not null
+ * @param message
+ * message, not null
*/
public MailboxNotFoundException(String message) {
super(message);
diff --git a/mailbox/api/src/main/java/org/apache/james/mailbox/exception/MailboxSecurityException.java b/mailbox/api/src/main/java/org/apache/james/mailbox/exception/MailboxSecurityException.java
index 2923a08..32d20a7 100644
--- a/mailbox/api/src/main/java/org/apache/james/mailbox/exception/MailboxSecurityException.java
+++ b/mailbox/api/src/main/java/org/apache/james/mailbox/exception/MailboxSecurityException.java
@@ -23,13 +23,8 @@ package org.apache.james.mailbox.exception;
/**
* Parent for security related exceptions.
- *
*/
public class MailboxSecurityException extends MailboxException {
-
- /**
- *
- */
private static final long serialVersionUID = 4186633460326902649L;
public MailboxSecurityException() {
diff --git a/mailbox/api/src/main/java/org/apache/james/mailbox/model/Content.java b/mailbox/api/src/main/java/org/apache/james/mailbox/model/Content.java
index b39b60e..30328fb 100644
--- a/mailbox/api/src/main/java/org/apache/james/mailbox/model/Content.java
+++ b/mailbox/api/src/main/java/org/apache/james/mailbox/model/Content.java
@@ -29,13 +29,8 @@ import org.apache.james.mailbox.exception.MailboxException;
* This interface allows direct writing whilst exposing total size.
*/
public interface Content {
-
-
/**
* Return the content as {@link InputStream}
- *
- * @return content
- * @throws IOException
*/
InputStream getInputStream() throws IOException;
@@ -43,7 +38,6 @@ public interface Content {
* Size (in octets) of the content.
*
* @return number of octets to be written
- * @throws MessagingException
*/
long size() throws MailboxException;
}
\ No newline at end of file
diff --git a/mailbox/api/src/main/java/org/apache/james/mailbox/model/Mailbox.java b/mailbox/api/src/main/java/org/apache/james/mailbox/model/Mailbox.java
index 02d213f..913a401 100644
--- a/mailbox/api/src/main/java/org/apache/james/mailbox/model/Mailbox.java
+++ b/mailbox/api/src/main/java/org/apache/james/mailbox/model/Mailbox.java
@@ -131,8 +131,6 @@ public class Mailbox {
/**
* Gets the current ACL for this mailbox.
- *
- * @return ACL
*/
public MailboxACL getACL() {
return acl;
@@ -140,8 +138,6 @@ public class Mailbox {
/**
* Sets the current ACL for this mailbox.
- *
- * @param acl
*/
public void setACL(MailboxACL acl) {
this.acl = acl;
diff --git a/mailbox/api/src/main/java/org/apache/james/mailbox/model/MailboxACL.java b/mailbox/api/src/main/java/org/apache/james/mailbox/model/MailboxACL.java
index 36fd1ae..aceeada 100644
--- a/mailbox/api/src/main/java/org/apache/james/mailbox/model/MailboxACL.java
+++ b/mailbox/api/src/main/java/org/apache/james/mailbox/model/MailboxACL.java
@@ -254,8 +254,6 @@ public class MailboxACL {
* {@link MailboxACL.Rfc4314Rights}. However, implementations may decide to
* return this or toRemove parameter value in case the result would be
* equal to the respective one of those.
- *
- * @throws UnsupportedRightException
*/
public Rfc4314Rights except(Rfc4314Rights toRemove) throws UnsupportedRightException {
EnumSet<Right> copy = copyOf(value);
@@ -276,7 +274,6 @@ public class MailboxACL {
/**
* Tells whether the implementation supports the given right.
*
- * @param right
* @return true if this supports the given right.
*/
public boolean isSupported(Right right) {
@@ -323,9 +320,7 @@ public class MailboxACL {
* Implementations must return a new unmodifiable instance of
* {@link MailboxACL.Rfc4314Rights}.
*
- * @param toAdd
* @return union of this and toAdd
- * @throws UnsupportedRightException
*
*/
public Rfc4314Rights union(Rfc4314Rights toAdd) throws UnsupportedRightException {
@@ -389,8 +384,6 @@ public class MailboxACL {
* serialized {@link String}. It supposes that negative rights are
* marked with {@link MailboxACL#DEFAULT_NEGATIVE_MARKER} and that
* groups are marked with {@link MailboxACL#DEFAULT_GROUP_MARKER}.
- *
- * @param serialized
*/
public static EntryKey deserialize(String serialized) {
Preconditions.checkNotNull(serialized, "Cannot parse null");
@@ -472,8 +465,6 @@ public class MailboxACL {
*
* Note that {@link Entry#getKey()} ()} does not start with "-"
* when {@link Entry#getValue()} returns true.
- *
- * @return
*/
public boolean isNegative() {
return negative;
@@ -686,8 +677,6 @@ public class MailboxACL {
/**
* Creates a new instance of SimpleMailboxACL from the given array of
* entries.
- *
- * @param entries
*/
@SafeVarargs
public MailboxACL(Map.Entry<EntryKey, Rfc4314Rights>... entries) {
@@ -701,8 +690,6 @@ public class MailboxACL {
/**
* Creates a new instance of SimpleMailboxACL from the given {@link Map} of
* entries.
- *
- * @param entries
*/
public MailboxACL(Map<EntryKey, Rfc4314Rights> entries) {
Preconditions.checkNotNull(entries);
@@ -715,9 +702,6 @@ public class MailboxACL {
* keys and values from the <code>props</code> parameter are parsed by the
* {@link String} constructors of {@link EntryKey} and
* {@link Rfc4314Rights} respectively.
- *
- * @param props
- * @throws UnsupportedRightException
*/
public MailboxACL(Properties props) throws UnsupportedRightException {
this(toMap(props));
@@ -740,7 +724,6 @@ public class MailboxACL {
*
* @param aclUpdate Update to perform
* @return Copy of current ACL updated
- * @throws UnsupportedRightException
*/
public MailboxACL apply(ACLCommand aclUpdate) throws UnsupportedRightException {
switch (aclUpdate.getEditMode()) {
diff --git a/mailbox/api/src/main/java/org/apache/james/mailbox/model/MailboxConstants.java b/mailbox/api/src/main/java/org/apache/james/mailbox/model/MailboxConstants.java
index 9e61e2a..69bff29 100644
--- a/mailbox/api/src/main/java/org/apache/james/mailbox/model/MailboxConstants.java
+++ b/mailbox/api/src/main/java/org/apache/james/mailbox/model/MailboxConstants.java
@@ -21,8 +21,6 @@ package org.apache.james.mailbox.model;
/**
* Constants which are used within the mailbox api and implementations
- *
- *
*/
public interface MailboxConstants {
diff --git a/mailbox/api/src/main/java/org/apache/james/mailbox/model/MailboxMetaData.java b/mailbox/api/src/main/java/org/apache/james/mailbox/model/MailboxMetaData.java
index 040a8ef..7dc49c0 100644
--- a/mailbox/api/src/main/java/org/apache/james/mailbox/model/MailboxMetaData.java
+++ b/mailbox/api/src/main/java/org/apache/james/mailbox/model/MailboxMetaData.java
@@ -100,8 +100,6 @@ public class MailboxMetaData implements Comparable<MailboxMetaData> {
/**
* Return the delimiter
- *
- * @return delimiter
*/
public char getHierarchyDelimiter() {
return delimiter;
@@ -110,8 +108,6 @@ public class MailboxMetaData implements Comparable<MailboxMetaData> {
/**
* Return the MailboxPath
- *
- * @return path
*/
public MailboxPath getPath() {
return path;
diff --git a/mailbox/api/src/main/java/org/apache/james/mailbox/model/MailboxPath.java b/mailbox/api/src/main/java/org/apache/james/mailbox/model/MailboxPath.java
index d6c2621..7c4b948 100644
--- a/mailbox/api/src/main/java/org/apache/james/mailbox/model/MailboxPath.java
+++ b/mailbox/api/src/main/java/org/apache/james/mailbox/model/MailboxPath.java
@@ -36,9 +36,6 @@ public class MailboxPath {
/**
* Return a {@link MailboxPath} which represent the INBOX of the given
* session
- *
- * @param session
- * @return inbox
*/
public static MailboxPath inbox(MailboxSession session) {
return MailboxPath.forUser(session.getUser().asString(), MailboxConstants.INBOX);
@@ -73,8 +70,6 @@ public class MailboxPath {
/**
* Get the namespace this mailbox is in
- *
- * @return The namespace
*/
public String getNamespace() {
return namespace;
@@ -83,8 +78,6 @@ public class MailboxPath {
/**
* Get the name of the user who owns the mailbox. This can be null e.g. for
* shared mailboxes.
- *
- * @return The username
*/
public String getUser() {
return user;
@@ -93,8 +86,6 @@ public class MailboxPath {
/**
* Get the name of the mailbox. This is the pure name without user or
* namespace, so this is what a user would see in his client.
- *
- * @return The name string
*/
public String getName() {
return name;
@@ -113,8 +104,7 @@ public class MailboxPath {
* INBOX.main
* INBOX.main.sub
* </pre>
- *
- * @param delimiter
+ *
* @return list of hierarchy levels
*/
public List<MailboxPath> getHierarchyLevels(char delimiter) {
@@ -187,9 +177,7 @@ public class MailboxPath {
/**
* Return the full name of the {@link MailboxPath}, which is constructed via the {@link #namespace} and {@link #name}
- *
- * @param delimiter
- * @return fullName
+ *
* @deprecated Use {@link MailboxPath#asString()} instead.
*/
@Deprecated
diff --git a/mailbox/api/src/main/java/org/apache/james/mailbox/model/MessageRange.java b/mailbox/api/src/main/java/org/apache/james/mailbox/model/MessageRange.java
index e21b3d5..533070f 100644
--- a/mailbox/api/src/main/java/org/apache/james/mailbox/model/MessageRange.java
+++ b/mailbox/api/src/main/java/org/apache/james/mailbox/model/MessageRange.java
@@ -66,7 +66,7 @@ public class MessageRange implements Iterable<MessageUid> {
/**
* Constructs an inclusive ranges of messages. The parameters will be
- * checked and {@link #from(long)} used where appropriate.
+ * checked and {@link #from(MessageUid)} used where appropriate.
*
* @param from
* first message UID
diff --git a/mailbox/api/src/main/java/org/apache/james/mailbox/model/MessageResult.java b/mailbox/api/src/main/java/org/apache/james/mailbox/model/MessageResult.java
index 656e66f..35a9329 100644
--- a/mailbox/api/src/main/java/org/apache/james/mailbox/model/MessageResult.java
+++ b/mailbox/api/src/main/java/org/apache/james/mailbox/model/MessageResult.java
@@ -26,7 +26,6 @@ import java.util.List;
import java.util.Set;
import javax.mail.Flags;
-import javax.mail.MessagingException;
import org.apache.james.mailbox.MessageUid;
import org.apache.james.mailbox.exception.MailboxException;
@@ -165,7 +164,6 @@ public interface MessageResult extends Comparable<MessageResult> {
* @return <code>Header</code> <code>Iterator</code>, or null when
* {@link FetchGroup#content()} does not include the index and
* when the mime part cannot be found
- * @throws MailboxException
*/
Iterator<Header> iterateHeaders(MimePath path) throws MailboxException;
@@ -177,7 +175,6 @@ public interface MessageResult extends Comparable<MessageResult> {
* @return <code>Header</code> <code>Iterator</code>, or null when
* {@link FetchGroup#content()} does not include the index and
* when the mime part cannot be found
- * @throws MailboxException
*/
Iterator<Header> iterateMimeHeaders(MimePath path) throws MailboxException;
@@ -190,7 +187,6 @@ public interface MessageResult extends Comparable<MessageResult> {
* Gets the name of this header.
*
* @return name of this header
- * @throws MessagingException
*/
String getName();
@@ -198,7 +194,6 @@ public interface MessageResult extends Comparable<MessageResult> {
* Gets the (unparsed) value of this header.
*
* @return value of this header
- * @throws MessagingException
*/
String getValue();
}
@@ -210,7 +205,6 @@ public interface MessageResult extends Comparable<MessageResult> {
* @return <code>Content</code>, or or null if
* {@link FetchGroup#FULL_CONTENT} has not been included in the
* results
- * @throws IOException
*/
Content getFullContent() throws MailboxException, IOException;
@@ -222,7 +216,6 @@ public interface MessageResult extends Comparable<MessageResult> {
* @return <code>Content</code>, or null when
* {@link FetchGroup#content()} did not been include the given
* index and when the mime part cannot be found
- * @throws MailboxException
*/
Content getFullContent(MimePath path) throws MailboxException;
@@ -233,7 +226,6 @@ public interface MessageResult extends Comparable<MessageResult> {
* @return <code>Content</code>, or or null if
* {@link FetchGroup#FULL_CONTENT} has not been included in the
* results
- * @throws IOException
*/
Content getBody() throws MailboxException, IOException;
@@ -245,7 +237,6 @@ public interface MessageResult extends Comparable<MessageResult> {
* @return <code>Content</code>, or null when
* {@link FetchGroup#content()} did not been include the given
* index and when the mime part cannot be found
- * @throws MailboxException
*/
Content getBody(MimePath path) throws MailboxException;
@@ -257,7 +248,6 @@ public interface MessageResult extends Comparable<MessageResult> {
* @return <code>Content</code>, or null when
* {@link FetchGroup#content()} did not been include the given
* index and when the mime part cannot be found
- * @throws MailboxException
*/
Content getMimeBody(MimePath path) throws MailboxException;
diff --git a/mailbox/api/src/main/java/org/apache/james/mailbox/model/MessageResultIterator.java b/mailbox/api/src/main/java/org/apache/james/mailbox/model/MessageResultIterator.java
index 04351b7..0d25b4e 100644
--- a/mailbox/api/src/main/java/org/apache/james/mailbox/model/MessageResultIterator.java
+++ b/mailbox/api/src/main/java/org/apache/james/mailbox/model/MessageResultIterator.java
@@ -25,8 +25,6 @@ import org.apache.james.mailbox.exception.MailboxException;
/**
* A special {@link Iterator} which allows to access the {@link MailboxException} if one was thrown while try to lazy fetch the {@link MessageResult}'s in batches
- *
- *
*/
public interface MessageResultIterator extends Iterator<MessageResult> {
diff --git a/mailbox/api/src/main/java/org/apache/james/mailbox/model/SearchQuery.java b/mailbox/api/src/main/java/org/apache/james/mailbox/model/SearchQuery.java
index ceb3d51..51fcb9a 100644
--- a/mailbox/api/src/main/java/org/apache/james/mailbox/model/SearchQuery.java
+++ b/mailbox/api/src/main/java/org/apache/james/mailbox/model/SearchQuery.java
@@ -172,8 +172,6 @@ public class SearchQuery implements Serializable {
/**
* Create a new {@link Sort} which is NOT {@link #order}
- *
- * @param sortClause
*/
public Sort(SortClause sortClause) {
this(sortClause, Order.NATURAL);
@@ -181,8 +179,6 @@ public class SearchQuery implements Serializable {
/**
* Return true if the sort should be in reverse order
- *
- * @return reverse
*/
public boolean isReverse() {
return order == Order.REVERSE;
@@ -190,8 +186,6 @@ public class SearchQuery implements Serializable {
/**
* Return the {@link SortClause}
- *
- * @return clause
*/
public SortClause getSortClause() {
return sortClause;
@@ -449,9 +443,7 @@ public class SearchQuery implements Serializable {
* Creates a filter matching messages whose Address header contains the
* given address. The address header of the message MUST get canonicalized
* before try to match it.
- *
- * @param type
- * @param address
+ *
* @return <code>Criterion</code>
*/
public static Criterion address(AddressType type, String address) {
@@ -795,8 +787,6 @@ public class SearchQuery implements Serializable {
/**
* Set the {@link Sort}'s to use
- *
- * @param sorts
*/
public void setSorts(List<Sort> sorts) {
if (sorts == null || sorts.isEmpty()) {
diff --git a/mailbox/api/src/main/java/org/apache/james/mailbox/model/UpdatedFlags.java b/mailbox/api/src/main/java/org/apache/james/mailbox/model/UpdatedFlags.java
index 238b23d..f1c0562 100644
--- a/mailbox/api/src/main/java/org/apache/james/mailbox/model/UpdatedFlags.java
+++ b/mailbox/api/src/main/java/org/apache/james/mailbox/model/UpdatedFlags.java
@@ -33,8 +33,6 @@ import com.google.common.base.Preconditions;
/**
* Represent a Flag update for a message
- *
- *
*/
public class UpdatedFlags {
@@ -143,8 +141,6 @@ public class UpdatedFlags {
/**
* Return the old {@link Flags} for the message
- *
- * @return oldFlags
*/
public Flags getOldFlags() {
return oldFlags;
@@ -164,8 +160,6 @@ public class UpdatedFlags {
/**
* Return the new {@link Flags} for the message
- *
- * @return newFlags
*/
public Flags getNewFlags() {
return newFlags;
@@ -173,8 +167,6 @@ public class UpdatedFlags {
/**
* Return the uid for the message whichs {@link Flags} was updated
- *
- * @return uid
*/
public MessageUid getUid() {
return uid;
@@ -204,8 +196,6 @@ public class UpdatedFlags {
/**
* Return the new mod-sequence for the message
- *
- * @return mod-seq
*/
public long getModSeq() {
return modSeq;
diff --git a/mailbox/api/src/main/java/org/apache/james/mailbox/model/search/MailboxNameExpression.java b/mailbox/api/src/main/java/org/apache/james/mailbox/model/search/MailboxNameExpression.java
index 2b9d4c8..eda289d 100644
--- a/mailbox/api/src/main/java/org/apache/james/mailbox/model/search/MailboxNameExpression.java
+++ b/mailbox/api/src/main/java/org/apache/james/mailbox/model/search/MailboxNameExpression.java
@@ -43,9 +43,6 @@ public interface MailboxNameExpression {
* Get combined name formed by adding the expression to the base using the
* given hierarchy delimiter. Note that the wildcards are retained in the
* combined name.
- *
- * @return {@link #getBase()} combined with {@link #getExpression()},
- * notnull
*/
String getCombinedName();
diff --git a/mailbox/api/src/main/java/org/apache/james/mailbox/model/search/MailboxQuery.java b/mailbox/api/src/main/java/org/apache/james/mailbox/model/search/MailboxQuery.java
index 4767f17..c29e2d2 100644
--- a/mailbox/api/src/main/java/org/apache/james/mailbox/model/search/MailboxQuery.java
+++ b/mailbox/api/src/main/java/org/apache/james/mailbox/model/search/MailboxQuery.java
@@ -116,13 +116,6 @@ public final class MailboxQuery {
/**
* Constructs an expression determining a set of mailbox names.
- *
- * @param base
- * base reference name, not null
- * @param expression
- * mailbox match expression, not null
- * @param pathDelimiter
- * path delimiter to use
*/
@VisibleForTesting MailboxQuery(Optional<String> namespace, Optional<String> user, MailboxNameExpression mailboxNameExpression) {
this.namespace = namespace;
diff --git a/mailbox/api/src/main/java/org/apache/james/mailbox/quota/QuotaManager.java b/mailbox/api/src/main/java/org/apache/james/mailbox/quota/QuotaManager.java
index 231d6ad..675f2e5 100644
--- a/mailbox/api/src/main/java/org/apache/james/mailbox/quota/QuotaManager.java
+++ b/mailbox/api/src/main/java/org/apache/james/mailbox/quota/QuotaManager.java
@@ -36,8 +36,6 @@ public interface QuotaManager {
* bound to a user)
*
* @param quotaRoot Quota root argument from RFC 2087 ( correspond to the user owning this mailbox )
- * @return quota
- * @throws MailboxException
*/
Quota<QuotaCount> getMessageQuota(QuotaRoot quotaRoot) throws MailboxException;
@@ -47,8 +45,6 @@ public interface QuotaManager {
* bound to a user)
*
* @param quotaRoot Quota root argument from RFC 2087 ( correspond to the user owning this mailbox )
- * @return quota
- * @throws MailboxException
*/
Quota<QuotaSize> getStorageQuota(QuotaRoot quotaRoot) throws MailboxException;
}
diff --git a/mailbox/api/src/main/java/org/apache/james/mailbox/quota/QuotaRootResolver.java b/mailbox/api/src/main/java/org/apache/james/mailbox/quota/QuotaRootResolver.java
index 3bd3c01..2ba6cf9 100644
--- a/mailbox/api/src/main/java/org/apache/james/mailbox/quota/QuotaRootResolver.java
+++ b/mailbox/api/src/main/java/org/apache/james/mailbox/quota/QuotaRootResolver.java
@@ -34,7 +34,6 @@ public interface QuotaRootResolver extends QuotaRootDeserializer {
*
* @param mailboxPath The name of the mailbox
* @return QuotaRoot ruling this mailbox ( we uses user owning this mailbox name )
- * @throws MailboxException
*/
QuotaRoot getQuotaRoot(MailboxPath mailboxPath) throws MailboxException;
---------------------------------------------------------------------
To unsubscribe, e-mail: server-dev-unsubscribe@james.apache.org
For additional commands, e-mail: server-dev-help@james.apache.org