|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--javax.mail.Flags
The Flags class represents the set of flags on a Message. Flags are composed of predefined system flags, and user defined flags.
A System flag is represented by the Flags.Flag
inner class. A User defined flag is represented as a String.
User flags are case-independent.
A set of standard system flags are predefined. Most folder
implementations are expected to support these flags. Some
implementations may also support arbitrary user-defined flags. The
getPermanentFlags
method on a Folder returns a Flags
object that holds all the flags that are supported by that folder
implementation.
The below code sample illustrates how to set, examine and get the
flags for a message.
Message m = folder.getMessage(1); m.setFlag(Flags.Flag.DELETED, true); // set the DELETED flag // Check if DELETED flag is set of this message if (m.isSet(Flags.Flag.DELETED)) System.out.println("DELETED message"); // Examine ALL system flags for this message Flags flags = m.getFlags(); Flags.Flag[] sf = flags.getSystemFlags(); for (int i = 0; i < sf.length; i++) { if (sf[i] == Flags.Flag.DELETED) System.out.println("DELETED message"); else if (sf[i] == Flags.Flag.SEEN) System.out.println("SEEN message"); ...... ...... }
Folder.getPermanentFlags()
Inner Class Summary | |
static class |
Flags.Flag
This inner class represents an individual system flag. |
Constructor Summary | |
Flags()
Construct an empty Flags object. |
|
Flags(Flags.Flag flag)
Construct a Flags object initialized with the given system flag. |
|
Flags(Flags flags)
Construct a Flags object initialized with the given flags. |
|
Flags(java.lang.String flag)
Construct a Flags object initialized with the given user flag. |
Method Summary | |
void |
add(Flags.Flag flag)
Add the specified system flag to this Flags object. |
void |
add(Flags f)
Add all the flags in the given Flags object to this Flags object. |
void |
add(java.lang.String flag)
Add the specified user flag to this Flags object. |
java.lang.Object |
clone()
Returns a clone of this Flags object. |
boolean |
contains(Flags.Flag flag)
Check whether the specified system flag is present in this Flags object. |
boolean |
contains(Flags f)
Check whether all the flags in the specified Flags object are present in this Flags object. |
boolean |
contains(java.lang.String flag)
Check whether the specified user flag is present in this Flags object. |
boolean |
equals(java.lang.Object obj)
Check whether the two Flags objects are equal. |
Flags.Flag[] |
getSystemFlags()
Return all the system flags in this Flags object. |
java.lang.String[] |
getUserFlags()
Return all the user flags in this Flags object. |
int |
hashCode()
Compute a hash code for this Flags object. |
void |
remove(Flags.Flag flag)
Remove the specified system flag from this Flags object. |
void |
remove(Flags f)
Remove all flags in the given Flags object from this Flags object. |
void |
remove(java.lang.String flag)
Remove the specified user flag from this Flags object. |
Methods inherited from class java.lang.Object |
finalize,
getClass,
notify,
notifyAll,
toString,
wait,
wait,
wait |
Constructor Detail |
public Flags()
public Flags(Flags flags)
flags
- the flags for initializationpublic Flags(Flags.Flag flag)
flag
- the flag for initializationpublic Flags(java.lang.String flag)
flag
- the flag for initializationMethod Detail |
public void add(Flags.Flag flag)
flag
- the flag to addpublic void add(java.lang.String flag)
flag
- the flag to addpublic void add(Flags f)
flags
- Flags objectpublic void remove(Flags.Flag flag)
flag
- the flag to be removedpublic void remove(java.lang.String flag)
flag
- the flag to be removedpublic void remove(Flags f)
flag
- the flag to be removedpublic boolean contains(Flags.Flag flag)
public boolean contains(java.lang.String flag)
public boolean contains(Flags f)
public boolean equals(java.lang.Object obj)
public int hashCode()
public Flags.Flag[] getSystemFlags()
public java.lang.String[] getUserFlags()
public java.lang.Object clone()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |