Overview  Package   Class  Use  Deprecated  Index
Home >> All >> javax >> mail >> [ search overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

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: 125583 $ $Date: 2005-01-18 19:44:27 -0800 (Tue, 18 Jan 2005) $

---

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

 

Constructor Summary
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
boolean	equals(java.lang.Object other)           Determine whether this Object is semantically equal to another Object.
boolean	getIgnoreCase()           Indicate if case should be ignored when matching.
java.lang.String	getPattern()           Return the pattern associated with this term.
int	hashCode()           Get a value that represents this Object, as uniquely as possible within the confines of an int.
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.

---

StringTerm

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

Constructor specifying pattern and case sensitivity.

Method Detail

getPattern

public java.lang.String getPattern()

Return the pattern associated with this term.

---

getIgnoreCase

public boolean getIgnoreCase()

Indicate if case should be ignored when 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.

---

equals

public boolean equals(java.lang.Object other)

Description copied from class: java.lang.Object

Determine whether this Object is semantically equal to another Object.

There are some fairly strict requirements on this method which subclasses must follow:

• It must be transitive. If a.equals(b) and b.equals(c), then a.equals(c) must be true as well.
• It must be symmetric. a.equals(b) and b.equals(a) must have the same value.
• It must be reflexive. a.equals(a) must always be true.
• It must be consistent. Whichever value a.equals(b) returns on the first invocation must be the value returned on all later invocations.
• a.equals(null) must be false.
• It must be consistent with hashCode(). That is, a.equals(b) must imply a.hashCode() == b.hashCode(). The reverse is not true; two objects that are not equal may have the same hashcode, but that has the potential to harm hashing performance.

This is typically overridden to throw a java.lang.ClassCastException if the argument is not comparable to the class performing the comparison, but that is not a requirement. It is legal for a.equals(b) to be true even though a.getClass() != b.getClass(). Also, it is typical to never cause a java.lang.NullPointerException.

In general, the Collections API (java.util) use the equals method rather than the == operator to compare objects. However, java.util.IdentityHashMap is an exception to this rule, for its own good reasons.

The default implementation returns this == o.

---

hashCode

public int hashCode()

Description copied from class: java.lang.Object

Get a value that represents this Object, as uniquely as possible within the confines of an int.

There are some requirements on this method which subclasses must follow:

• Semantic equality implies identical hashcodes. In other words, if a.equals(b) is true, then a.hashCode() == b.hashCode() must be as well. However, the reverse is not necessarily true, and two objects may have the same hashcode without being equal.
• It must be consistent. Whichever value o.hashCode() returns on the first invocation must be the value returned on all later invocations as long as the object exists. Notice, however, that the result of hashCode may change between separate executions of a Virtual Machine, because it is not invoked on the same object.

Notice that since hashCode is used in java.util.Hashtable and other hashing classes, a poor implementation will degrade the performance of hashing (so don't blindly implement it as returning a constant!). Also, if calculating the hash is time-consuming, a class may consider caching the results.

The default implementation returns System.identityHashCode(this)

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> javax >> mail >> [ search overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---