Package jakarta.mail.search
Class FlagTerm
- java.lang.Object
-
- jakarta.mail.search.SearchTerm
-
- jakarta.mail.search.FlagTerm
-
- All Implemented Interfaces:
Serializable
public final class FlagTerm extends SearchTerm
This class implements comparisons for Message Flags.- Author:
- Bill Shannon, John Mani
- See Also:
- Serialized Form
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(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.
-
-
-
Constructor Detail
-
FlagTerm
public FlagTerm(Flags flags, boolean set)
Constructor.- Parameters:
flags
- Flags object containing the flags to check forset
- the flag setting to check for
-
-
Method Detail
-
getFlags
public Flags getFlags()
Return the Flags to test.- Returns:
- the flags
-
getTestSet
public boolean getTestSet()
Return true if testing whether the flags are set.- Returns:
- true if testing whether the flags are set
-
match
public boolean match(Message msg)
The comparison method.- Specified by:
match
in classSearchTerm
- Parameters:
msg
- The flag comparison is applied to this Message- Returns:
- true if the comparson succeeds, otherwise false.
-
-