javax.mail.search

Class FlagTerm

Implemented Interfaces:
Serializable

public final class FlagTerm
extends SearchTerm

A comparison of message flags.
Version:
1.4
Author:
Chris Burdess

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 javax.mail.search.SearchTerm

match

Field Details

flags

protected Flags flags
The flags to test.

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.

Constructor Details

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 Details

equals

public boolean equals(Object other)

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.

hashCode

public int hashCode()

match

public boolean match(Message msg)
Returns true if the flags in the specified message match this term.
Overrides:
match in interface SearchTerm

© Copyright 2003, 2004 The Free Software Foundation, All rights reserved