- java.lang.Object
-
- javax.mail.search.SearchTerm
-
- javax.mail.search.StringTerm
-
- javax.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 javax.mail.search.StringTerm
ignoreCase, pattern
-
-
Constructor Summary
Constructors Constructor and Description HeaderTerm(String headerName, String pattern)
Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method and 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 javax.mail.search.StringTerm
getIgnoreCase, getPattern, match
-
-
-
-
Method Detail
-
getHeaderName
public String getHeaderName()
Return the name of the header to compare with.
-
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
-
-
Document created the 11/06/2005, last modified the 18/08/2025
Source of the printed document:https://www.gaudry.be/en/java-api-javaee-rf-javax/mail/search/HeaderTerm.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author of this site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.