javax.mail.search
Class FlagTerm
java.lang.Object
|
+--javax.mail.search.SearchTerm
|
+--javax.mail.search.FlagTerm
- All Implemented Interfaces:
- java.io.Serializable
- public final class FlagTerm
- extends SearchTerm
This class implements comparisons for Message Flags.
- See Also:
- Serialized Form
Field Summary |
protected Flags |
flags
Flags object containing the flags to test. |
protected boolean |
set
Indicates whether to test for the presence or
absence of the specified Flag. |
Constructor Summary |
FlagTerm(Flags flags,
boolean set)
Constructor. |
Method Summary |
boolean |
equals(java.lang.Object obj)
Equality comparison. |
Flags |
getFlags()
Return the Flags to test. |
boolean |
getTestSet()
Return true if testing whether the flags are set. |
int |
hashCode()
Compute a hashCode for this object. |
boolean |
match(Message msg)
The comparison method. |
Methods inherited from class java.lang.Object |
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
set
protected boolean set
- Indicates whether to test for the presence or
absence of the specified Flag. If
true
,
then test whether all the specified flags are present, else
test whether all the specified flags are absent.
flags
protected Flags flags
- Flags object containing the flags to test.
FlagTerm
public FlagTerm(Flags flags,
boolean set)
- Constructor.
- Parameters:
flags
- Flags object containing the flags to check forset
- the flag setting to check for
getFlags
public Flags getFlags()
- Return the Flags to test.
getTestSet
public boolean getTestSet()
- Return true if testing whether the flags are set.
match
public boolean match(Message msg)
- The comparison method.
- Overrides:
match
in class SearchTerm
- Parameters:
msg
- The flag comparison is applied to this Message- Returns:
- true if the comparson succeeds, otherwise false.
equals
public boolean equals(java.lang.Object obj)
- Equality comparison.
- Overrides:
equals
in class java.lang.Object
hashCode
public int hashCode()
- Compute a hashCode for this object.
- Overrides:
hashCode
in class java.lang.Object