javax.mail.search: public final class: HeaderTerm

javax.mail.search
public final class: HeaderTerm [javadoc | source]

java.lang.Object
   javax.mail.search.SearchTerm
      javax.mail.search.StringTerm
         javax.mail.search.HeaderTerm

All Implemented Interfaces:
Serializable

This class implements comparisons for Message headers. The comparison is case-insensitive.

author: Bill - Shannon

author: John - Mani

Field Summary
protected String	headerName	The name of the header. serial:

Fields inherited from javax.mail.search.StringTerm:
pattern, ignoreCase

Constructor:

Constructor:
public HeaderTerm(String headerName, String pattern) { super(pattern); this.headerName = headerName; } Constructor. Parameters: `headerName` - The name of the header `pattern` - The pattern to search for

 public HeaderTerm(String headerName,
    String pattern) {
	super(pattern);
	this.headerName = headerName;
}

Constructor.

Parameters:

headerName - The name of the header

pattern - The pattern to search for

Method from javax.mail.search.HeaderTerm Summary:
equals, getHeaderName, hashCode, match

Methods from javax.mail.search.StringTerm:
equals, getIgnoreCase, getPattern, hashCode, match

Methods from javax.mail.search.SearchTerm:
match

Methods from java.lang.Object:
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from javax.mail.search.HeaderTerm Detail:
public boolean equals(Object obj) { if (!(obj instanceof HeaderTerm)) return false; HeaderTerm ht = (HeaderTerm)obj; // XXX - depends on header comparisons being case independent return ht.headerName.equalsIgnoreCase(headerName) && super.equals(ht); } Equality comparison.
public String getHeaderName() { return headerName; } Return the name of the header to compare with.
public int hashCode() { // XXX - depends on header comparisons being case independent return headerName.toLowerCase(Locale.ENGLISH).hashCode() + super.hashCode(); } Compute a hashCode for this object.
public boolean match(Message msg) { String[] headers; try { headers = msg.getHeader(headerName); } catch (Exception e) { return false; } if (headers == null) return false; for (int i=0; i < headers.length; i++) if (super.match(headers[i])) return true; return false; } The header match method.

Method from javax.mail.search.HeaderTerm Detail:

 public boolean equals(Object obj) {
	if (!(obj instanceof HeaderTerm))
	    return false;
	HeaderTerm ht = (HeaderTerm)obj;
	// XXX - depends on header comparisons being case independent
	return ht.headerName.equalsIgnoreCase(headerName) && super.equals(ht);
}

Equality comparison.

 public String getHeaderName() {
	return headerName;
}

Return the name of the header to compare with.

 public int hashCode() {
	// XXX - depends on header comparisons being case independent
	return headerName.toLowerCase(Locale.ENGLISH).hashCode() +
					super.hashCode();
}

Compute a hashCode for this object.

 public boolean match(Message msg) {
	String[] headers;
	try {
	    headers = msg.getHeader(headerName);
	} catch (Exception e) {
	    return false;
	}
	if (headers == null)
	    return false;
	for (int i=0; i <  headers.length; i++)
	    if (super.match(headers[i]))
		return true;
	return false;
}

The header match method.