org.apache.james.mailbox.maildir.mail

Class MaildirMailboxMapper

java.lang.Object

org.apache.james.mailbox.store.transaction.NonTransactionalMapper

org.apache.james.mailbox.maildir.mail.MaildirMailboxMapper

All Implemented Interfaces:

MailboxMapper<Integer>, Mapper

public class MaildirMailboxMapper
extends NonTransactionalMapper
implements MailboxMapper<Integer>

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.james.mailbox.store.transaction.Mapper

Mapper.Transaction<T>, Mapper.VoidTransaction

Constructor Summary

Constructors

Constructor and Description
MaildirMailboxMapper(MaildirStore maildirStore, MailboxSession session)

Method Summary

Methods

Modifier and Type	Method and Description
void	delete(Mailbox<Integer> mailbox) Delete the given Mailbox from the underlying storage
void	endRequest() IMAP Request was complete.
Mailbox<Integer>	findMailboxByPath(MailboxPath mailboxPath) Return the Mailbox for the given name
List<Mailbox<Integer>>	findMailboxWithPathLike(MailboxPath mailboxPath) Return a List of Mailbox which name is like the given name
boolean	hasChildren(Mailbox<Integer> mailbox, char delimiter) Return if the given Mailbox has children
List<Mailbox<Integer>>	list() Return a unmodifable List of all Mailbox
void	save(Mailbox<Integer> mailbox) Save the give Mailbox to the underlying storage

Methods inherited from class org.apache.james.mailbox.store.transaction.NonTransactionalMapper

execute

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.james.mailbox.store.transaction.Mapper

execute

Constructor Detail

MaildirMailboxMapper

public MaildirMailboxMapper(MaildirStore maildirStore,
                    MailboxSession session)

Method Detail

delete

public void delete(Mailbox<Integer> mailbox)
            throws MailboxException

Description copied from interface: MailboxMapper

Delete the given Mailbox from the underlying storage

Specified by:

delete in interface MailboxMapper<Integer>

Throws:

MailboxException

See Also:

MailboxMapper.delete(org.apache.james.mailbox.store.mail.model.Mailbox)

findMailboxByPath

public Mailbox<Integer> findMailboxByPath(MailboxPath mailboxPath)
                                   throws MailboxException,
                                          MailboxNotFoundException

Description copied from interface: MailboxMapper

Return the Mailbox for the given name

Specified by:

findMailboxByPath in interface MailboxMapper<Integer>

Returns:

mailbox

Throws:

MailboxException

MailboxNotFoundException

See Also:

MailboxMapper.findMailboxByPath(org.apache.james.mailbox.model.MailboxPath)

findMailboxWithPathLike

public List<Mailbox<Integer>> findMailboxWithPathLike(MailboxPath mailboxPath)
                                               throws MailboxException

Description copied from interface: MailboxMapper

Return a List of Mailbox which name is like the given name

Specified by:

findMailboxWithPathLike in interface MailboxMapper<Integer>

Returns:

mailboxList

Throws:

MailboxException

See Also:

MailboxMapper.findMailboxWithPathLike(org.apache.james.mailbox.model.MailboxPath)

hasChildren

public boolean hasChildren(Mailbox<Integer> mailbox,
                  char delimiter)
                    throws MailboxException,
                           MailboxNotFoundException

Description copied from interface: MailboxMapper

Return if the given Mailbox has children

Specified by:

hasChildren in interface MailboxMapper<Integer>

Parameters:

mailbox - not null

delimiter - path delimiter

Returns:

true when the mailbox has children, false otherwise

Throws:

MailboxException

MailboxNotFoundException

See Also:

MailboxMapper.hasChildren(org.apache.james.mailbox.store.mail.model.Mailbox, char)

save

public void save(Mailbox<Integer> mailbox)
          throws MailboxException

Description copied from interface: MailboxMapper

Save the give Mailbox to the underlying storage

Specified by:

save in interface MailboxMapper<Integer>

Throws:

MailboxException

See Also:

MailboxMapper.save(org.apache.james.mailbox.store.mail.model.Mailbox)

list

public List<Mailbox<Integer>> list()
                            throws MailboxException

Description copied from interface: MailboxMapper

Return a unmodifable List of all Mailbox

Specified by:

list in interface MailboxMapper<Integer>

Returns:

mailboxList

Throws:

MailboxException

See Also:

MailboxMapper.list()

endRequest

public void endRequest()

Description copied from interface: Mapper

IMAP Request was complete. Cleanup all Request scoped stuff

Specified by:

endRequest in interface Mapper

See Also:

Mapper.endRequest()