⇒ Index (Frames) |  ⇒ Index (No Frames) |  ⇒ Package |  ⇒ Package Tree |  ⇒ Full Tree 
javax.mail.search

Class RecipientStringTerm

java.lang.Object
|
+--javax.mail.search.SearchTerm
   |
   +--javax.mail.search.StringTerm
      |
      +--javax.mail.search.AddressStringTerm
         |
         +--javax.mail.search.RecipientStringTerm


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.

Author:

Field Summary

Message.RecipientType

type

The recipient type.

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.

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
pattern - the address pattern to be compared.

Method Details

equals

public boolean equals(Object other)

Equality comparison.

Parameters:
other

getRecipientType

public Message.RecipientType getRecipientType()

Return the type of recipient to match with.


hashCode

public int hashCode()

Compute a hashCode for this object.


match

public boolean match(Message msg)

Check whether the address specified in the constructor is a substring of the recipient address of this Message.

Parameters:
msg - The comparison is applied to this Message's recepient address.
Returns:
true if the match succeeds, otherwise false.