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.


javax.mail.search
class OrTerm

javax.mail.search.SearchTerm extended by javax.mail.search.OrTerm
All Implemented Interfaces:
Serializable

public final class OrTerm
extends SearchTerm

This class implements the logical OR operator on individual SearchTerms.

See Also (auto-generated):

File

SearchTerm

Session


Field Summary
protected SearchTerm[] terms
          The array of terms on which the OR operator should be applied.
 
Constructor Summary

          Constructor that takes two operands.

          Constructor that takes an array of SearchTerms.
 
Method Summary
 boolean

          Equality comparison.
 SearchTerm[]

          Return the search terms.
 int

          Compute a hashCode for this object.
 boolean

          The OR operation.
 
Methods inherited from class javax.mail.search.SearchTerm
match
 

Field Detail

terms

protected SearchTerm[] terms
The array of terms on which the OR operator should be applied.
Constructor Detail

OrTerm

public OrTerm(SearchTerm t1,
              SearchTerm t2)
Constructor that takes two operands.

Parameters:
t1 - first term
t2 - second term

OrTerm

public OrTerm(SearchTerm[] t)
Constructor that takes an array of SearchTerms.

Parameters:
t - array of search terms
Method Detail

equals

public boolean equals(Object obj)
Equality comparison.

Overrides:
equals in class Object
Parameters:
obj

getTerms

public SearchTerm[] getTerms()
Return the search terms.


hashCode

public int hashCode()
Compute a hashCode for this object.

Overrides:
hashCode in class Object

match

public boolean match(Message msg)
The OR operation.

The terms specified in the constructor are applied to the given object and the OR operator is applied to their results.

Overrides:
match in class SearchTerm
Parameters:
msg - The specified SearchTerms are applied to this Message and the OR operator is applied to their results.
Returns:
true if the OR succeds, otherwise false


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.
This page displays the Jadeite version of the documention. The official Sun™ documentation can be found here at http://java.sun.com/products/javamail/javadocs/index.html.