Overview Package Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

javax.mail.search

Class RecipientStringTerm

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.

Field Summary

protected Message.RecipientType
type
The recipient type.

Fields inherited from class javax.mail.search.StringTerm

ignoreCase, pattern

Constructor Summary

RecipientStringTerm(Message.RecipientType type, String pattern)
Constructor.

Method Summary

boolean
equals(Object other)
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.AddressStringTerm

equals, match

Methods inherited from class javax.mail.search.StringTerm

equals, getIgnoreCase, getPattern, hashCode, match

Methods inherited from class javax.mail.search.SearchTerm

match

Field Details

type

protected Message.RecipientType type
The recipient type.

Constructor Details

RecipientStringTerm

public RecipientStringTerm(Message.RecipientType type,
                           String pattern)
Constructor.

Parameters:
type - the recipient type

Method Details

equals

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

getRecipientType

public Message.RecipientType getRecipientType()
Return the type of recipient to match with.

hashCode

public int hashCode()
Compute a hashCode for this object.
Overrides:
hashCode in interface StringTerm

match

public boolean match(Message msg)
Check whether the address specified in the constructor is a substring of the recipient address of this Message.
Overrides:
match in interface SearchTerm

Parameters:
msg - The comparison is applied to this Message's recepient address.

Returns:
true if the match succeeds, otherwise false.

Overview Package Tree Index Deprecated About