Overview Package Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

javax.mail.search

Class FlagTerm

Implemented Interfaces:
Serializable
public final class FlagTerm
extends SearchTerm
This class implements comparisons for Message Flags.

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(Object other)
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 javax.mail.search.SearchTerm

match

Field Details

flags

protected Flags flags
Flags object containing the flags to test.

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.

Constructor Details

FlagTerm

public FlagTerm(Flags flags,
                boolean set)
Constructor.

Parameters:
flags - Flags object containing the flags to check for
set - the flag setting to check for

Method Details

equals

public boolean equals(Object other)
Equality comparison.

getFlags

public Flags getFlags()
Return the Flags to test.

getTestSet

public boolean getTestSet()
Return true if testing whether the flags are set.

hashCode

public int hashCode()
Compute a hashCode for this object.

match

public boolean match(Message msg)
The comparison method.
Overrides:
match in interface SearchTerm

Parameters:
msg - The flag comparison is applied to this Message

Returns:
true if the comparson succeeds, otherwise false.

Overview Package Tree Index Deprecated About