public final class

FlagTerm

extends SearchTerm
java.lang.Object
   ↳ com.google.code.javax.mail.search.SearchTerm
     ↳ com.google.code.javax.mail.search.FlagTerm

Class Overview

This class implements comparisons for Message Flags.

Summary

Constants
long serialVersionUID
[Expand]
Inherited Constants
From class com.google.code.javax.mail.search.SearchTerm
Fields
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.
Public Constructors
FlagTerm(Flags flags, boolean set)
Constructor.
Public Methods
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.
[Expand]
Inherited Methods
From class com.google.code.javax.mail.search.SearchTerm
From class java.lang.Object

Constants

private static final long serialVersionUID

Constant Value: -142991500302030647 (0xfe03fdfcf298e8c9)

Fields

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. If true, then test whether all the specified flags are present, else test whether all the specified flags are absent.

Public Constructors

public FlagTerm (Flags flags, boolean set)

Constructor.

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

Public Methods

public boolean equals (Object obj)

Equality comparison.

Parameters
obj

public Flags getFlags ()

Return the Flags to test.

public boolean getTestSet ()

Return true if testing whether the flags are set.

public int hashCode ()

Compute a hashCode for this object.

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.