Java 2 Platform EE v1.3: Class HeaderTerm - Java Platform, Enterprise Edition v1.3.1 API Specifications

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.mail.search
Class HeaderTerm

java.lang.Object
  |
  +--javax.mail.search.SearchTerm
        |
        +--javax.mail.search.StringTerm
              |
              +--javax.mail.search.HeaderTerm

public final class HeaderTerm
extends StringTerm

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

Field Summary

protected java.lang.String headerName


Fields inherited from class javax.mail.search.StringTerm

ignoreCase, pattern

Constructor Summary

HeaderTerm(java.lang.String headerName, java.lang.String pattern)
          Constructor.

Method Summary

java.lang.String getHeaderName()
          Return the name of the header to compare with.

boolean match(Message msg)
          The header match method.

Methods inherited from class javax.mail.search.StringTerm

getIgnoreCase, getPattern, match

Methods inherited from class java.lang.Object

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

Field Detail

headerName

protected java.lang.String headerName

Constructor Detail

HeaderTerm

public HeaderTerm(java.lang.String headerName,
                  java.lang.String pattern)

Constructor.

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

Method Detail

getHeaderName

public java.lang.String getHeaderName()

Return the name of the header to compare with.

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