javax.mail.search

Class RecipientStringTerm

java.lang.Object

javax.mail.search.SearchTerm

javax.mail.search.StringTerm

javax.mail.search.AddressStringTerm

javax.mail.search.RecipientStringTerm

All Implemented Interfaces:

java.io.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

Constructor Summary

Constructors

Constructor and Description
RecipientStringTerm(Message.RecipientType type, java.lang.String pattern) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.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 javax.mail.search.StringTerm

getIgnoreCase, getPattern

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RecipientStringTerm

public RecipientStringTerm(Message.RecipientType type,
                           java.lang.String pattern)

Constructor.

Parameters:

type - the recipient type

pattern - 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 class SearchTerm

Parameters:

msg - The comparison is applied to this Message's recipient address.

Returns:

true if the match succeeds, otherwise false.

equals

public boolean equals(java.lang.Object obj)

Equality comparison.

Overrides:

equals in class AddressStringTerm

hashCode

public int hashCode()

Compute a hashCode for this object.

Overrides:

hashCode in class StringTerm