javax.mail.search

Class StringTerm

java.lang.Object

javax.mail.search.SearchTerm

javax.mail.search.StringTerm

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

AddressStringTerm, BodyTerm, HeaderTerm, MessageIDTerm, SubjectTerm

public abstract class StringTerm
extends SearchTerm

A Term that provides matching criteria for Strings.

Version:

$Rev: 467553 $ $Date: 2006-10-25 06:01:51 +0200 (Wed, 25 Oct 2006) $

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	ignoreCase If true, case should be ignored during matching.
protected java.lang.String	pattern The pattern associated with this term.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	StringTerm(java.lang.String pattern) Constructor specifying a pattern.
protected	StringTerm(java.lang.String pattern, boolean ignoreCase) Constructor specifying pattern and case sensitivity.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object other)
boolean	getIgnoreCase() Indicate if case should be ignored when matching.
java.lang.String	getPattern() Return the pattern associated with this term.
int	hashCode()
protected boolean	match(java.lang.String match) Determine if the pattern associated with this term is a substring of the supplied String.

Methods inherited from class javax.mail.search.SearchTerm

match

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

ignoreCase

protected boolean ignoreCase

If true, case should be ignored during matching.

pattern

protected java.lang.String pattern

The pattern associated with this term.

Constructor Detail

StringTerm

protected StringTerm(java.lang.String pattern)

Constructor specifying a pattern. Defaults to case insensitive matching.

Parameters:

pattern - the pattern for this term

StringTerm

protected StringTerm(java.lang.String pattern,
                     boolean ignoreCase)

Constructor specifying pattern and case sensitivity.

Parameters:

pattern - the pattern for this term

ignoreCase - if true, case should be ignored during matching

Method Detail

getPattern

public java.lang.String getPattern()

Return the pattern associated with this term.

Returns:

the pattern associated with this term

getIgnoreCase

public boolean getIgnoreCase()

Indicate if case should be ignored when matching.

Returns:

if true, case should be ignored during matching

match

protected boolean match(java.lang.String match)

Determine if the pattern associated with this term is a substring of the supplied String. If ignoreCase is true then case will be ignored.

Parameters:

match - the String to compare to

Returns:

true if this patter is a substring of the supplied String

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object