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

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

public final class SubjectTerm
extends StringTerm

This class implements comparisons for the Message Subject header. The comparison is case-insensitive.

Fields inherited from class javax.mail.search.StringTerm

ignoreCase, pattern

Constructor Summary

SubjectTerm(java.lang.String pattern)
Constructor.

Method Summary

boolean match(Message msg)
The match method.

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

SubjectTerm

public SubjectTerm(java.lang.String pattern)

Constructor.

Parameters:: pattern - the pattern to search for

Method Detail

match

public boolean match(Message msg)

The match method.

Overrides:: match in class SearchTerm

Parameters:: msg - the pattern match is applied to this Message's subject header
Returns:: true if the pattern match succeeds, otherwise false