javax.mail.search

Class AddressStringTerm

Implemented Interfaces:
Serializable
Known Direct Subclasses:
FromStringTerm, RecipientStringTerm

public abstract class AddressStringTerm
extends StringTerm

This abstract class implements string comparisons for Message addresses.

Note that this class differs from the AddressTerm class in that this class does comparisons on address strings rather than Address objects.

Field Summary

Fields inherited from class javax.mail.search.StringTerm

ignoreCase, pattern

Constructor Summary

AddressStringTerm(String pattern)
Constructor.

Method Summary

boolean
equals(Object other)
Equality comparison.
protected boolean
match(Address a)
Check whether the address pattern specified in the constructor is a substring of the string representation of the given Address object.

Methods inherited from class javax.mail.search.StringTerm

equals, getIgnoreCase, getPattern, hashCode, match

Methods inherited from class javax.mail.search.SearchTerm

match

Constructor Details

AddressStringTerm

protected AddressStringTerm(String pattern)
Constructor.

Parameters:
pattern - the address pattern to be compared.

Method Details

equals

public boolean equals(Object other)
Equality comparison.
Overrides:
equals in interface StringTerm


match

protected boolean match(Address a)
Check whether the address pattern specified in the constructor is a substring of the string representation of the given Address object.

Note that if the string representation of the given Address object contains charset or transfer encodings, the encodings must be accounted for, during the match process.

Parameters:
a - The comparison is applied to this Address object.

Returns:
true if the match succeeds, otherwise false.