com.openexchange.mail.search

Class FlagTerm

java.lang.Object

com.openexchange.mail.search.SearchTerm<java.lang.Integer>

com.openexchange.mail.search.FlagTerm

All Implemented Interfaces:

java.io.Serializable

public final class FlagTerm
extends SearchTerm<java.lang.Integer>

FlagTerm

Author:

Thorben Betten

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
FlagTerm(int flag, boolean set) Initializes a new FlagTerm

Method Summary

Methods

Modifier and Type	Method and Description
void	accept(SearchTermVisitor visitor) Handles given visitor for this search term.
void	addMailField(java.util.Collection<MailField> col) Adds the addressed MailField to specified collection
javax.mail.search.SearchTerm	getJavaMailSearchTerm() Generates the corresponding JavaMail instance of SearchTerm from this search term
javax.mail.search.SearchTerm	getNonWildcardJavaMailSearchTerm() Generates the corresponding instance of SearchTerm from this search term without any wildcard characters.
java.lang.Integer	getPattern() Gets the flags pattern: Either a positive integer if enabled or a negative integer if disabled
boolean	matches(MailMessage mailMessage) Checks if specified mail message matches this search term
boolean	matches(javax.mail.Message msg) Checks if given message matches this search term

Methods inherited from class com.openexchange.mail.search.SearchTerm

containsWildcard, filter, filter, isAscii

Methods inherited from class java.lang.Object

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

Constructor Detail

FlagTerm

public FlagTerm(int flag,
        boolean set)

Initializes a new FlagTerm

Method Detail

accept

public void accept(SearchTermVisitor visitor)

Description copied from class: SearchTerm

Handles given visitor for this search term.

Specified by:

accept in class SearchTerm<java.lang.Integer>

Parameters:

visitor - The visitor

getPattern

public java.lang.Integer getPattern()

Gets the flags pattern: Either a positive integer if enabled or a negative integer if disabled

Specified by:

getPattern in class SearchTerm<java.lang.Integer>

Returns:

The flags pattern

addMailField

public void addMailField(java.util.Collection<MailField> col)

Description copied from class: SearchTerm

Adds the addressed MailField to specified collection

Specified by:

addMailField in class SearchTerm<java.lang.Integer>

Parameters:

col - The collection which gathers addressed fields

matches

public boolean matches(MailMessage mailMessage)

Description copied from class: SearchTerm

Checks if specified mail message matches this search term

Specified by:

matches in class SearchTerm<java.lang.Integer>

Parameters:

mailMessage - The mail message to check

Returns:

true if specified mail message matches this search term; otherwise false

matches

public boolean matches(javax.mail.Message msg)
                throws com.openexchange.exception.OXException

Description copied from class: SearchTerm

Checks if given message matches this search term

Specified by:

matches in class SearchTerm<java.lang.Integer>

Parameters:

msg - The message to check

Returns:

true if message matches this search term; otherwise false

Throws:

com.openexchange.exception.OXException - If check fails

getJavaMailSearchTerm

public javax.mail.search.SearchTerm getJavaMailSearchTerm()

Description copied from class: SearchTerm

Generates the corresponding JavaMail instance of SearchTerm from this search term

Specified by:

getJavaMailSearchTerm in class SearchTerm<java.lang.Integer>

Returns:

The corresponding instance of SearchTerm

getNonWildcardJavaMailSearchTerm

public javax.mail.search.SearchTerm getNonWildcardJavaMailSearchTerm()

Description copied from class: SearchTerm

Generates the corresponding instance of SearchTerm from this search term without any wildcard characters.

This is useful to preselect possible positives and to manually filtering out false positives.

Specified by:

getNonWildcardJavaMailSearchTerm in class SearchTerm<java.lang.Integer>

Returns:

The corresponding instance of SearchTerm without any wildcard characters.

See Also:

SearchTerm.containsWildcard()