Package jakarta.mail.search
Class RecipientStringTerm
- java.lang.Object
-
- jakarta.mail.search.SearchTerm
-
- jakarta.mail.search.StringTerm
-
- jakarta.mail.search.AddressStringTerm
-
- jakarta.mail.search.RecipientStringTerm
-
- All Implemented Interfaces:
Serializable
public final class RecipientStringTerm extends AddressStringTerm
This class implements string comparisons for the Recipient Address headers.Note that this class differs from the
RecipientTerm
class in that this class does comparisons on address strings rather than Address objects. The string comparisons are case-insensitive.- Since:
- JavaMail 1.1
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class jakarta.mail.search.StringTerm
ignoreCase, pattern
-
-
Constructor Summary
Constructors Constructor Description RecipientStringTerm(Message.RecipientType type, String pattern)
Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(Object obj)
Equality comparison.Message.RecipientType
getRecipientType()
Return the type of recipient to match with.int
hashCode()
Compute a hashCode for this object.boolean
match(Message msg)
Check whether the address specified in the constructor is a substring of the recipient address of this Message.-
Methods inherited from class jakarta.mail.search.AddressStringTerm
match
-
Methods inherited from class jakarta.mail.search.StringTerm
getIgnoreCase, getPattern, match
-
-
-
-
Constructor Detail
-
RecipientStringTerm
public RecipientStringTerm(Message.RecipientType type, String pattern)
Constructor.- Parameters:
type
- the recipient typepattern
- the address pattern to be compared.
-
-
Method Detail
-
getRecipientType
public Message.RecipientType getRecipientType()
Return the type of recipient to match with.- Returns:
- the recipient type
-
match
public boolean match(Message msg)
Check whether the address specified in the constructor is a substring of the recipient address of this Message.- Specified by:
match
in classSearchTerm
- Parameters:
msg
- The comparison is applied to this Message's recipient address.- Returns:
- true if the match succeeds, otherwise false.
-
equals
public boolean equals(Object obj)
Equality comparison.- Overrides:
equals
in classAddressStringTerm
-
hashCode
public int hashCode()
Compute a hashCode for this object.- Overrides:
hashCode
in classStringTerm
-
-