⇒ Index (Frames) |  ⇒ Index (No Frames) |  ⇒ Package |  ⇒ Package Tree |  ⇒ Full Tree 
javax.mail.search

Class FlagTerm

java.lang.Object
|
+--javax.mail.search.SearchTerm
   |
   +--javax.mail.search.FlagTerm


public final class FlagTerm
extends SearchTerm

This class implements comparisons for Message Flags.
Author:

Field Summary

Flags

flags

Flags object containing the flags to test.

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.

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.

Parameters:
other

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.

Parameters:
msg - The flag comparison is applied to this Message
Returns:
true if the comparson succeeds, otherwise false.