Java 2 Platform EE v1.3: Class AddressStringTerm - Java Platform, Enterprise Edition v1.3.1 API Specifications

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.mail.search
Class AddressStringTerm

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

Direct Known 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.

Since:: JavaMail 1.1

Fields inherited from class javax.mail.search.StringTerm

ignoreCase, pattern

Constructor Summary

protected AddressStringTerm(java.lang.String pattern)
Constructor.

Method Summary

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

getIgnoreCase, getPattern, match

Methods inherited from class javax.mail.search.SearchTerm

match

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AddressStringTerm

protected AddressStringTerm(java.lang.String pattern)

Constructor.

Parameters:: pattern - the address pattern to be compared.

Method Detail

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.