org.apache.james.mailrepository.javamail
Class FolderAdapter

java.lang.Object
  extended by org.apache.james.mailrepository.javamail.FolderAdapter
All Implemented Interfaces:
FolderInterface
Direct Known Subclasses:
UIDPlusFolderAdapter

public class FolderAdapter
extends java.lang.Object
implements FolderInterface

Simple 1:1 wrapper that holds a javax.mail.Folder internally to be accessed through the FolderInterface


Field Summary
protected  javax.mail.Folder folder
           
 
Constructor Summary
FolderAdapter(javax.mail.Folder folder)
          Constructor
 
Method Summary
 void addConnectionListener(javax.mail.event.ConnectionListener l)
           
 void addFolderListener(javax.mail.event.FolderListener l)
           
 void addMessageChangedListener(javax.mail.event.MessageChangedListener l)
           
 void addMessageCountListener(javax.mail.event.MessageCountListener l)
           
 void appendMessages(javax.mail.Message[] msgs)
           
 void close(boolean expunge)
           
 void copyMessages(javax.mail.Message[] msgs, javax.mail.Folder folder)
           
 boolean create(int type)
           
 boolean delete(boolean recurse)
           
 boolean equals(java.lang.Object obj)
           
 boolean exists()
           
 javax.mail.Message[] expunge()
           
 void fetch(javax.mail.Message[] msgs, javax.mail.FetchProfile fp)
           
 int getDeletedMessageCount()
           
 javax.mail.Folder getFolder(java.lang.String name)
           
 java.lang.String getFullName()
           
 javax.mail.Message getMessage(int msgnum)
           
 int getMessageCount()
           
 javax.mail.Message[] getMessages()
           
 javax.mail.Message[] getMessages(int[] msgnums)
           
 javax.mail.Message[] getMessages(int start, int end)
           
 int getMode()
           
 java.lang.String getName()
           
 int getNewMessageCount()
           
 javax.mail.Folder getParent()
           
 javax.mail.Flags getPermanentFlags()
           
 char getSeparator()
           
 javax.mail.Store getStore()
           
 int getType()
           
 int getUnreadMessageCount()
           
 javax.mail.URLName getURLName()
           
 int hashCode()
           
 boolean hasNewMessages()
           
 boolean isOpen()
           
 boolean isSubscribed()
           
 javax.mail.Folder[] list()
           
 FolderInterface[] list(java.lang.String pattern)
           
 javax.mail.Folder[] listSubscribed()
           
 javax.mail.Folder[] listSubscribed(java.lang.String pattern)
           
 void open(int mode)
           
 void removeConnectionListener(javax.mail.event.ConnectionListener l)
           
 void removeFolderListener(javax.mail.event.FolderListener l)
           
 void removeMessageChangedListener(javax.mail.event.MessageChangedListener l)
           
 void removeMessageCountListener(javax.mail.event.MessageCountListener l)
           
 boolean renameTo(javax.mail.Folder f)
           
 javax.mail.Message[] search(javax.mail.search.SearchTerm term)
           
 javax.mail.Message[] search(javax.mail.search.SearchTerm term, javax.mail.Message[] msgs)
           
 void setFlags(int[] msgnums, javax.mail.Flags flag, boolean value)
           
 void setFlags(int start, int end, javax.mail.Flags flag, boolean value)
           
 void setFlags(javax.mail.Message[] msgs, javax.mail.Flags flag, boolean value)
           
 void setSubscribed(boolean subscribe)
           
 java.lang.String toString()
           
protected  FolderInterface wrapFolder(javax.mail.Folder folder)
          Wrap Folder in this class
protected  FolderInterface[] wrapFolders(javax.mail.Folder[] folders)
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

folder

protected javax.mail.Folder folder
Constructor Detail

FolderAdapter

public FolderAdapter(javax.mail.Folder folder)
Constructor

Parameters:
folder - the Folder
Method Detail

addConnectionListener

public void addConnectionListener(javax.mail.event.ConnectionListener l)
See Also:
Folder.addConnectionListener(ConnectionListener)

addFolderListener

public void addFolderListener(javax.mail.event.FolderListener l)
See Also:
Folder.addFolderListener(FolderListener)

addMessageChangedListener

public void addMessageChangedListener(javax.mail.event.MessageChangedListener l)
See Also:
Folder.addMessageChangedListener(MessageChangedListener)

addMessageCountListener

public void addMessageCountListener(javax.mail.event.MessageCountListener l)
See Also:
Folder.addMessageCountListener(MessageCountListener)

appendMessages

public void appendMessages(javax.mail.Message[] msgs)
                    throws javax.mail.MessagingException
Specified by:
appendMessages in interface FolderInterface
Throws:
javax.mail.MessagingException
See Also:
FolderInterface.appendMessages(javax.mail.Message[])

close

public void close(boolean expunge)
           throws javax.mail.MessagingException
Specified by:
close in interface FolderInterface
Throws:
javax.mail.MessagingException
See Also:
FolderInterface.close(boolean)

copyMessages

public void copyMessages(javax.mail.Message[] msgs,
                         javax.mail.Folder folder)
                  throws javax.mail.MessagingException
Throws:
javax.mail.MessagingException
See Also:
Folder.copyMessages(Message[], Folder)

create

public boolean create(int type)
               throws javax.mail.MessagingException
Specified by:
create in interface FolderInterface
Throws:
javax.mail.MessagingException
See Also:
FolderInterface.create(int)

delete

public boolean delete(boolean recurse)
               throws javax.mail.MessagingException
Specified by:
delete in interface FolderInterface
Throws:
javax.mail.MessagingException
See Also:
FolderInterface.delete(boolean)

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class java.lang.Object
See Also:
Object.equals(Object)

exists

public boolean exists()
               throws javax.mail.MessagingException
Specified by:
exists in interface FolderInterface
Throws:
javax.mail.MessagingException
See Also:
FolderInterface.exists()

expunge

public javax.mail.Message[] expunge()
                             throws javax.mail.MessagingException
Specified by:
expunge in interface FolderInterface
Throws:
javax.mail.MessagingException
See Also:
FolderInterface.expunge()

fetch

public void fetch(javax.mail.Message[] msgs,
                  javax.mail.FetchProfile fp)
           throws javax.mail.MessagingException
Throws:
javax.mail.MessagingException
See Also:
Folder.fetch(Message[], FetchProfile)

getDeletedMessageCount

public int getDeletedMessageCount()
                           throws javax.mail.MessagingException
Throws:
javax.mail.MessagingException
See Also:
Folder.getDeletedMessageCount()

getFolder

public javax.mail.Folder getFolder(java.lang.String name)
                            throws javax.mail.MessagingException
Throws:
javax.mail.MessagingException
See Also:
Folder.getFolder(String)

getFullName

public java.lang.String getFullName()
Specified by:
getFullName in interface FolderInterface
See Also:
FolderInterface.getFullName()

getMessage

public javax.mail.Message getMessage(int msgnum)
                              throws javax.mail.MessagingException
Specified by:
getMessage in interface FolderInterface
Throws:
javax.mail.MessagingException
See Also:
FolderInterface.getMessage(int)

getMessageCount

public int getMessageCount()
                    throws javax.mail.MessagingException
Specified by:
getMessageCount in interface FolderInterface
Throws:
javax.mail.MessagingException
See Also:
FolderInterface.getMessageCount()

getMessages

public javax.mail.Message[] getMessages()
                                 throws javax.mail.MessagingException
Specified by:
getMessages in interface FolderInterface
Throws:
javax.mail.MessagingException
See Also:
FolderInterface.getMessages()

getMessages

public javax.mail.Message[] getMessages(int start,
                                        int end)
                                 throws javax.mail.MessagingException
Throws:
javax.mail.MessagingException
See Also:
Folder.getMessages(int, int)

getMessages

public javax.mail.Message[] getMessages(int[] msgnums)
                                 throws javax.mail.MessagingException
Throws:
javax.mail.MessagingException
See Also:
Folder.getMessages(int[])

getMode

public int getMode()
See Also:
Folder.getMode()

getName

public java.lang.String getName()
Specified by:
getName in interface FolderInterface
See Also:
FolderInterface.getName()

getNewMessageCount

public int getNewMessageCount()
                       throws javax.mail.MessagingException
Specified by:
getNewMessageCount in interface FolderInterface
Throws:
javax.mail.MessagingException
See Also:
FolderInterface.getNewMessageCount()

getParent

public javax.mail.Folder getParent()
                            throws javax.mail.MessagingException
Throws:
javax.mail.MessagingException
See Also:
Folder.getParent()

getPermanentFlags

public javax.mail.Flags getPermanentFlags()
Specified by:
getPermanentFlags in interface FolderInterface
See Also:
FolderInterface.getPermanentFlags()

getSeparator

public char getSeparator()
                  throws javax.mail.MessagingException
Throws:
javax.mail.MessagingException
See Also:
Folder.getSeparator()

getStore

public javax.mail.Store getStore()
See Also:
Folder.getStore()

getType

public int getType()
            throws javax.mail.MessagingException
Specified by:
getType in interface FolderInterface
Throws:
javax.mail.MessagingException
See Also:
FolderInterface.getType()

getUnreadMessageCount

public int getUnreadMessageCount()
                          throws javax.mail.MessagingException
Specified by:
getUnreadMessageCount in interface FolderInterface
Throws:
javax.mail.MessagingException
See Also:
FolderInterface.getUnreadMessageCount()

getURLName

public javax.mail.URLName getURLName()
                              throws javax.mail.MessagingException
Throws:
javax.mail.MessagingException
See Also:
Folder.getURLName()

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object
See Also:
Object.hashCode()

hasNewMessages

public boolean hasNewMessages()
                       throws javax.mail.MessagingException
Throws:
javax.mail.MessagingException
See Also:
Folder.hasNewMessages()

isOpen

public boolean isOpen()
Specified by:
isOpen in interface FolderInterface
See Also:
FolderInterface.isOpen()

isSubscribed

public boolean isSubscribed()
See Also:
Folder.isSubscribed()

list

public javax.mail.Folder[] list()
                         throws javax.mail.MessagingException
Throws:
javax.mail.MessagingException
See Also:
Folder.list()

list

public FolderInterface[] list(java.lang.String pattern)
                       throws javax.mail.MessagingException
Specified by:
list in interface FolderInterface
Throws:
javax.mail.MessagingException
See Also:
FolderInterface.list(java.lang.String)

listSubscribed

public javax.mail.Folder[] listSubscribed()
                                   throws javax.mail.MessagingException
Throws:
javax.mail.MessagingException
See Also:
Folder.listSubscribed()

listSubscribed

public javax.mail.Folder[] listSubscribed(java.lang.String pattern)
                                   throws javax.mail.MessagingException
Throws:
javax.mail.MessagingException
See Also:
Folder.listSubscribed(String)

open

public void open(int mode)
          throws javax.mail.MessagingException
Specified by:
open in interface FolderInterface
Throws:
javax.mail.MessagingException
See Also:
FolderInterface.open(int)

removeConnectionListener

public void removeConnectionListener(javax.mail.event.ConnectionListener l)
See Also:
Folder.removeConnectionListener(ConnectionListener)

removeFolderListener

public void removeFolderListener(javax.mail.event.FolderListener l)
See Also:
Folder.removeFolderListener(FolderListener)

removeMessageChangedListener

public void removeMessageChangedListener(javax.mail.event.MessageChangedListener l)
See Also:
Folder.removeMessageChangedListener(MessageChangedListener)

removeMessageCountListener

public void removeMessageCountListener(javax.mail.event.MessageCountListener l)
See Also:
Folder.removeMessageCountListener(MessageCountListener)

renameTo

public boolean renameTo(javax.mail.Folder f)
                 throws javax.mail.MessagingException
Specified by:
renameTo in interface FolderInterface
Throws:
javax.mail.MessagingException
See Also:
FolderInterface.renameTo(javax.mail.Folder)

search

public javax.mail.Message[] search(javax.mail.search.SearchTerm term,
                                   javax.mail.Message[] msgs)
                            throws javax.mail.MessagingException
Throws:
javax.mail.MessagingException
See Also:
Folder.search(SearchTerm, Message[])

search

public javax.mail.Message[] search(javax.mail.search.SearchTerm term)
                            throws javax.mail.MessagingException
Throws:
javax.mail.MessagingException
See Also:
Folder.search(SearchTerm)

setFlags

public void setFlags(int start,
                     int end,
                     javax.mail.Flags flag,
                     boolean value)
              throws javax.mail.MessagingException
Throws:
javax.mail.MessagingException
See Also:
Folder.setFlags(int, int, Flags, boolean)

setFlags

public void setFlags(int[] msgnums,
                     javax.mail.Flags flag,
                     boolean value)
              throws javax.mail.MessagingException
Throws:
javax.mail.MessagingException
See Also:
Folder.setFlags(int[], Flags, boolean)

setFlags

public void setFlags(javax.mail.Message[] msgs,
                     javax.mail.Flags flag,
                     boolean value)
              throws javax.mail.MessagingException
Throws:
javax.mail.MessagingException
See Also:
Folder.setFlags(Message[], Flags, boolean)

setSubscribed

public void setSubscribed(boolean subscribe)
                   throws javax.mail.MessagingException
Throws:
javax.mail.MessagingException
See Also:
Folder.setSubscribed(boolean)

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object
See Also:
Folder.toString()

wrapFolder

protected FolderInterface wrapFolder(javax.mail.Folder folder)
Wrap Folder in this class

Parameters:
folder - the folder to wrap
Returns:
new instance of this class wrapped

wrapFolders

protected FolderInterface[] wrapFolders(javax.mail.Folder[] folders)
See Also:
wrapFolder(Folder)


Copyright ? 2002-2009 The Apache Software Foundation. All Rights Reserved.