public class MailFolderDescription
extends java.lang.Object
MailFolderDescription
- A simple object for updating or creating a folder which holds user-modifiable folder attributes.
See the method descriptions of setExists(boolean)
and/or setFullname(String)
how to signal a create or an update
operation.
Constructor and Description |
---|
MailFolderDescription()
Initializes a new
MailFolderDescription |
Modifier and Type | Method and Description |
---|---|
void |
addPermission(MailPermission permission)
Adds a permission
|
void |
addPermissions(java.util.Collection<? extends MailPermission> permissions)
Adds a collection of permissions
|
void |
addPermissions(MailPermission[] permissions)
Adds an array of permissions
|
boolean |
containsExists()
Checks if existence status has been set
|
boolean |
containsFullname()
Checks if fullname has been set
|
boolean |
containsName()
Checks if name has been set
|
boolean |
containsParentFullname()
Checks if parent fullname has been set
|
boolean |
containsPermissions()
Checks if permissions have been set
|
boolean |
containsSeparator()
Checks if separator has been set
|
boolean |
containsSubscribed()
Checks if subscription status has been set
|
boolean |
exists()
Checks if this folder exists
|
int |
getAccountId()
Gets the account ID belonging to fullname.
|
java.lang.String |
getFullname()
Gets the fullname
|
java.lang.String |
getName()
Gets the name
|
int |
getParentAccountId()
Gets the account ID belonging to parent.
|
java.lang.String |
getParentFullname()
Gets the parent fullname
|
MailPermission[] |
getPermissions()
Gets the permissions
|
char |
getSeparator()
Gets the separator
|
boolean |
isSubscribed()
Gets the subscription status
|
void |
removeExists()
Removes exists status
|
void |
removeFullname()
Removes the fullname
|
void |
removeName()
Removes the name
|
void |
removeParentFullname()
Removes the parent fullname
|
void |
removePermissions()
Removes the permissions
|
void |
removeSeparator()
Removes the separator
|
void |
removeSubscribed()
Removes the subscription status
|
void |
setAccountId(int accountId)
Sets the account ID belonging to fullname.
|
void |
setExists(boolean exists)
Sets the exists status
This flag is checked at first to detect if an update or create operation shall be performed.
|
void |
setFullname(java.lang.String fullname)
Sets the fullname
If
containsExists() returns false the MailFolderStorage.exists(String) method is used to determine
folder existence. |
void |
setName(java.lang.String name)
Sets the name
|
void |
setParentAccountId(int parentAccountId)
Sets the account ID belonging to parent.
|
void |
setParentFullname(java.lang.String parentFullname)
Sets the parent fullname
|
void |
setSeparator(char separator)
Sets the separator
|
void |
setSubscribed(boolean subscribed)
Sets the subscription status
|
public MailFolderDescription()
MailFolderDescription
public void addPermission(MailPermission permission)
permission
- The permission to addpublic void addPermissions(MailPermission[] permissions)
permissions
- The array of permissions to addpublic void addPermissions(java.util.Collection<? extends MailPermission> permissions)
permissions
- The collection of permissions to addpublic boolean containsExists()
true
if exists status is set; otherwise false
public boolean containsFullname()
true
if fullname is set; otherwise false
public boolean containsName()
true
if name is set; otherwise false
public boolean containsParentFullname()
true
if parentFullname is set; otherwise false
public boolean containsPermissions()
true
if permissions are set; otherwise false
public boolean containsSeparator()
true
if separator is set; otherwise false
public boolean containsSubscribed()
true
if subscribed is set; otherwise false
public boolean exists()
true
if folder exists in mailbox; otherwise false
setExists(boolean)
public java.lang.String getFullname()
setFullname(String)
public int getAccountId()
public java.lang.String getName()
public java.lang.String getParentFullname()
public int getParentAccountId()
public MailPermission[] getPermissions()
MailPermission
public char getSeparator()
public boolean isSubscribed()
public void removeExists()
public void removeFullname()
public void removeName()
public void removeParentFullname()
public void removePermissions()
public void removeSeparator()
public void removeSubscribed()
public void setExists(boolean exists)
This flag is checked at first to detect if an update or create operation shall be performed. If not set - this is
containsExists()
returns false
- the folder's fullname in conjunction with
MailFolderStorage.exists(String)
is used to determine folder existence.
exists
- true
if folder exists in mailbox; otherwise false
setFullname(String)
public void setFullname(java.lang.String fullname)
If containsExists()
returns false
the MailFolderStorage.exists(String)
method is used to determine
folder existence.
fullname
- the fullname to setsetExists(boolean)
public void setAccountId(int accountId)
accountId
- The account IDpublic void setName(java.lang.String name)
name
- the name to setpublic void setParentFullname(java.lang.String parentFullname)
parentFullname
- the parent fullname to setpublic void setParentAccountId(int parentAccountId)
parentAccountId
- The account ID belonging to parent.public void setSeparator(char separator)
separator
- the separator to setpublic void setSubscribed(boolean subscribed)
subscribed
- the subscription status to set