org.apache.james.mailbox.store

Class MailboxMetaData

java.lang.Object

org.apache.james.mailbox.store.MailboxMetaData

All Implemented Interfaces:

MessageManager.MetaData

public class MailboxMetaData
extends Object
implements MessageManager.MetaData

Describes the current state of a mailbox.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.james.mailbox.MessageManager.MetaData

MessageManager.MetaData.FetchGroup

Constructor Summary

Constructors

Constructor and Description
MailboxMetaData(List<Long> recent, javax.mail.Flags premanentFlags, long uidValidity, long nextUid, long highestModSeq, long messageCount, long unseenCount, Long firstUnseen, boolean writeable, boolean modSeqPermanent, MailboxACL acl)

Method Summary

Methods

Modifier and Type	Method and Description
long	countRecent() Gets the number of recent messages.
MailboxACL	getACL() Returns the ACL concerning this mailbox.
Long	getFirstUnseen() Gets the UID of the first unseen message.
long	getHighestModSeq() Return the highest mod-sequence for the mailbox.
long	getMessageCount() Gets the number of messages that this mailbox contains.
javax.mail.Flags	getPermanentFlags() Gets the flags which can be stored by this mailbox.
List<Long>	getRecent() Gets the UIDs of recent messages if requested or an empty List otherwise.
long	getUidNext() Gets the next UID predicted.
long	getUidValidity() Gets the UIDVALIDITY.
long	getUnseenCount() Gets the number of unseen messages contained in this mailbox.
boolean	isModSeqPermanent() Return true if the mailbox does store the mod-sequences in a permanent way
boolean	isWriteable() Is this mailbox writable?

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MailboxMetaData

public MailboxMetaData(List<Long> recent,
               javax.mail.Flags premanentFlags,
               long uidValidity,
               long nextUid,
               long highestModSeq,
               long messageCount,
               long unseenCount,
               Long firstUnseen,
               boolean writeable,
               boolean modSeqPermanent,
               MailboxACL acl)

Method Detail

countRecent

public long countRecent()

Description copied from interface: MessageManager.MetaData

Gets the number of recent messages.

Specified by:

countRecent in interface MessageManager.MetaData

Returns:

the number of messages flagged RECENT in this mailbox

See Also:

countRecent()

getPermanentFlags

public javax.mail.Flags getPermanentFlags()

Description copied from interface: MessageManager.MetaData

Gets the flags which can be stored by this mailbox.

Specified by:

getPermanentFlags in interface MessageManager.MetaData

Returns:

Flags that can be stored

See Also:

getPermanentFlags()

getRecent

public List<Long> getRecent()

Description copied from interface: MessageManager.MetaData

Gets the UIDs of recent messages if requested or an empty List otherwise.

Specified by:

getRecent in interface MessageManager.MetaData

Returns:

the uids flagged RECENT in this mailbox,

See Also:

getRecent()

getUidValidity

public long getUidValidity()

Description copied from interface: MessageManager.MetaData

Gets the UIDVALIDITY.

Specified by:

getUidValidity in interface MessageManager.MetaData

Returns:

UIDVALIDITY

See Also:

getUidValidity()

getUidNext

public long getUidNext()

Description copied from interface: MessageManager.MetaData

Gets the next UID predicted. The returned UID is not guaranteed to be the one that is assigned to the next message. Its only guaranteed that it will be at least equals or bigger then the value

Specified by:

getUidNext in interface MessageManager.MetaData

Returns:

the uid that will be assigned to the next appended message

See Also:

getUidNext()

getMessageCount

public long getMessageCount()

Description copied from interface: MessageManager.MetaData

Gets the number of messages that this mailbox contains. This is an optional property.

Specified by:

getMessageCount in interface MessageManager.MetaData

Returns:

number of messages contained or -1 when this optional data has not be requested

See Also:

getMessageCount()

getUnseenCount

public long getUnseenCount()

Description copied from interface: MessageManager.MetaData

Gets the number of unseen messages contained in this mailbox. This is an optional property.

Specified by:

getUnseenCount in interface MessageManager.MetaData

Returns:

number of unseen messages contained or zero when this optional data has not been requested

See Also:

getUnseenCount()

getFirstUnseen

public Long getFirstUnseen()

Description copied from interface: MessageManager.MetaData

Gets the UID of the first unseen message. This is an optional property.

Specified by:

getFirstUnseen in interface MessageManager.MetaData

Returns:

uid of the first unseen message, or null when there are no unseen messages

See Also:

getFirstUnseen()

isWriteable

public boolean isWriteable()

Description copied from interface: MessageManager.MetaData

Is this mailbox writable?

Specified by:

isWriteable in interface MessageManager.MetaData

Returns:

true if read-write, false if read only

See Also:

isWriteable()

getHighestModSeq

public long getHighestModSeq()

Description copied from interface: MessageManager.MetaData

Return the highest mod-sequence for the mailbox. If this value has changed till the last check you can be sure that some changes where happen on the mailbox

Specified by:

getHighestModSeq in interface MessageManager.MetaData

Returns:

higestModSeq

See Also:

getHighestModSeq()

isModSeqPermanent

public boolean isModSeqPermanent()

Description copied from interface: MessageManager.MetaData

Return true if the mailbox does store the mod-sequences in a permanent way

Specified by:

isModSeqPermanent in interface MessageManager.MetaData

Returns:

permanent

See Also:

isModSeqPermanent()

getACL

public MailboxACL getACL()

Description copied from interface: MessageManager.MetaData

Returns the ACL concerning this mailbox.

Specified by:

getACL in interface MessageManager.MetaData

Returns:

acl