javax.mail.search: abstract public class: AddressStringTerm

javax.mail.search
abstract public class: AddressStringTerm [javadoc | source]

java.lang.Object
   javax.mail.search.SearchTerm
      javax.mail.search.StringTerm
         javax.mail.search.AddressStringTerm

All Implemented Interfaces:
Serializable

Direct Known Subclasses:
RecipientStringTerm, FromStringTerm

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.

since: JavaMail - 1.1

Fields inherited from javax.mail.search.StringTerm:
pattern, ignoreCase

Constructor:

Constructor:
protected AddressStringTerm(String pattern) { super(pattern, true); // we need case-insensitive comparison. } Constructor. Parameters: `pattern` - the address pattern to be compared.

 protected AddressStringTerm(String pattern) {
	super(pattern, true); // we need case-insensitive comparison.
}

Constructor.

Parameters:

pattern - the address pattern to be compared.

Method from javax.mail.search.AddressStringTerm Summary:
equals, match

Methods from javax.mail.search.StringTerm:
equals, getIgnoreCase, getPattern, hashCode, match

Methods from javax.mail.search.SearchTerm:
match

Methods from java.lang.Object:
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from javax.mail.search.AddressStringTerm Detail:
public boolean equals(Object obj) { if (!(obj instanceof AddressStringTerm)) return false; return super.equals(obj); } Equality comparison.
protected boolean match(Address a) { if (a instanceof InternetAddress) { InternetAddress ia = (InternetAddress)a; // We dont use toString() to get "a"'s String representation, // because InternetAddress.toString() returns a RFC 2047 // encoded string, which isn't what we need here. return super.match(ia.toUnicodeString()); } else return super.match(a.toString()); } 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.

Method from javax.mail.search.AddressStringTerm Detail:

 public boolean equals(Object obj) {
	if (!(obj instanceof AddressStringTerm))
	    return false;
	return super.equals(obj);
}

Equality comparison.

 protected boolean match(Address a) {
	if (a instanceof InternetAddress) {
	    InternetAddress ia = (InternetAddress)a;
	    // We dont use toString() to get "a"'s String representation,
	    // because InternetAddress.toString() returns a RFC 2047 
	    // encoded string, which isn't what we need here.
	    return super.match(ia.toUnicodeString());
	} else
	    return super.match(a.toString());
}

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.