MaildirFolderData (Extend 2.0.4 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.abstracthorizon.mercury.maildir
Class MaildirFolderData

java.lang.Object
  javax.mail.Folder
      org.abstracthorizon.mercury.maildir.MaildirFolderData

Direct Known Subclasses:: UIDMaildirFolderData

public class MaildirFolderData
extends javax.mail.Folder
extends javax.mail.Folder

Folder data actually represents the model of the maildir folder. This class handles all model operations - all operations that are low level and deal with files and directories.

This folder data serves as central repository for messages over a directory. Each directory will have only one folder data for store. That is maintained in store itself

Messages that are present in folder data are later wrapped inside of folder. Pair of (message, file) is kept in folder data's cache. Cache for each directory is maintained as long as there are opened folders over that directory. After that time it is left to be collected throught weak reference. If folder over folder data is opened before reference is garbage collected it is reused.

Author:: Daniel Sendula

Nested Class Summary
`protected static class`	`MaildirFolderData.Data` Folders data class.

Field Summary
`protected File`	`base` Directory folder data is for
`protected String`	`cachedFullName` Cached folder's full name
`protected String`	`cachedName` Cached folder's name
`protected Reference<MaildirFolderData.Data>`	`closedRef` Weak reference to data when there are no open folders
`protected File`	`cur` Cur subdirectory
`protected MaildirFolderData.Data`	`data` Folder's data
`protected int`	`delay` Amount of time between two accesses.
`protected int`	`delayFactor` Delay factor - amount of time needed for reading directory vs delay.
`protected long`	`lastAccess` Last time folder data was accessed or 0 if no open folders
`static String`	`NO_SUBFOLDERS_FILENAME` This constant defines a filename of a zero length flag file that denotes no subfolders are suppose to be created for this folder
`protected File`	`nw` New subdirectory
`protected int`	`openCount` Count of open folders.
`protected WeakHashMap<javax.mail.Folder,Object>`	`openedFolders` List of open folders
`protected javax.mail.Flags`	`permanentFlags` Permanent flags cache
`protected boolean`	`rootFolder` Flag to denote is this root folder or not
`static javax.mail.Flags`	`rootPermanentFlags` Permanent flags for root are user defined "\\Noselect"
`protected MaildirStore`	`store` Maildir store
`protected File`	`tmp` Tmp subdirectory
`protected int`	`type` Type of the folder.

Fields inherited from class javax.mail.Folder
`HOLDS_FOLDERS, HOLDS_MESSAGES, mode, READ_ONLY, READ_WRITE`

Constructor Summary
`MaildirFolderData(MaildirStore store, File file)` Constructor

Method Summary
`protected void`	`addMessages(MaildirFolder folder, List<MaildirMessage> messages)` This method adds messages to the folder.
`protected void`	`appendMessages(MaildirFolder folder, javax.mail.Message[] messages)` Appends messages to the folder.
`void`	`appendMessages(javax.mail.Message[] messages)` Appends messages to the maildir data.
`protected void`	`checkDirs()` This method checks if new, cur and tmp directories exist.
`void`	`close(boolean arg0)` This method is only to satisfy Folder interface.
`protected void`	`close(MaildirFolder folder)` This method is called with folder that is closing.
`boolean`	`create(int type)` Creates folder.
`protected MaildirMessage`	`createExistingMaildirMessage(File file, int num)` This method creates new maildir message object for existing file in folder data's directory.
`protected List<MessageBase>`	`createFolderMessages()` This method creates collection structure for storing messages in the folder.
`protected MaildirMessage`	`createNewMaildirMessage(javax.mail.internet.MimeMessage message, int num)` This method creates new maildir message for folder data (not folder).
`boolean`	`delete(boolean recursive)` Deletes folder.
`protected boolean`	`deleteAll(File file)` Utility method that deletes all subdirectories and files from given directory.
`boolean`	`exists()` Returns `true` if folder exists.
`javax.mail.Message[]`	`expunge()` This method is only to satisfy Folder interface.
`protected List<? extends javax.mail.Message>`	`expunge(MaildirFolder folder, boolean explicit)` Expunges messages for given folder.
`protected boolean`	`expungeMessage(MaildirMessage message)` Expunges one message
`protected File`	`getCurDir()` Returns folder's cur directory
`javax.mail.Folder`	`getFolder(String arg0)` This method is only to satisfy Folder interface.
`File`	`getFolderFile()` Returns folder's directory
`protected List<MaildirMessage>`	`getFolderMessages(MaildirFolder folder)` Returns folder's messages for given folder.
`String`	`getFullName()` Returns folder's full name (path and name)
`long`	`getLastAccessed()` Returns when this folder data is last accessd
`MaildirStore`	`getMaildirStore()` Returns maildir store
`javax.mail.Message`	`getMessage(int i)` This method is only to satisfy Folder interface.
`int`	`getMessageCount()` Returns message count.
`String`	`getName()` Returns folder's name
`protected File`	`getNewDir()` Returns folder's new directory
`int`	`getNewMessageCount()` Returns new message count.
`javax.mail.Folder`	`getParent()` This method is only to satisfy Folder interface.
`String`	`getParentFolderName()` Returns folder parent's name
`javax.mail.Flags`	`getPermanentFlags()` This method is only to satisfy Folder interface.
`char`	`getSeparator()` Returns "/"
`String`	`getSubFolderName(String name)` Returns name for given subfolder.
`protected File`	`getTmpDir()` Returns folder's tmp directory
`int`	`getType()` Returns folder's type.
`boolean`	`hasNewMessages()` This method is only to satisfy Folder interface.
`boolean`	`isOpen()` This method is only to satisfy Folder interface.
`protected boolean`	`isRootFolder()` Returns `true` if it is root folder
`javax.mail.Folder[]`	`list(String arg0)` This method is only to satisfy Folder interface.
`String[]`	`listNames(String pattern)` Lists subfolder names.
`protected void`	`obtainMessages()` This method reads directory and creates messages for given folder.
`void`	`open(int arg0)` This method is only to satisfy Folder interface.
`protected void`	`open(MaildirFolder folder)` This method is called by folder that is being opened.
`protected void`	`removeMessages(MaildirFolder folder, Collection<? extends javax.mail.internet.MimeMessage> messages)` This method removes folder messages.
`boolean`	`renameTo(javax.mail.Folder folder)` This method is only to satisfy Folder interface.
`MaildirFolderData`	`renameTo(MaildirFolderData folderData)` Renames folder to given folder data
`static void`	`renumerateMessages(int from, List<? extends MessageBase> messages)` Renumerates given list of maildir message objects
`protected void`	`setFolderFile(File file)` Sets folder's directory

Methods inherited from class javax.mail.Folder
addConnectionListener, addFolderListener, addMessageChangedListener, addMessageCountListener, copyMessages, fetch, finalize, getDeletedMessageCount, getMessages, getMessages, getMessages, getMode, getStore, getUnreadMessageCount, getURLName, isSubscribed, list, listSubscribed, listSubscribed, notifyConnectionListeners, notifyFolderListeners, notifyFolderRenamedListeners, notifyMessageAddedListeners, notifyMessageChangedListeners, notifyMessageRemovedListeners, removeConnectionListener, removeFolderListener, removeMessageChangedListener, removeMessageCountListener, search, search, setFlags, setFlags, setFlags, setSubscribed, toString

Methods inherited from class javax.mail.Folder

addConnectionListener, addFolderListener, addMessageChangedListener, addMessageCountListener, copyMessages, fetch, finalize, getDeletedMessageCount, getMessages, getMessages, getMessages, getMode, getStore, getUnreadMessageCount, getURLName, isSubscribed, list, listSubscribed, listSubscribed, notifyConnectionListeners, notifyFolderListeners, notifyFolderRenamedListeners, notifyMessageAddedListeners, notifyMessageChangedListeners, notifyMessageRemovedListeners, removeConnectionListener, removeFolderListener, removeMessageChangedListener, removeMessageCountListener, search, search, setFlags, setFlags, setFlags, setSubscribed, toString

Methods inherited from class java.lang.Object
`clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Field Detail

NO_SUBFOLDERS_FILENAME

public static final String NO_SUBFOLDERS_FILENAME

This constant defines a filename of a zero length flag file that denotes no subfolders are suppose to be created for this folder

See Also:: Constant Field Values

rootPermanentFlags

public static final javax.mail.Flags rootPermanentFlags

Permanent flags for root are user defined "\\Noselect"

permanentFlags

protected javax.mail.Flags permanentFlags

Permanent flags cache

store

protected MaildirStore store

Maildir store

base

protected File base

Directory folder data is for

rootFolder

protected boolean rootFolder

Flag to denote is this root folder or not

type

protected int type

Type of the folder. See Folder.HOLDS_FOLDERS and Folder.HOLDS_MESSAGES.

tmp

protected File tmp

Tmp subdirectory

cur

protected File cur

Cur subdirectory

nw

protected File nw

New subdirectory

cachedFullName

protected String cachedFullName

Cached folder's full name

cachedName

protected String cachedName

Cached folder's name

lastAccess

protected long lastAccess

Last time folder data was accessed or 0 if no open folders

delay

protected int delay

Amount of time between two accesses. TODO - make this as an attribute

delayFactor

protected int delayFactor

Delay factor - amount of time needed for reading directory vs delay. TODO - make this as an attribute

openedFolders

protected WeakHashMap<javax.mail.Folder,Object> openedFolders

List of open folders

data

protected MaildirFolderData.Data data

Folder's data

closedRef

protected Reference<MaildirFolderData.Data> closedRef

Weak reference to data when there are no open folders

openCount

protected int openCount

Count of open folders. When count reaches zero, storage may remove this folder data

Constructor Detail