Java EE 5 SDK

javax.mail.search
Class SubjectTerm

java.lang.Object
  extended by javax.mail.search.SearchTerm
      extended by javax.mail.search.StringTerm
          extended by javax.mail.search.SubjectTerm
All Implemented Interfaces:
Serializable

public final class SubjectTerm
extends StringTerm

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

Author:
Bill Shannon, John Mani
See Also:
Serialized Form

Field Summary
 
Fields inherited from class javax.mail.search.StringTerm
ignoreCase, pattern
 
Constructor Summary
SubjectTerm(String pattern)
          Constructor.
 
Method Summary
 boolean equals(Object obj)
          Equality comparison.
 boolean match(Message msg)
          The match method.
 
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

SubjectTerm

public SubjectTerm(String pattern)
Constructor.

Parameters:
pattern - the pattern to search for
Method Detail

match

public boolean match(Message msg)
The match method.

Specified by:
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

equals

public boolean equals(Object obj)
Equality comparison.

Overrides:
equals in class StringTerm

Java EE 5 SDK

Submit a bug or feature

Copyright 2006 Sun Microsystems, Inc. All rights reserved.