org.apache.jsieve.tests
Class AbstractCompatatorTest

java.lang.Object
  org.apache.jsieve.tests.AbstractTest
      org.apache.jsieve.tests.AbstractCompatatorTest

All Implemented Interfaces:

ExecutableTest

Direct Known Subclasses:

Address, Envelope

public abstract class AbstractCompatatorTest
extends AbstractTest

Constructor Summary

AbstractCompatatorTest()

Method Summary

protected boolean	executeBasic(MailAdapter mail, Arguments arguments, SieveContext context) From RFC 3028, Section 5.1...
protected boolean	match(MailAdapter mail, java.lang.String addressPart, java.lang.String comparator, java.lang.String matchType, java.util.List<java.lang.String> headerNames, java.util.List<java.lang.String> keys, SieveContext context) Method match.
protected boolean	match(MailAdapter mail, java.lang.String addressPart, java.lang.String comparator, java.lang.String matchType, java.lang.String headerName, java.util.List<java.lang.String> keys, SieveContext context) Method match.
protected abstract boolean	match(MailAdapter mail, java.lang.String addressPart, java.lang.String comparator, java.lang.String matchType, java.lang.String headerName, java.lang.String key, SieveContext context) Method match.
protected void	validateArguments(Arguments arguments, SieveContext context) Framework method validateArguments is invoked before a Sieve Test is executed to validate its arguments.

Methods inherited from class org.apache.jsieve.tests.AbstractTest

execute

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractCompatatorTest

public AbstractCompatatorTest()

Method Detail

executeBasic

protected boolean executeBasic(MailAdapter mail,
                               Arguments arguments,
                               SieveContext context)
                        throws SieveException

From RFC 3028, Section 5.1...

Syntax: address [ADDRESS-PART] [COMPARATOR] [MATCH-TYPE] <header-list: string-list> <key-list: string-list>

Note that the spec. then goes on to give an example where the order of the optional parts is different, so I am assuming that the order of the optional parts is optional too!

Specified by:

executeBasic in class AbstractTest

context - SieveContext giving contextual information, not null

Returns:

boolean

Throws:

SieveException

See Also:

AbstractTest.executeBasic(MailAdapter, Arguments, SieveContext)

match

protected boolean match(MailAdapter mail,
                        java.lang.String addressPart,
                        java.lang.String comparator,
                        java.lang.String matchType,
                        java.util.List<java.lang.String> headerNames,
                        java.util.List<java.lang.String> keys,
                        SieveContext context)
                 throws SieveException

Method match.

Parameters:

mail -

addressPart -

comparator -

matchType -

headerNames -

keys -

context - not null

Returns:

boolean

Throws:

SieveMailException

SieveException

match

protected boolean match(MailAdapter mail,
                        java.lang.String addressPart,
                        java.lang.String comparator,
                        java.lang.String matchType,
                        java.lang.String headerName,
                        java.util.List<java.lang.String> keys,
                        SieveContext context)
                 throws SieveException

Method match.

Parameters:

mail -

addressPart -

comparator -

matchType -

headerName -

keys -

context - not null

Returns:

boolean

Throws:

SieveMailException

SieveException

match

protected abstract boolean match(MailAdapter mail,
                                 java.lang.String addressPart,
                                 java.lang.String comparator,
                                 java.lang.String matchType,
                                 java.lang.String headerName,
                                 java.lang.String key,
                                 SieveContext context)
                          throws SieveException

Method match.

Parameters:

mail -

addressPart -

comparator -

matchType -

headerName -

key -

context - not null

Returns:

boolean

Throws:

SieveMailException

SieveException

validateArguments

protected void validateArguments(Arguments arguments,
                                 SieveContext context)
                          throws SieveException

Description copied from class: AbstractTest

Framework method validateArguments is invoked before a Sieve Test is executed to validate its arguments. Subclass methods are expected to override or extend this method to perform their own validation as appropriate.

Overrides:

validateArguments in class AbstractTest

context - SieveContext giving comntextual information, not null

Throws:

SieveException

See Also:

AbstractTest.validateArguments(Arguments, SieveContext)