Author: norman
Date: Thu Jul 28 18:43:16 2011
New Revision: 1151963
URL: http://svn.apache.org/viewvc?rev=1151963&view=rev
Log:
Just some javadocs. See MAILBOX-113
Modified:
james/mailbox/trunk/api/src/main/java/org/apache/james/mailbox/MessageManager.java
james/mailbox/trunk/store/src/main/java/org/apache/james/mailbox/store/mail/MessageMapper.java
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=1151963&r1=1151962&r2=1151963&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 Jul 28 18:43:16 2011
@@ -133,7 +133,9 @@ public interface MessageManager {
long appendMessage(InputStream msgIn, Date internalDate, MailboxSession
mailboxSession, boolean isRecent, Flags flags) throws MailboxException;
/**
- * Gets messages in the given range.
+ * Gets messages in the given range. The messages may get fetched under
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
Modified:
james/mailbox/trunk/store/src/main/java/org/apache/james/mailbox/store/mail/MessageMapper.java
URL:
http://svn.apache.org/viewvc/james/mailbox/trunk/store/src/main/java/org/apache/james/mailbox/store/mail/MessageMapper.java?rev=1151963&r1=1151962&r2=1151963&view=diff
==============================================================================
---
james/mailbox/trunk/store/src/main/java/org/apache/james/mailbox/store/mail/MessageMapper.java
(original)
+++
james/mailbox/trunk/store/src/main/java/org/apache/james/mailbox/store/mail/MessageMapper.java
Thu Jul 28 18:43:16 2011
@@ -46,7 +46,8 @@ public interface MessageMapper<Id> exten
* @param mailbox The mailbox to search
* @param set message range for batch processing
* @param type
- * @param limt the maximal limit of returned {@link Message}'s. Use -1 to
set no limit
+ * @param limit the maximal limit of returned {@link Message}'s. Use -1 to
set no limit. In any case the caller MUST not expect the limit to get applied
in all cases as the implementation
+ * MAY just ignore it
* @throws MailboxException
*/
Iterator<Message<Id>> findInMailbox(Mailbox<Id> mailbox, MessageRange set,
FetchType type, int limit)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
