Java 2 Platform EE v1.3: Class FromStringTerm - 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 FromStringTerm

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

public final class FromStringTerm
extends AddressStringTerm

This class implements string comparisons for the From Address header.

Note that this class differs from the FromTerm class in that this class does comparisons on address strings rather than Address objects. The string comparisons are case-insensitive.

Since:: JavaMail 1.1

Fields inherited from class javax.mail.search.StringTerm

ignoreCase, pattern

Constructor Summary

FromStringTerm(java.lang.String pattern)
Constructor.

Method Summary

boolean match(Message msg)
Check whether the address string specified in the constructor is a substring of the From address of this Message.

Methods inherited from class javax.mail.search.AddressStringTerm

match

Methods inherited from class javax.mail.search.StringTerm

getIgnoreCase, getPattern, match

Methods inherited from class java.lang.Object

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

Constructor Detail

FromStringTerm

public FromStringTerm(java.lang.String pattern)

Constructor.

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

Method Detail

match

public boolean match(Message msg)

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

Overrides:: match in class SearchTerm

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