FromStringTerm (JavaMail API documentation)

This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.

Overview

Package

Class

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.mail.search
class FromStringTerm

javax.mail.search.SearchTerm
  javax.mail.search.StringTerm
      javax.mail.search.AddressStringTerm
          javax.mail.search.FromStringTerm

All Implemented Interfaces:: Serializable

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.

See Also (auto-generated):

SearchTerm

Message

Multipart

Field Summary

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

Constructor Summary
`FromStringTerm(String pattern)` Constructor.

Method Summary
`boolean`	`equals(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
`equals, match`

Methods inherited from class javax.mail.search.StringTerm
`equals, getIgnoreCase, getPattern, hashCode, match`

Methods inherited from class javax.mail.search.SearchTerm
`match`

Constructor Detail

FromStringTerm

public FromStringTerm(String pattern)

Constructor.

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

Method Detail

equals

public boolean equals(Object obj)

Equality comparison.

Overrides:: equals in class AddressStringTerm
Parameters:: obj

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.