net.fortuna.mstor.connector
Interface FolderDelegate<T extends MessageDelegate>

Type Parameters:

T - the type of message delegate supported

All Known Implementing Classes:

AbstractFolderDelegate, AbstractMetaFolder, JcrFolder, MboxFolder, MetaFolder, NntpFolder, YamlMetaFolder

public interface FolderDelegate<T extends MessageDelegate>

Implementors support delegation of specific functions from MStorFolder.

Author:

Ben

 $Id$

 Created on 30/07/2007
 

Method Summary

long	allocateUid(MessageDelegate message) Allocates a new message UID for the folder.
void	appendMessages(javax.mail.Message[] messages) Append the specified messages to this delegate.
void	close() Close the folder delegate.
boolean	create(int type) Initialise the delegate based on the specified folder type.
boolean	delete() Delete the folder delegate.
boolean	exists() Indicates whether the folder represented by this delegate exists.
void	expunge(javax.mail.Message[] deleted) Permanently delete the specified messages from this delegate.
int	getDeletedMessageCount() Optional support for more efficient implementation.
FolderDelegate<T>	getFolder(java.lang.String name) Returns a child folder delegate with the specified name.
java.lang.String	getFolderName()
java.lang.String	getFullName()
long	getLastModified() Returns the last modification timestamp of this folder.
long	getLastUid() Retrieves the last allocated message UID for the folder.
T	getMessage(int messageNumber) Returns message delegate corresponding to the specified message id.
java.io.InputStream	getMessageAsStream(int index) Returns an input stream from which to read the specified message.
int	getMessageCount() Returns the number of messages in the folder delegate.
FolderDelegate<T>	getParent()
char	getSeparator()
int	getType()
long	getUidValidity() Returns the UID validity associated with the metadata.
FolderDelegate<T>[]	list(java.lang.String pattern) Returns a list of child folder delegates matching the specified pattern.
void	open(int mode) Open the folder delegate.
boolean	renameTo(java.lang.String name) Rename the folder delegate.

Method Detail

getFolderName

java.lang.String getFolderName()

Returns:

Returns the name.

getFullName

java.lang.String getFullName()

Returns:

the full name of the folder.

getParent

FolderDelegate<T> getParent()

Returns:

the parent folder delegate of this delegate.

exists

boolean exists()

Indicates whether the folder represented by this delegate exists.

Returns:

true if the folder exists, otherwise false

getType

int getType()

Returns:

the type of folder this delegate represents.

See Also:

Folder.HOLDS_FOLDERS, Folder.HOLDS_MESSAGES

list

FolderDelegate<T>[] list(java.lang.String pattern)

Returns a list of child folder delegates matching the specified pattern.

Parameters:

pattern - a pattern to match folders against

Returns:

a list of folder delegates

getSeparator

char getSeparator()

Returns:

the folder separator for this delegate type.

create

boolean create(int type)
               throws javax.mail.MessagingException

Initialise the delegate based on the specified folder type.

Parameters:

type - a folder type

Returns:

true if the delegate is created, otherwise false

Throws:

javax.mail.MessagingException - where an unexpected error occurs creating the delegate

getFolder

FolderDelegate<T> getFolder(java.lang.String name)
                                                    throws javax.mail.MessagingException

Returns a child folder delegate with the specified name.

Parameters:

name - a folder name

Returns:

the folder delegate with the specified name, or null if the folder doesn't exist

Throws:

javax.mail.MessagingException - where an unexpected error occurs retrieving the folder

delete

boolean delete()

Delete the folder delegate.

Returns:

true if the delegate is deleted, otherwise false

renameTo

boolean renameTo(java.lang.String name)

Rename the folder delegate.

Parameters:

name - the new folder name

Returns:

true if the folder is renamed, otherwise false

open

void open(int mode)

Open the folder delegate.

Parameters:

mode - the mode to open the folder

See Also:

Folder.READ_ONLY, Folder.READ_WRITE

close

void close()
           throws javax.mail.MessagingException

Close the folder delegate.

Throws:

javax.mail.MessagingException - where an unexpected error occurs closing the folder

getMessageCount

int getMessageCount()
                    throws javax.mail.MessagingException

Returns the number of messages in the folder delegate.

Returns:

the total message count

Throws:

javax.mail.MessagingException - where an unexpected error occurs retrieving the message count

getDeletedMessageCount

int getDeletedMessageCount()
                           throws javax.mail.MessagingException,
                                  java.lang.UnsupportedOperationException

Optional support for more efficient implementation.

Returns:

the total deleted message count

Throws:

javax.mail.MessagingException - where an unexpected error occurs

java.lang.UnsupportedOperationException - if this method is not supported by the folder implementation

getMessageAsStream

java.io.InputStream getMessageAsStream(int index)
                                       throws java.io.IOException

Returns an input stream from which to read the specified message.

Parameters:

index - the index of the message to return

Returns:

an input stream for the specified message

Throws:

java.io.IOException - where an error occurs

appendMessages

void appendMessages(javax.mail.Message[] messages)
                    throws javax.mail.MessagingException

Append the specified messages to this delegate.

Parameters:

messages - an array of messages to append to the folder

Throws:

javax.mail.MessagingException - where an error occurs appending the messages

expunge

void expunge(javax.mail.Message[] deleted)
             throws javax.mail.MessagingException

Permanently delete the specified messages from this delegate.

Parameters:

deleted - an array of deleted messages to expunge

Throws:

javax.mail.MessagingException - where an error occurs expunging the messages

getMessage

T getMessage(int messageNumber)
                                     throws DelegateException

Returns message delegate corresponding to the specified message id. If no delegate exists a new Message delegate is created.

Parameters:

messageNumber - the message number of the message to retrieve

Returns:

the message with the specified message number, or null if the messages doesn't exist

Throws:

DelegateException - where an error occurs retrieving the message

getLastUid

long getLastUid()
                throws java.lang.UnsupportedOperationException

Retrieves the last allocated message UID for the folder.

Returns:

the latest UID for the folder

Throws:

java.lang.UnsupportedOperationException - if this method is not supported by the folder implementation

allocateUid

long allocateUid(MessageDelegate message)
                 throws java.lang.UnsupportedOperationException,
                        DelegateException

Allocates a new message UID for the folder.

Parameters:

message - the message to allocate a UID value to

Returns:

the allocated UID for the specified message

Throws:

DelegateException - where an error occurs allocating a UID

java.lang.UnsupportedOperationException - if this method is not supported by the folder implementation

getUidValidity

long getUidValidity()
                    throws java.lang.UnsupportedOperationException,
                           javax.mail.MessagingException

Returns the UID validity associated with the metadata. If no UID validity exist a new value is initialised.

Returns:

a long representation of the UID validity

Throws:

java.lang.UnsupportedOperationException - if this method is not supported by the folder implementation

javax.mail.MessagingException - if an error occurs retrieving the validity value

getLastModified

long getLastModified()
                     throws java.lang.UnsupportedOperationException

Returns the last modification timestamp of this folder.

Returns:

a timestamp as a long value

Throws:

java.lang.UnsupportedOperationException - if this method is not supported by the folder implementation