Package jakarta.mail.search
Class HeaderTerm
- java.lang.Object
-
- jakarta.mail.search.SearchTerm
-
- jakarta.mail.search.StringTerm
-
- jakarta.mail.search.HeaderTerm
-
- All Implemented Interfaces:
Serializable
public final class HeaderTerm extends StringTerm
This class implements comparisons for Message headers. The comparison is case-insensitive.- Author:
- Bill Shannon, John Mani
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class jakarta.mail.search.StringTerm
ignoreCase, pattern
-
-
Constructor Summary
Constructors Constructor Description HeaderTerm(String headerName, String pattern)
Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(Object obj)
Equality comparison.String
getHeaderName()
Return the name of the header to compare with.int
hashCode()
Compute a hashCode for this object.boolean
match(Message msg)
The header match method.-
Methods inherited from class jakarta.mail.search.StringTerm
getIgnoreCase, getPattern, match
-
-
-
-
Method Detail
-
getHeaderName
public String getHeaderName()
Return the name of the header to compare with.- Returns:
- the name of the header
-
match
public boolean match(Message msg)
The header match method.- Specified by:
match
in classSearchTerm
- Parameters:
msg
- The match is applied to this Message's header- Returns:
- true if the match succeeds, otherwise false
-
equals
public boolean equals(Object obj)
Equality comparison.- Overrides:
equals
in classStringTerm
-
hashCode
public int hashCode()
Compute a hashCode for this object.- Overrides:
hashCode
in classStringTerm
-
-