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 StringTerm

javax.mail.search.SearchTerm extended by javax.mail.search.StringTerm
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
AddressStringTerm, BodyTerm, HeaderTerm, MessageIDTerm, SubjectTerm

public abstract class StringTerm
extends SearchTerm

This class implements the match method for Strings. The current implementation provides only for substring matching. We could add comparisons (like strcmp ...).


Field Summary
protected boolean ignoreCase
          Ignore case when comparing?
protected String pattern
          The pattern.
 
Constructor Summary
protected
StringTerm(String pattern)

          
protected
StringTerm(String pattern, boolean ignoreCase)

          
 
Method Summary
 boolean

          Equality comparison.
 boolean

          Return true if we should ignore case when matching.
 String

          Return the string to match with.
 int

          Compute a hashCode for this object.
protected boolean

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

Field Detail

ignoreCase

protected boolean ignoreCase
Ignore case when comparing?

pattern

protected String pattern
The pattern.
Constructor Detail

StringTerm

protected StringTerm(String pattern)
Parameters:
pattern

StringTerm

protected StringTerm(String pattern,
                     boolean ignoreCase)
Parameters:
pattern
ignoreCase
Method Detail

equals

public boolean equals(Object obj)
Equality comparison.

Overrides:
equals in class Object
Parameters:
obj

getIgnoreCase

public boolean getIgnoreCase()
Return true if we should ignore case when matching.


getPattern

public String getPattern()
Return the string to match with.


hashCode

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

Overrides:
hashCode in class Object

match

protected boolean match(String s)
Parameters:
s


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.