Java EE 5 SDK

javax.mail.search
Class BodyTerm

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

public final class BodyTerm
extends StringTerm

This class implements searches on a Message Body. All parts of the message that are of MIME type "text/*" are searched.

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

Field Summary
 
Fields inherited from class javax.mail.search.StringTerm
ignoreCase, pattern
 
Constructor Summary
BodyTerm(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

BodyTerm

public BodyTerm(String pattern)
Constructor

Parameters:
pattern - The String to search for
Method Detail

match

public boolean match(Message msg)
The match method.

Specified by:
match in class SearchTerm
Parameters:
msg - The pattern search is applied on this Message's body
Returns:
true if the pattern is found; 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.