This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.


javax.mail.search
class FlagTerm

javax.mail.search.SearchTerm extended by javax.mail.search.FlagTerm
All Implemented Interfaces:
Serializable

public final class FlagTerm
extends SearchTerm

This class implements comparisons for Message Flags.

See Also (auto-generated):

Session

Multipart

Transport


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

          Equality comparison.
 Flags

          Return the Flags to test.
 boolean

          Return true if testing whether the flags are set.
 int

          Compute a hashCode for this object.
 boolean

          The comparison method.
 
Methods inherited from class javax.mail.search.SearchTerm
match
 

Field Detail

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 Detail

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 Detail

equals

public boolean equals(Object obj)
Equality comparison.

Overrides:
equals in class Object
Parameters:
obj

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.

Overrides:
hashCode in class Object

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.


This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention. The official Sun™ documentation can be found here at http://java.sun.com/products/javamail/javadocs/index.html.