javax.mail.search

Class FlagTerm

java.lang.Object

javax.mail.search.SearchTerm

javax.mail.search.FlagTerm

All Implemented Interfaces:

java.io.Serializable

public final class FlagTerm
extends SearchTerm

Term for matching message Flags.

Version:

$Rev: 467553 $ $Date: 2006-10-25 06:01:51 +0200 (Wed, 25 Oct 2006) $

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Flags	flags The flags to test.
protected boolean	set If true, test that all flags are set; if false, test that all flags are clear.

Constructor Summary

Constructors

Constructor and Description
FlagTerm(Flags flags, boolean set)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object other)
Flags	getFlags()
boolean	getTestSet()
int	hashCode()
boolean	match(Message message) Checks a matching criteria defined by the concrete subclass of this Term.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

set

protected boolean set

If true, test that all flags are set; if false, test that all flags are clear.

flags

protected Flags flags

The flags to test.

Constructor Detail

FlagTerm

public FlagTerm(Flags flags,
                boolean set)

Parameters:

flags - the flags to test

set - test for set or clear; set

Method Detail

getFlags

public Flags getFlags()

getTestSet

public boolean getTestSet()

match

public boolean match(Message message)

Description copied from class: SearchTerm

Checks a matching criteria defined by the concrete subclass of this Term.

Specified by:

match in class SearchTerm

Parameters:

message - the message to apply the matching criteria to

Returns:

true if the matching criteria is met

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object