Author: norman
Date: Thu Oct 6 10:11:44 2011
New Revision: 1179555
URL: http://svn.apache.org/viewvc?rev=1179555&view=rev
Log:
Some more love for javadocs ;)
Modified:
james/mailbox/trunk/store/src/main/java/org/apache/james/mailbox/store/mail/AbstractLockingModSeqProvider.java
james/mailbox/trunk/store/src/main/java/org/apache/james/mailbox/store/mail/AbstractLockingUidProvider.java
Modified:
james/mailbox/trunk/store/src/main/java/org/apache/james/mailbox/store/mail/AbstractLockingModSeqProvider.java
URL:
http://svn.apache.org/viewvc/james/mailbox/trunk/store/src/main/java/org/apache/james/mailbox/store/mail/AbstractLockingModSeqProvider.java?rev=1179555&r1=1179554&r2=1179555&view=diff
==============================================================================
---
james/mailbox/trunk/store/src/main/java/org/apache/james/mailbox/store/mail/AbstractLockingModSeqProvider.java
(original)
+++
james/mailbox/trunk/store/src/main/java/org/apache/james/mailbox/store/mail/AbstractLockingModSeqProvider.java
Thu Oct 6 10:11:44 2011
@@ -25,6 +25,12 @@ import org.apache.james.mailbox.MailboxS
import org.apache.james.mailbox.store.StoreMailboxPath;
import org.apache.james.mailbox.store.mail.model.Mailbox;
+/**
+ * Abstract base implementation of {@link ModSeqProvider} which uses the given
{@link MailboxPathLocker} to lock the {@link Mailbox} during the mod-seq
generation.
+ *
+ *
+ * @param <Id>
+ */
public abstract class AbstractLockingModSeqProvider<Id> implements
ModSeqProvider<Id>{
private final MailboxPathLocker locker;
@@ -44,6 +50,14 @@ public abstract class AbstractLockingMod
});
}
+ /**
+ * Generate the next mod-seq for the given {@link Mailbox} while holding a
lock on it.
+ *
+ * @param session
+ * @param mailbox
+ * @return nextModSeq
+ * @throws MailboxException
+ */
protected abstract long lockedNextModSeq(MailboxSession session,
Mailbox<Id> mailbox) throws MailboxException;
}
Modified:
james/mailbox/trunk/store/src/main/java/org/apache/james/mailbox/store/mail/AbstractLockingUidProvider.java
URL:
http://svn.apache.org/viewvc/james/mailbox/trunk/store/src/main/java/org/apache/james/mailbox/store/mail/AbstractLockingUidProvider.java?rev=1179555&r1=1179554&r2=1179555&view=diff
==============================================================================
---
james/mailbox/trunk/store/src/main/java/org/apache/james/mailbox/store/mail/AbstractLockingUidProvider.java
(original)
+++
james/mailbox/trunk/store/src/main/java/org/apache/james/mailbox/store/mail/AbstractLockingUidProvider.java
Thu Oct 6 10:11:44 2011
@@ -25,6 +25,14 @@ import org.apache.james.mailbox.MailboxS
import org.apache.james.mailbox.store.StoreMailboxPath;
import org.apache.james.mailbox.store.mail.model.Mailbox;
+
+/**
+ * Abstract base implementation of {@link UidProvider} which used the given
{@link MailboxPathLocker} to
+ * lock the {@link Mailbox} while the next uid is generated
+ *
+ *
+ * @param <Id>
+ */
public abstract class AbstractLockingUidProvider<Id> implements
UidProvider<Id>{
private final MailboxPathLocker locker;
@@ -44,6 +52,14 @@ public abstract class AbstractLockingUid
});
}
+ /**
+ * Generate the next uid to use while the {@link Mailbox} is locked
+ *
+ * @param session
+ * @param mailbox
+ * @return nextUid
+ * @throws MailboxException
+ */
protected abstract long lockedNextUid(MailboxSession session, Mailbox<Id>
mailbox) throws MailboxException;
}
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
