Author: felixk
Date: Thu Oct 6 09:38:13 2011
New Revision: 1179550
URL: http://svn.apache.org/viewvc?rev=1179550&view=rev
Log:
Update javadocs
Modified:
james/mailbox/trunk/api/src/main/java/org/apache/james/mailbox/MailboxListener.java
james/mailbox/trunk/api/src/main/java/org/apache/james/mailbox/MailboxListenerSupport.java
james/mailbox/trunk/api/src/main/java/org/apache/james/mailbox/MailboxManager.java
james/mailbox/trunk/api/src/main/java/org/apache/james/mailbox/MailboxPath.java
james/mailbox/trunk/api/src/main/java/org/apache/james/mailbox/MailboxPathLocker.java
james/mailbox/trunk/api/src/main/java/org/apache/james/mailbox/MailboxQuery.java
james/mailbox/trunk/api/src/main/java/org/apache/james/mailbox/MessageManager.java
james/mailbox/trunk/api/src/main/java/org/apache/james/mailbox/MessageRange.java
james/mailbox/trunk/api/src/main/java/org/apache/james/mailbox/MessageResult.java
james/mailbox/trunk/api/src/main/java/org/apache/james/mailbox/SearchQuery.java
james/mailbox/trunk/api/src/main/java/org/apache/james/mailbox/SubscriptionManager.java
Modified:
james/mailbox/trunk/api/src/main/java/org/apache/james/mailbox/MailboxListener.java
URL:
http://svn.apache.org/viewvc/james/mailbox/trunk/api/src/main/java/org/apache/james/mailbox/MailboxListener.java?rev=1179550&r1=1179549&r2=1179550&view=diff
==============================================================================
---
james/mailbox/trunk/api/src/main/java/org/apache/james/mailbox/MailboxListener.java
(original)
+++
james/mailbox/trunk/api/src/main/java/org/apache/james/mailbox/MailboxListener.java
Thu Oct 6 09:38:13 2011
@@ -25,9 +25,7 @@ import java.util.List;
/**
* Listens to <code>Mailbox</code> events.<br>
- * Note that listeners may be removed asynchronously.<br>
- * When {@link #isClosed()} returns true, the listener may be removed from the
- * mailbox by the dispatcher.
+ * Note that listeners may be removed asynchronously.
*/
public interface MailboxListener {
Modified:
james/mailbox/trunk/api/src/main/java/org/apache/james/mailbox/MailboxListenerSupport.java
URL:
http://svn.apache.org/viewvc/james/mailbox/trunk/api/src/main/java/org/apache/james/mailbox/MailboxListenerSupport.java?rev=1179550&r1=1179549&r2=1179550&view=diff
==============================================================================
---
james/mailbox/trunk/api/src/main/java/org/apache/james/mailbox/MailboxListenerSupport.java
(original)
+++
james/mailbox/trunk/api/src/main/java/org/apache/james/mailbox/MailboxListenerSupport.java
Thu Oct 6 09:38:13 2011
@@ -33,10 +33,6 @@ public interface MailboxListenerSupport
* listening and do some caching and even postpone persistence until
* everyone has removed itself.
* </p>
- * <p>
- * Listeners should return true from {@link MailboxListener#isClosed()}
when
- * they are ready to be removed.
- * </p>
*
* @param mailboxPath
* not null
Modified:
james/mailbox/trunk/api/src/main/java/org/apache/james/mailbox/MailboxManager.java
URL:
http://svn.apache.org/viewvc/james/mailbox/trunk/api/src/main/java/org/apache/james/mailbox/MailboxManager.java?rev=1179550&r1=1179549&r2=1179550&view=diff
==============================================================================
---
james/mailbox/trunk/api/src/main/java/org/apache/james/mailbox/MailboxManager.java
(original)
+++
james/mailbox/trunk/api/src/main/java/org/apache/james/mailbox/MailboxManager.java
Thu Oct 6 09:38:13 2011
@@ -150,7 +150,7 @@ public interface MailboxManager extends
/**
* Does the given mailbox exist?
*
- * @param mailboxName
+ * @param mailboxPath
* not null
* @param session
* the context for this call, not null
@@ -163,7 +163,7 @@ public interface MailboxManager extends
/**
* Creates a new system session.<br>
* A system session is intended to be used for programmatic access.<br>
- * Use {@link #login(String, String, Log)} when accessing this API from a
+ * Use {@link #login(String, String, Logger)} when accessing this API from
a
* protocol.
*
* @param userName
Modified:
james/mailbox/trunk/api/src/main/java/org/apache/james/mailbox/MailboxPath.java
URL:
http://svn.apache.org/viewvc/james/mailbox/trunk/api/src/main/java/org/apache/james/mailbox/MailboxPath.java?rev=1179550&r1=1179549&r2=1179550&view=diff
==============================================================================
---
james/mailbox/trunk/api/src/main/java/org/apache/james/mailbox/MailboxPath.java
(original)
+++
james/mailbox/trunk/api/src/main/java/org/apache/james/mailbox/MailboxPath.java
Thu Oct 6 09:38:13 2011
@@ -113,7 +113,7 @@ public class MailboxPath {
* </pre>
*
* @param delimiter
- * @return
+ * @return list of hierarchy levels
*/
public List<MailboxPath> getHierarchyLevels(char delimiter) {
ArrayList<MailboxPath> levels = new ArrayList<MailboxPath>();
Modified:
james/mailbox/trunk/api/src/main/java/org/apache/james/mailbox/MailboxPathLocker.java
URL:
http://svn.apache.org/viewvc/james/mailbox/trunk/api/src/main/java/org/apache/james/mailbox/MailboxPathLocker.java?rev=1179550&r1=1179549&r2=1179550&view=diff
==============================================================================
---
james/mailbox/trunk/api/src/main/java/org/apache/james/mailbox/MailboxPathLocker.java
(original)
+++
james/mailbox/trunk/api/src/main/java/org/apache/james/mailbox/MailboxPathLocker.java
Thu Oct 6 09:38:13 2011
@@ -58,8 +58,6 @@ public interface MailboxPathLocker {
/**
* Execute code block
*
- * @param session
- * @param path
* @throws MailboxException
*/
public T execute() throws MailboxException;
Modified:
james/mailbox/trunk/api/src/main/java/org/apache/james/mailbox/MailboxQuery.java
URL:
http://svn.apache.org/viewvc/james/mailbox/trunk/api/src/main/java/org/apache/james/mailbox/MailboxQuery.java?rev=1179550&r1=1179549&r2=1179550&view=diff
==============================================================================
---
james/mailbox/trunk/api/src/main/java/org/apache/james/mailbox/MailboxQuery.java
(original)
+++
james/mailbox/trunk/api/src/main/java/org/apache/james/mailbox/MailboxQuery.java
Thu Oct 6 09:38:13 2011
@@ -52,11 +52,8 @@ public final class MailboxQuery {
* base reference name, not null
* @param expression
* mailbox match expression, not null
- * @param freeWildcard
- * matches any series of charaters
- * @param localWildcard
- * matches any sequence of characters up to the next hierarchy
- * delimiter
+ * @param pathDelimiter
+ * path delimiter to use
*/
public MailboxQuery(final MailboxPath base, final String expression, final
char pathDelimiter) {
super();
@@ -117,8 +114,6 @@ public final class MailboxQuery {
*
* @param name
* name to be matched
- * @param hierarchyDelimiter
- * mailbox hierarchy delimiter
* @return true if the given name matches this expression, false otherwise
*/
public final boolean isExpressionMatch(String name) {
Modified:
james/mailbox/trunk/api/src/main/java/org/apache/james/mailbox/MessageManager.java
URL:
http://svn.apache.org/viewvc/james/mailbox/trunk/api/src/main/java/org/apache/james/mailbox/MessageManager.java?rev=1179550&r1=1179549&r2=1179550&view=diff
==============================================================================
---
james/mailbox/trunk/api/src/main/java/org/apache/james/mailbox/MessageManager.java
(original)
+++
james/mailbox/trunk/api/src/main/java/org/apache/james/mailbox/MessageManager.java
Thu Oct 6 09:38:13 2011
@@ -89,7 +89,7 @@ public interface MessageManager {
* not null
* @param mailboxSession
* not null
- * @return
+ * @return uid iterator
* @throws MailboxException
* if anything went wrong
*/
Modified:
james/mailbox/trunk/api/src/main/java/org/apache/james/mailbox/MessageRange.java
URL:
http://svn.apache.org/viewvc/james/mailbox/trunk/api/src/main/java/org/apache/james/mailbox/MessageRange.java?rev=1179550&r1=1179549&r2=1179550&view=diff
==============================================================================
---
james/mailbox/trunk/api/src/main/java/org/apache/james/mailbox/MessageRange.java
(original)
+++
james/mailbox/trunk/api/src/main/java/org/apache/james/mailbox/MessageRange.java
Thu Oct 6 09:38:13 2011
@@ -168,7 +168,8 @@ public class MessageRange implements Ite
/**
* Converts the given {@link Collection} of uids to a {@link List} of
{@link MessageRange} instances
*
- * @param uids
+ * @param uidsCol
+ * collection of uids to convert
* @return ranges
*/
public static List<MessageRange> toRanges(Collection<Long> uidsCol) {
@@ -268,7 +269,6 @@ public class MessageRange implements Ite
* select only a max amount of items. This only work for {@link
MessageRange}'s with {@link Type} of
* {@link Type#RANGE}.
*
- * @param range
* @param maxItems
* @return ranges
*/
Modified:
james/mailbox/trunk/api/src/main/java/org/apache/james/mailbox/MessageResult.java
URL:
http://svn.apache.org/viewvc/james/mailbox/trunk/api/src/main/java/org/apache/james/mailbox/MessageResult.java?rev=1179550&r1=1179549&r2=1179550&view=diff
==============================================================================
---
james/mailbox/trunk/api/src/main/java/org/apache/james/mailbox/MessageResult.java
(original)
+++
james/mailbox/trunk/api/src/main/java/org/apache/james/mailbox/MessageResult.java
Thu Oct 6 09:38:13 2011
@@ -85,11 +85,11 @@ public interface MessageResult extends C
*
* @return bitwise description
* @see #MINIMAL
- * @see #MIME_MESSAGE
- * @see #KEY
+ * @see #MIME_DESCRIPTOR
* @see #HEADERS
* @see #FULL_CONTENT
* @see #BODY_CONTENT
+ * @see #MIME_HEADERS
* @see #MIME_CONTENT
*/
int content();
@@ -114,11 +114,12 @@ public interface MessageResult extends C
*
* @return bitwise descripion
* @see #MINIMAL
- * @see #MIME_MESSAGE
- * @see #KEY
+ * @see #MIME_DESCRIPTOR
* @see #HEADERS
* @see #FULL_CONTENT
* @see #BODY_CONTENT
+ * @see #MIME_HEADERS
+ * @see #MIME_CONTENT
*/
int content();
@@ -139,7 +140,7 @@ public interface MessageResult extends C
* @param path
* describing the part's position within a multipart message
* @return <code>Header</code> <code>Iterator</code>, or null when
- * {@link FetchGroup#mimeHeaders()} does not include the index and
+ * {@link FetchGroup#content()} does not include the index and
* when the mime part cannot be found
* @throws MailboxException
*/
@@ -151,7 +152,7 @@ public interface MessageResult extends C
* @param path
* describing the part's position within a multipart message
* @return <code>Header</code> <code>Iterator</code>, or null when
- * {@link FetchGroup#mimeHeaders()} does not include the index and
+ * {@link FetchGroup#content()} does not include the index and
* when the mime part cannot be found
* @throws MailboxException
*/
@@ -196,7 +197,7 @@ public interface MessageResult extends C
* @param path
* describes the part
* @return <code>Content</code>, or null when
- * {@link FetchGroup#mimeBodies()} did not been include the given
+ * {@link FetchGroup#content()} did not been include the given
* index and when the mime part cannot be found
* @throws MailboxException
*/
@@ -219,7 +220,7 @@ public interface MessageResult extends C
* @param path
* describes the part
* @return <code>Content</code>, or null when
- * {@link FetchGroup#mimeBodies()} did not been include the given
+ * {@link FetchGroup#content()} did not been include the given
* index and when the mime part cannot be found
* @throws MailboxException
*/
@@ -231,7 +232,7 @@ public interface MessageResult extends C
* @param path
* describes the part
* @return <code>Content</code>, or null when
- * {@link FetchGroup#mimeBodies()} did not been include the given
+ * {@link FetchGroup#content()} did not been include the given
* index and when the mime part cannot be found
* @throws MailboxException
*/
Modified:
james/mailbox/trunk/api/src/main/java/org/apache/james/mailbox/SearchQuery.java
URL:
http://svn.apache.org/viewvc/james/mailbox/trunk/api/src/main/java/org/apache/james/mailbox/SearchQuery.java?rev=1179550&r1=1179549&r2=1179550&view=diff
==============================================================================
---
james/mailbox/trunk/api/src/main/java/org/apache/james/mailbox/SearchQuery.java
(original)
+++
james/mailbox/trunk/api/src/main/java/org/apache/james/mailbox/SearchQuery.java
Thu Oct 6 09:38:13 2011
@@ -268,12 +268,11 @@ public class SearchQuery {
* Creates a filter matching messages with internal date after the given
* date.
*
- * @param day
- * one based day of the month
- * @param month
- * one based month of the year
- * @param year
- * year
+ * @param date
+ * given date
+ * @param res
+ * the date resolution, either {@link DateResolution#Year},
{@link DateResolution#Month}, {@link DateResolution#Day},
+ * {@link DateResolution#Hour}, {@link DateResolution#Minute}
or {@link DateResolution#Second}
* @return <code>Criterion</code>, not null
*/
public static final Criterion internalDateAfter(Date date, DateResolution
res) {
@@ -283,12 +282,11 @@ public class SearchQuery {
/**
* Creates a filter matching messages with internal date on the given date.
*
- * @param day
- * one based day of the month
- * @param month
- * one based month of the year
- * @param year
- * year
+ * @param date
+ * given date
+ * @param res
+ * the date resolution, either {@link DateResolution#Year},
{@link DateResolution#Month}, {@link DateResolution#Day},
+ * {@link DateResolution#Hour}, {@link DateResolution#Minute}
or {@link DateResolution#Second}
* @return <code>Criterion</code>, not null
*/
public static final Criterion internalDateOn(Date date, DateResolution
res) {
@@ -299,12 +297,11 @@ public class SearchQuery {
* Creates a filter matching messages with internal date before the given
* date.
*
- * @param day
- * one based day of the month
- * @param month
- * one based month of the year
- * @param year
- * year
+ * @param date
+ * given date
+ * @param res
+ * the date resolution, either {@link DateResolution#Year},
{@link DateResolution#Month}, {@link DateResolution#Day},
+ * {@link DateResolution#Hour}, {@link DateResolution#Minute}
or {@link DateResolution#Second}
* @return <code>Criterion</code>, not null
*/
public static final Criterion internalDateBefore(Date date, DateResolution
res) {
@@ -318,12 +315,11 @@ public class SearchQuery {
*
* @param headerName
* name of the header whose value will be compared, not null
- * @param day
- * one based day of the month
- * @param month
- * one based month of the year
- * @param year
- * year
+ * @param date
+ * given date
+ * @param res
+ * the date resolution, either {@link DateResolution#Year},
{@link DateResolution#Month}, {@link DateResolution#Day},
+ * {@link DateResolution#Hour}, {@link DateResolution#Minute}
or {@link DateResolution#Second}
* @return <code>Criterion</code>, not null
*/
public static final Criterion headerDateAfter(String headerName, Date
date, DateResolution res) {
@@ -337,12 +333,11 @@ public class SearchQuery {
*
* @param headerName
* name of the header whose value will be compared, not null
- * @param day
- * one based day of the month
- * @param month
- * one based month of the year
- * @param year
- * year
+ * @param date
+ * given date
+ * @param res
+ * the date resolution, either {@link DateResolution#Year},
{@link DateResolution#Month}, {@link DateResolution#Day},
+ * {@link DateResolution#Hour}, {@link DateResolution#Minute}
or {@link DateResolution#Second}
* @return <code>Criterion</code>, not null
*/
public static final Criterion headerDateOn(String headerName, Date date,
DateResolution res) {
@@ -356,12 +351,11 @@ public class SearchQuery {
*
* @param headerName
* name of the header whose value will be compared, not null
- * @param day
- * one based day of the month
- * @param month
- * one based month of the year
- * @param year
- * year
+ * @param date
+ * given date
+ * @param res
+ * the date resolution, either {@link DateResolution#Year},
{@link DateResolution#Month}, {@link DateResolution#Day},
+ * {@link DateResolution#Hour}, {@link DateResolution#Minute}
or {@link DateResolution#Second}
* @return <code>Criterion</code>, not null
*/
public static final Criterion headerDateBefore(String headerName, Date
date, DateResolution res) {
@@ -1923,8 +1917,8 @@ public class SearchQuery {
/**
* Gets the operator type.
*
- * @return the type, either {@link #BEFORE}, {@link #AFTER} or
- * {@link ON}
+ * @return the type, either {@link DateComparator#BEFORE}, {@link
DateComparator#AFTER} or
+ * {@link DateComparator#ON}
*/
public DateComparator getType() {
return type;
Modified:
james/mailbox/trunk/api/src/main/java/org/apache/james/mailbox/SubscriptionManager.java
URL:
http://svn.apache.org/viewvc/james/mailbox/trunk/api/src/main/java/org/apache/james/mailbox/SubscriptionManager.java?rev=1179550&r1=1179549&r2=1179550&view=diff
==============================================================================
---
james/mailbox/trunk/api/src/main/java/org/apache/james/mailbox/SubscriptionManager.java
(original)
+++
james/mailbox/trunk/api/src/main/java/org/apache/james/mailbox/SubscriptionManager.java
Thu Oct 6 09:38:13 2011
@@ -43,7 +43,7 @@ public interface SubscriptionManager ext
/**
* Finds all subscriptions for the user in the session.
*
- * @param user
+ * @param session
* not null
* @return not null
* @throws SubscriptionException
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
