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 fe...@apache.org on 2011/10/06 12:26:21 UTC

svn commit: r1179563 - in /james/mailbox/trunk/jcr/src/main/java/org/apache/james/mailbox/jcr: JCRMessageManager.java Persistent.java mail/JCRMessageMapper.java

Author: felixk
Date: Thu Oct  6 10:26:20 2011
New Revision: 1179563

URL: http://svn.apache.org/viewvc?rev=1179563&view=rev
Log:
Update javadocs

Modified:
    james/mailbox/trunk/jcr/src/main/java/org/apache/james/mailbox/jcr/JCRMessageManager.java
    james/mailbox/trunk/jcr/src/main/java/org/apache/james/mailbox/jcr/Persistent.java
    james/mailbox/trunk/jcr/src/main/java/org/apache/james/mailbox/jcr/mail/JCRMessageMapper.java

Modified: james/mailbox/trunk/jcr/src/main/java/org/apache/james/mailbox/jcr/JCRMessageManager.java
URL: http://svn.apache.org/viewvc/james/mailbox/trunk/jcr/src/main/java/org/apache/james/mailbox/jcr/JCRMessageManager.java?rev=1179563&r1=1179562&r2=1179563&view=diff
==============================================================================
--- james/mailbox/trunk/jcr/src/main/java/org/apache/james/mailbox/jcr/JCRMessageManager.java (original)
+++ james/mailbox/trunk/jcr/src/main/java/org/apache/james/mailbox/jcr/JCRMessageManager.java Thu Oct  6 10:26:20 2011
@@ -37,7 +37,7 @@ import org.apache.james.mailbox.store.se
 import org.slf4j.Logger;
 
 /**
- * JCR implementation of a {@link MapperStoreMessageManager}
+ * JCR implementation of a {@link org.apache.james.mailbox.MessageManager}
  *
  */
 public class JCRMessageManager extends StoreMessageManager<String> {

Modified: james/mailbox/trunk/jcr/src/main/java/org/apache/james/mailbox/jcr/Persistent.java
URL: http://svn.apache.org/viewvc/james/mailbox/trunk/jcr/src/main/java/org/apache/james/mailbox/jcr/Persistent.java?rev=1179563&r1=1179562&r2=1179563&view=diff
==============================================================================
--- james/mailbox/trunk/jcr/src/main/java/org/apache/james/mailbox/jcr/Persistent.java (original)
+++ james/mailbox/trunk/jcr/src/main/java/org/apache/james/mailbox/jcr/Persistent.java Thu Oct  6 10:26:20 2011
@@ -43,7 +43,7 @@ public interface Persistent {
     /**
      * Return if the object is persistent
      * 
-     * @return
+     * @return <code>true</code> if object is persistent else <code>false</code>
      */
     public boolean isPersistent();
 

Modified: james/mailbox/trunk/jcr/src/main/java/org/apache/james/mailbox/jcr/mail/JCRMessageMapper.java
URL: http://svn.apache.org/viewvc/james/mailbox/trunk/jcr/src/main/java/org/apache/james/mailbox/jcr/mail/JCRMessageMapper.java?rev=1179563&r1=1179562&r2=1179563&view=diff
==============================================================================
--- james/mailbox/trunk/jcr/src/main/java/org/apache/james/mailbox/jcr/mail/JCRMessageMapper.java (original)
+++ james/mailbox/trunk/jcr/src/main/java/org/apache/james/mailbox/jcr/mail/JCRMessageMapper.java Thu Oct  6 10:26:20 2011
@@ -104,9 +104,12 @@ public class JCRMessageMapper extends Ab
     /**
      * Construct a new {@link JCRMessageMapper} instance
      * 
-     * @param repos {@link MailboxSessionJCRRepository} to use
-     * @param session {@link MailboxSession} to which the mapper is bound
-     * @param logger Log
+     * @param repository {@link MailboxSessionJCRRepository} to use
+     * @param mSession {@link MailboxSession} to which the mapper is bound
+     * @param uidProvider {@link UidProvider} to use
+     * @param modSeqProvider {@link ModSeqProvider} to use
+     * @param scaleType message scale type either {@link #MESSAGE_SCALE_DAY}, {@link #MESSAGE_SCALE_HOUR}, {@link #MESSAGE_SCALE_MINUTE},
+     *          {@link #MESSAGE_SCALE_MONTH}, {@link #MESSAGE_SCALE_NONE} or {@link #MESSAGE_SCALE_YEAR}
      */
     public JCRMessageMapper(final MailboxSessionJCRRepository repository, MailboxSession mSession, UidProvider<String> uidProvider, ModSeqProvider<String> modSeqProvider, int scaleType) {
         super(mSession, uidProvider, modSeqProvider);
@@ -114,6 +117,14 @@ public class JCRMessageMapper extends Ab
         this.scaleType = scaleType;
     }
     
+    /**
+     * Construct a new {@link JCRMessageMapper} instance using {@link #MESSAGE_SCALE_DAY} as default
+     * 
+     * @param repos {@link MailboxSessionJCRRepository} to use
+     * @param session {@link MailboxSession} to which the mapper is bound
+     * @param uidProvider {@link UidProvider} to use
+     * @param modSeqProvider {@link ModSeqProvider} to use
+     */
     public JCRMessageMapper(final MailboxSessionJCRRepository repos, MailboxSession session, UidProvider<String> uidProvider, ModSeqProvider<String> modSeqProvider) {
         this(repos, session, uidProvider, modSeqProvider, MESSAGE_SCALE_DAY);
     }



---------------------------------------------------------------------
To unsubscribe, e-mail: server-dev-unsubscribe@james.apache.org
For additional commands, e-mail: server-dev-help@james.apache.org