javax.mail.search
Class FlagTerm

java.lang.Object
  javax.mail.search.SearchTerm
      javax.mail.search.FlagTerm

All Implemented Interfaces:

Serializable

public final class FlagTerm
extends SearchTerm

A comparison of message flags.

Version:

1.4

Author:

Chris Burdess

See Also:

Serialized Form

Field Summary

protected Flags	flags 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)
Flags	getFlags() Returns the flags to test.
boolean	getTestSet() Indicates whether to test for the presence or the absence of the specified flags.
int	hashCode()
boolean	match(Message msg) Returns true if the flags in the specified message match this term.

Methods inherited from class java.lang.Object

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

Field Detail

set

protected boolean set

Indicates whether to test for the presence or absence of the specified flag. If true, test whether all the specified flags are present, otherwise test whether all the specified flags are absent.

flags

protected Flags flags

The flags to test.

Constructor Detail

FlagTerm

public FlagTerm(Flags flags,
                boolean set)

Constructor.

Parameters:

flags - the flags to test

set - whether to test for presence or absence of the specified flags

Method Detail

getFlags

public Flags getFlags()

Returns the flags to test.

getTestSet

public boolean getTestSet()

Indicates whether to test for the presence or the absence of the specified flags.

match

public boolean match(Message msg)

Returns true if the flags in the specified message match this term.

Specified by:

match in class SearchTerm

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object