FlagTerm (Jakarta Mail API documentation)

java.lang.Object
- jakarta.mail.search.SearchTerm
- - jakarta.mail.search.FlagTerm

All Implemented Interfaces:

java.io.Serializable
```
public final class FlagTerm
extends SearchTerm
```
This class implements comparisons for Message Flags.

Author:

Bill Shannon, John Mani

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor Description

FlagTerm(Flags flags, boolean set)
Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(java.lang.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.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- 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
  - getFlags
```
public Flags getFlags()
```
    Return the Flags to test.
    
    Returns:
    
    the flags
  - getTestSet
```
public boolean getTestSet()
```
    Return true if testing whether the flags are set.
    
    Returns:
    
    true if testing whether the flags are set
  - match
```
public boolean match(Message msg)
```
    The comparison method.
    
    Specified by:
    
    match in class SearchTerm
    
    Parameters:
    
    msg - The flag comparison is applied to this Message
    
    Returns:
    
    true if the comparson succeeds, otherwise false.
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Equality comparison.
    
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Compute a hashCode for this object.
    
    Overrides:
    
    hashCode in class java.lang.Object