Package jakarta.mail.search
Class FromStringTerm
- java.lang.Object
-
- jakarta.mail.search.SearchTerm
-
- jakarta.mail.search.StringTerm
-
- jakarta.mail.search.AddressStringTerm
-
- jakarta.mail.search.FromStringTerm
-
- All Implemented Interfaces:
Serializable
public final class FromStringTerm extends AddressStringTerm
This class implements string comparisons for the From Address header.Note that this class differs from the
FromTerm
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 FromStringTerm(String pattern)
Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(Object obj)
Equality comparison.boolean
match(Message msg)
Check whether the address string specified in the constructor is a substring of the From address of this Message.-
Methods inherited from class jakarta.mail.search.AddressStringTerm
match
-
Methods inherited from class jakarta.mail.search.StringTerm
getIgnoreCase, getPattern, hashCode, match
-
-
-
-
Constructor Detail
-
FromStringTerm
public FromStringTerm(String pattern)
Constructor.- Parameters:
pattern
- the address pattern to be compared.
-
-
Method Detail
-
match
public boolean match(Message msg)
Check whether the address string specified in the constructor is a substring of the From address of this Message.- Specified by:
match
in classSearchTerm
- Parameters:
msg
- The comparison is applied to this Message's From address.- Returns:
- true if the match succeeds, otherwise false.
-
equals
public boolean equals(Object obj)
Equality comparison.- Overrides:
equals
in classAddressStringTerm
-
-