HeaderTerm (JavaMail API documentation)

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.

Overview

Package

Class

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.mail.search
class HeaderTerm

javax.mail.search.SearchTerm
  javax.mail.search.StringTerm
      javax.mail.search.HeaderTerm

All Implemented Interfaces:: Serializable

public final class HeaderTerm
extends StringTerm

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

Field Summary
`protected String`	`headerName` The name of the header.

Fields inherited from class javax.mail.search.StringTerm
`ignoreCase, pattern`

Constructor Summary
`HeaderTerm(String headerName, String pattern)` Constructor.

Method Summary
`boolean`	`equals(Object obj)` Equality comparison.
`String`	`getHeaderName()` Return the name of the header to compare with.
`int`	`hashCode()` Compute a hashCode for this object.
`boolean`	`match(Message msg)` The header match method.

Methods inherited from class javax.mail.search.StringTerm
`equals, getIgnoreCase, getPattern, hashCode, match`

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

Field Detail

headerName

protected String headerName

The name of the header.

Constructor Detail

HeaderTerm

public HeaderTerm(String headerName,
                  String pattern)

Constructor.

Parameters:: headerName - The name of the header; pattern - The pattern to search for

Method Detail

equals

public boolean equals(Object obj)

Equality comparison.

Overrides:: equals in class StringTerm
Parameters:: obj

getHeaderName

public String getHeaderName()

Return the name of the header to compare with.

hashCode

public int hashCode()

Compute a hashCode for this object.

Overrides:: hashCode in class StringTerm

match

public boolean match(Message msg)

The header match method.

Overrides:: match in class SearchTerm
Parameters:: msg - The match is applied to this Message's header
Returns:: true if the match succeeds, otherwise false