org.apache.james.imap.processor.base

Class SelectedMailboxImpl

java.lang.Object

org.apache.james.imap.processor.base.SelectedMailboxImpl

All Implemented Interfaces:

SelectedMailbox, org.apache.james.mailbox.MailboxListener

public class SelectedMailboxImpl
extends Object
implements SelectedMailbox, org.apache.james.mailbox.MailboxListener

Default implementation of SelectedMailbox

Nested Class Summary

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

org.apache.james.mailbox.MailboxListener.Added, org.apache.james.mailbox.MailboxListener.Event, org.apache.james.mailbox.MailboxListener.Expunged, org.apache.james.mailbox.MailboxListener.FlagsUpdated, org.apache.james.mailbox.MailboxListener.MailboxACLUpdated, org.apache.james.mailbox.MailboxListener.MailboxAdded, org.apache.james.mailbox.MailboxListener.MailboxDeletion, org.apache.james.mailbox.MailboxListener.MailboxRenamed, org.apache.james.mailbox.MailboxListener.MessageEvent

Field Summary

Fields inherited from interface org.apache.james.imap.api.process.SelectedMailbox

NO_SUCH_MESSAGE

Constructor Summary

Constructors

Constructor and Description
SelectedMailboxImpl(org.apache.james.mailbox.MailboxManager mailboxManager, ImapSession session, org.apache.james.mailbox.model.MailboxPath path)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addRecent(long uid) Add a recent uid
void	deselect() Deselect the Mailbox
void	event(org.apache.james.mailbox.MailboxListener.Event event)
long	existsCount() Return the count of all existing uids
Collection<Long>	expungedUids() Return a unmodifiable Collection of uids that where expunged
Collection<Long>	flagUpdateUids() Return a unmodifiable Collection of uids which have updated flags
javax.mail.Flags	getApplicableFlags() Return all applicable Flags for the selected mailbox
long	getFirstUid() Return the uid of the first message in the mailbox or -1 if the mailbox is empty
long	getLastUid() Return the uid of the last message in the mailbox or -1 if the mailbox is empty
org.apache.james.mailbox.model.MailboxPath	getPath() Return the path of the selected Mailbox
Collection<Long>	getRecent() Return a Collection of all recent uids
boolean	hasNewApplicableFlags()
boolean	isDeletedByOtherSession() Is the mailbox deleted?
boolean	isRecent(long uid) Is the given uid recent ?
boolean	isRecentUidRemoved() Was the recent uid removed ?
boolean	isSilentFlagChanges() Are flag changes from current session ignored?
boolean	isSizeChanged() Has the size of the mailbox changed?
int	msn(long uid) Return the msg index of the given uid or SelectedMailbox.NO_SUCH_MESSAGE if no message with the given uid was found
int	recentCount() Return the count of all recent uids
int	remove(Long uid) Removes the given UID.
boolean	removeRecent(long uid) Remove a recent uid
void	resetEvents() Reset all events
void	resetExpungedUids()
void	resetNewApplicableFlags()
void	resetRecentUidRemoved()
void	setSilentFlagChanges(boolean silentFlagChanges) Sets whether changes from current session should be ignored.
long	uid(int msn) Return the uid of the message for the given index or SelectedMailbox.NO_SUCH_MESSAGE if no message with the given index was found

Methods inherited from class java.lang.Object

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

Constructor Detail

SelectedMailboxImpl

public SelectedMailboxImpl(org.apache.james.mailbox.MailboxManager mailboxManager,
                   ImapSession session,
                   org.apache.james.mailbox.model.MailboxPath path)
                    throws org.apache.james.mailbox.exception.MailboxException

Throws:

org.apache.james.mailbox.exception.MailboxException

Method Detail

getFirstUid

public long getFirstUid()

Description copied from interface: SelectedMailbox

Return the uid of the first message in the mailbox or -1 if the mailbox is empty

Specified by:

getFirstUid in interface SelectedMailbox

Returns:

firstUid

See Also:

SelectedMailbox.getFirstUid()

getLastUid

public long getLastUid()

Description copied from interface: SelectedMailbox

Return the uid of the last message in the mailbox or -1 if the mailbox is empty

Specified by:

getLastUid in interface SelectedMailbox

Returns:

lastUid

See Also:

SelectedMailbox.getLastUid()

deselect

public void deselect()

Description copied from interface: SelectedMailbox

Deselect the Mailbox

Specified by:

deselect in interface SelectedMailbox

removeRecent

public boolean removeRecent(long uid)

Description copied from interface: SelectedMailbox

Remove a recent uid

Specified by:

removeRecent in interface SelectedMailbox

Returns:

true if it was successfully

See Also:

SelectedMailbox.removeRecent(long)

addRecent

public boolean addRecent(long uid)

Description copied from interface: SelectedMailbox

Add a recent uid

Specified by:

addRecent in interface SelectedMailbox

Returns:

true if it was successfully

See Also:

SelectedMailbox.addRecent(long)

getRecent

public Collection<Long> getRecent()

Description copied from interface: SelectedMailbox

Return a Collection of all recent uids

Specified by:

getRecent in interface SelectedMailbox

Returns:

recentUids

See Also:

SelectedMailbox.getRecent()

recentCount

public int recentCount()

Description copied from interface: SelectedMailbox

Return the count of all recent uids

Specified by:

recentCount in interface SelectedMailbox

Returns:

recentCount

See Also:

SelectedMailbox.recentCount()

getPath

public org.apache.james.mailbox.model.MailboxPath getPath()

Description copied from interface: SelectedMailbox

Return the path of the selected Mailbox

Specified by:

getPath in interface SelectedMailbox

Returns:

path

See Also:

SelectedMailbox.getPath()

isRecent

public boolean isRecent(long uid)

Description copied from interface: SelectedMailbox

Is the given uid recent ?

Specified by:

isRecent in interface SelectedMailbox

Returns:

true if the given uid is recent

See Also:

SelectedMailbox.isRecent(long)

isRecentUidRemoved

public boolean isRecentUidRemoved()

Description copied from interface: SelectedMailbox

Was the recent uid removed ?

Specified by:

isRecentUidRemoved in interface SelectedMailbox

Returns:

true if the recent uid for this mailbox was removed

See Also:

SelectedMailbox.isRecentUidRemoved()

resetRecentUidRemoved

public void resetRecentUidRemoved()

Specified by:

resetRecentUidRemoved in interface SelectedMailbox

See Also:

SelectedMailbox.resetRecentUidRemoved()

resetEvents

public void resetEvents()

Description copied from interface: SelectedMailbox

Reset all events

Specified by:

resetEvents in interface SelectedMailbox

See Also:

SelectedMailbox.resetEvents()

remove

public int remove(Long uid)

Description copied from interface: SelectedMailbox

Removes the given UID.

Specified by:

remove in interface SelectedMailbox

Parameters:

uid - not null

Returns:

the message sequence number that the UID held before or SelectedMailbox.NO_SUCH_MESSAGE if no message with the given uid was found being expunged

See Also:

SelectedMailbox.remove(java.lang.Long)

resetExpungedUids

public void resetExpungedUids()

Specified by:

resetExpungedUids in interface SelectedMailbox

isSilentFlagChanges

public final boolean isSilentFlagChanges()

Are flag changes from current session ignored?

Returns:

true if any flag changes from current session will be ignored, false otherwise

setSilentFlagChanges

public final void setSilentFlagChanges(boolean silentFlagChanges)

Sets whether changes from current session should be ignored.

Parameters:

silentFlagChanges - true if any flag changes from current session should be ignored, false otherwise

isSizeChanged

public final boolean isSizeChanged()

Has the size of the mailbox changed?

Specified by:

isSizeChanged in interface SelectedMailbox

Returns:

true if new messages have been added, false otherwise

isDeletedByOtherSession

public final boolean isDeletedByOtherSession()

Is the mailbox deleted?

Specified by:

isDeletedByOtherSession in interface SelectedMailbox

Returns:

true when the mailbox has been deleted by another session, false otherwise

flagUpdateUids

public Collection<Long> flagUpdateUids()

Return a unmodifiable Collection of uids which have updated flags

Specified by:

flagUpdateUids in interface SelectedMailbox

Returns:

uids

expungedUids

public Collection<Long> expungedUids()

Return a unmodifiable Collection of uids that where expunged

Specified by:

expungedUids in interface SelectedMailbox

Returns:

uids

getApplicableFlags

public javax.mail.Flags getApplicableFlags()

Description copied from interface: SelectedMailbox

Return all applicable Flags for the selected mailbox

Specified by:

getApplicableFlags in interface SelectedMailbox

Returns:

flags

hasNewApplicableFlags

public boolean hasNewApplicableFlags()

Specified by:

hasNewApplicableFlags in interface SelectedMailbox

resetNewApplicableFlags

public void resetNewApplicableFlags()

Specified by:

resetNewApplicableFlags in interface SelectedMailbox

event

public void event(org.apache.james.mailbox.MailboxListener.Event event)

Specified by:

event in interface org.apache.james.mailbox.MailboxListener

msn

public int msn(long uid)

Description copied from interface: SelectedMailbox

Return the msg index of the given uid or SelectedMailbox.NO_SUCH_MESSAGE if no message with the given uid was found

Specified by:

msn in interface SelectedMailbox

Returns:

index

uid

public long uid(int msn)

Description copied from interface: SelectedMailbox

Return the uid of the message for the given index or SelectedMailbox.NO_SUCH_MESSAGE if no message with the given index was found

Specified by:

uid in interface SelectedMailbox

Returns:

uid

existsCount

public long existsCount()

Description copied from interface: SelectedMailbox

Return the count of all existing uids

Specified by:

existsCount in interface SelectedMailbox

Returns:

existsCount