FromStringTerm (Java EE 6 )

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES All Classes

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.mail.search
Class FromStringTerm

java.lang.Object
 extended by javax.mail.search.SearchTerm
 extended by javax.mail.search.StringTerm
 extended by javax.mail.search.AddressStringTerm
 extended by javax.mail.search.FromStringTerm

All Implemented Interfaces:: java.io.Serializable

public final class FromStringTerm
extends AddressStringTerm
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
See Also:: Serialized Form

Field Summary

Fields inherited from class javax.mail.search.StringTerm
`ignoreCase, pattern`

Constructor Summary
`FromStringTerm(java.lang.String pattern)` Constructor.

Method Summary
`boolean`	`equals(java.lang.Object obj)` Equality comparison.
`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, hashCode, match`

Methods inherited from class java.lang.Object
`clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

FromStringTerm

public FromStringTerm(java.lang.String pattern)

Constructor.

Parameters:: pattern - 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.

Specified by:: match in class SearchTerm

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

equals

public boolean equals(java.lang.Object obj)

Equality comparison.

Overrides:: equals in class AddressStringTerm