javax.mail
public class Flags extends Object implements Cloneable, Serializable
Flag
inner class,
or user-defined flags defined by a String. The system flags represent those expected
to be provided by most folder systems; user-defined flags allow for additional flags
on a per-provider basis.
This class is Serializable but compatibility is not guaranteed across releases.
Nested Class Summary | |
---|---|
static class | Flags.Flag |
Constructor Summary | |
---|---|
Flags()
Construct a Flags instance with no flags set. | |
Flags(Flags.Flag flag)
Construct a Flags instance with a supplied system flag set. | |
Flags(Flags flags)
Construct a Flags instance with a same flags set. | |
Flags(String name)
Construct a Flags instance with the supplied user flags set.
|
Method Summary | |
---|---|
void | add(Flags.Flag flag)
Set a system flag. |
void | add(Flags flags)
Set all system and user flags from the supplied Flags.
|
void | add(String name)
Set a user flag.
|
Object | clone()
Return a copy of this instance. |
boolean | contains(Flags.Flag flag)
See if the supplied system flags are set |
boolean | contains(Flags flags)
See if all of the supplied Flags are set |
boolean | contains(String name)
See if the supplied user flag is set |
boolean | equals(Object other)
Equality is defined as true if the other object is a instanceof Flags with the
same system and user flags set (using a case-insensitive name comparison for user flags). |
Flags.Flag[] | getSystemFlags()
Return a list of Flags containing the system flags that have been set |
String[] | getUserFlags()
Return a list of user flags that have been set |
int | hashCode()
Calculate a hashCode for this instance |
void | remove(Flags.Flag flag)
Unset the supplied system flag.
|
void | remove(Flags flags)
Unset all flags from the supplied instance. |
void | remove(String name)
Unset the supplied user flag. |
Parameters: flag the system flag to set
Parameters: flags the instance to copy
Parameters: name the user flag to set
Parameters: flag the system flag to set
Parameters: flags the Flags to add
Parameters: name the user flag to set
Returns: a copy of this instance
Parameters: flag the system flags to check for
Returns: true if the flags are set
Parameters: flags the flags to check for
Returns: true if all the supplied system and user flags are set
Parameters: name the user flag to check for
Returns: true if the flag is set
Parameters: other the instance to compare against
Returns: true if the two instance are the same
Flags
containing the system flags that have been setReturns: the system flags that have been set
Returns: a list of user flags
Returns: a hashCode for this instance
Parameters: flag the flag to clear
Parameters: flags the flags to clear
Parameters: name the flag to clear