org.apache.jsieve.util
Class SieveHandler.Base

java.lang.Object
  org.apache.jsieve.util.SieveHandler.Base

All Implemented Interfaces:

SieveHandler

Enclosing interface:

SieveHandler

public abstract static class SieveHandler.Base
extends java.lang.Object
implements SieveHandler

Convenience basic implementation. All methods do nothing.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.jsieve.util.SieveHandler

SieveHandler.Base

Constructor Summary

SieveHandler.Base()

Method Summary

SieveHandler	argument(int number) Handler a numeric argument.
SieveHandler	argument(java.lang.String tag) Handles a tag argument.
SieveHandler	endArguments() Handles the end of a block of arguments.
SieveHandler	endBlock() Handles the end of a block.
SieveHandler	endCommand(java.lang.String commandName) Handles the end of a command.
SieveHandler	endCommands() Handles the end of a block of commands.
SieveHandler	endScript() Handles the end of a Sieve script.
SieveHandler	endStringListArgument() Handles the end of an argument which is a list of strings.
SieveHandler	endTest(java.lang.String testName) Handles the end of a test.
SieveHandler	endTestList() Handles the end of a list of tests.
SieveHandler	listMember(java.lang.String string) One string from a list.
SieveHandler	startArguments() Handles the start of a block of arguments.
SieveHandler	startBlock() Handles the start of a block.
SieveHandler	startCommand(java.lang.String commandName) Handles the start of a command.
SieveHandler	startCommands() Handles the start of a block of commands.
SieveHandler	startScript() Handles the start of a Sieve script.
SieveHandler	startStringListArgument() Handles the start of an argument which is a list of strings.
SieveHandler	startTest(java.lang.String testName) Handles the start of a test.
SieveHandler	startTestList() Handles the start of a list of tests.

Methods inherited from class java.lang.Object

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

Constructor Detail

SieveHandler.Base

public SieveHandler.Base()

Method Detail

argument

public SieveHandler argument(int number)
                      throws HaltTraversalException

Description copied from interface: SieveHandler

Handler a numeric argument.

Specified by:

argument in interface SieveHandler

Parameters:

number - not null

Returns:

this

Throws:

HaltTraversalException

argument

public SieveHandler argument(java.lang.String tag)
                      throws HaltTraversalException

Description copied from interface: SieveHandler

Handles a tag argument. Note that this supplies the identifier for the tag (after the leading ':' has been stripped).

Specified by:

argument in interface SieveHandler

Parameters:

tag - not null

Returns:

this

Throws:

HaltTraversalException

endArguments

public SieveHandler endArguments()
                          throws HaltTraversalException

Description copied from interface: SieveHandler

Handles the end of a block of arguments.

Specified by:

endArguments in interface SieveHandler

Returns:

this

Throws:

HaltTraversalException

endBlock

public SieveHandler endBlock()
                      throws HaltTraversalException

Description copied from interface: SieveHandler

Handles the end of a block.

Specified by:

endBlock in interface SieveHandler

Returns:

this

Throws:

HaltTraversalException

endCommand

public SieveHandler endCommand(java.lang.String commandName)
                        throws HaltTraversalException

Description copied from interface: SieveHandler

Handles the end of a command.

Specified by:

endCommand in interface SieveHandler

Parameters:

commandName - name identifying the command

Returns:

this

Throws:

HaltTraversalException

endCommands

public SieveHandler endCommands()
                         throws HaltTraversalException

Description copied from interface: SieveHandler

Handles the end of a block of commands.

Specified by:

endCommands in interface SieveHandler

Returns:

this

Throws:

HaltTraversalException

endScript

public SieveHandler endScript()
                       throws HaltTraversalException

Description copied from interface: SieveHandler

Handles the end of a Sieve script.

Specified by:

endScript in interface SieveHandler

Returns:

this

Throws:

HaltTraversalException

endStringListArgument

public SieveHandler endStringListArgument()
                                   throws HaltTraversalException

Description copied from interface: SieveHandler

Handles the end of an argument which is a list of strings.

Specified by:

endStringListArgument in interface SieveHandler

Returns:

this

Throws:

HaltTraversalException

endTest

public SieveHandler endTest(java.lang.String testName)
                     throws HaltTraversalException

Description copied from interface: SieveHandler

Handles the end of a test.

Specified by:

endTest in interface SieveHandler

Parameters:

testName - name identifying the test

Returns:

this

Throws:

HaltTraversalException

endTestList

public SieveHandler endTestList()
                         throws HaltTraversalException

Description copied from interface: SieveHandler

Handles the end of a list of tests.

Specified by:

endTestList in interface SieveHandler

Returns:

this

Throws:

HaltTraversalException

listMember

public SieveHandler listMember(java.lang.String string)
                        throws HaltTraversalException

Description copied from interface: SieveHandler

One string from a list.

Specified by:

listMember in interface SieveHandler

Parameters:

string - not null

Returns:

this

Throws:

HaltTraversalException

startArguments

public SieveHandler startArguments()
                            throws HaltTraversalException

Description copied from interface: SieveHandler

Handles the start of a block of arguments.

Specified by:

startArguments in interface SieveHandler

Returns:

this

Throws:

HaltTraversalException

startBlock

public SieveHandler startBlock()
                        throws HaltTraversalException

Description copied from interface: SieveHandler

Handles the start of a block.

Specified by:

startBlock in interface SieveHandler

Returns:

this

Throws:

HaltTraversalException

startCommand

public SieveHandler startCommand(java.lang.String commandName)
                          throws HaltTraversalException

Description copied from interface: SieveHandler

Handles the start of a command.

Specified by:

startCommand in interface SieveHandler

Parameters:

commandName - name identifying the command

Returns:

this

Throws:

HaltTraversalException

startCommands

public SieveHandler startCommands()
                           throws HaltTraversalException

Description copied from interface: SieveHandler

Handles the start of a block of commands.

Specified by:

startCommands in interface SieveHandler

Returns:

this

Throws:

HaltTraversalException

startScript

public SieveHandler startScript()
                         throws HaltTraversalException

Description copied from interface: SieveHandler

Handles the start of a Sieve script.

Specified by:

startScript in interface SieveHandler

Returns:

this

Throws:

HaltTraversalException

startStringListArgument

public SieveHandler startStringListArgument()
                                     throws HaltTraversalException

Description copied from interface: SieveHandler

Handles the start of an argument which is a list of strings.

Specified by:

startStringListArgument in interface SieveHandler

Returns:

this

Throws:

HaltTraversalException

startTest

public SieveHandler startTest(java.lang.String testName)
                       throws HaltTraversalException

Description copied from interface: SieveHandler

Handles the start of a test.

Specified by:

startTest in interface SieveHandler

Parameters:

testName - name identifying the test

Returns:

this

Throws:

HaltTraversalException

startTestList

public SieveHandler startTestList()
                           throws HaltTraversalException

Description copied from interface: SieveHandler

Handles the start of a list of tests.

Specified by:

startTestList in interface SieveHandler

Returns:

this

Throws:

HaltTraversalException