org.apache.jsieve.util
Interface SieveHandler

All Known Implementing Classes:

SieveHandler.Base

public interface SieveHandler

Presents a high level reporting view of a Sieve node tree. Familiarity with Sieve is assumed (but not of the internals of the JSieve implementation). Anyone who requires a low level, JSieve specific view should see NodeHandler

See Also:

NodeTraverser, NodeHandler

Nested Class Summary

static class

SieveHandler.Base Convenience basic implementation.

Method Summary

SieveHandler	argument(int number) Handler a numeric argument.
SieveHandler	argument(java.lang.String identifier) 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.

Method Detail

startScript

SieveHandler startScript()
                         throws HaltTraversalException

Handles the start of a Sieve script.

Returns:

this

Throws:

HaltTraversalException

endScript

SieveHandler endScript()
                       throws HaltTraversalException

Handles the end of a Sieve script.

Returns:

this

Throws:

HaltTraversalException

startBlock

SieveHandler startBlock()
                        throws HaltTraversalException

Handles the start of a block.

Returns:

this

Throws:

HaltTraversalException

endBlock

SieveHandler endBlock()
                      throws HaltTraversalException

Handles the end of a block.

Returns:

this

Throws:

HaltTraversalException

startCommands

SieveHandler startCommands()
                           throws HaltTraversalException

Handles the start of a block of commands.

Returns:

this

Throws:

HaltTraversalException

endCommands

SieveHandler endCommands()
                         throws HaltTraversalException

Handles the end of a block of commands.

Returns:

this

Throws:

HaltTraversalException

startCommand

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

Handles the start of a command.

Parameters:

commandName - name identifying the command

Returns:

this

Throws:

HaltTraversalException

endCommand

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

Handles the end of a command.

Parameters:

commandName - name identifying the command

Returns:

this

Throws:

HaltTraversalException

startArguments

SieveHandler startArguments()
                            throws HaltTraversalException

Handles the start of a block of arguments.

Returns:

this

Throws:

HaltTraversalException

endArguments

SieveHandler endArguments()
                          throws HaltTraversalException

Handles the end of a block of arguments.

Returns:

this

Throws:

HaltTraversalException

argument

SieveHandler argument(java.lang.String identifier)
                      throws HaltTraversalException

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

Parameters:

identifier - not null

Returns:

this

Throws:

HaltTraversalException

argument

SieveHandler argument(int number)
                      throws HaltTraversalException

Handler a numeric argument.

Parameters:

number - not null

Returns:

this

Throws:

HaltTraversalException

startStringListArgument

SieveHandler startStringListArgument()
                                     throws HaltTraversalException

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

Returns:

this

Throws:

HaltTraversalException

endStringListArgument

SieveHandler endStringListArgument()
                                   throws HaltTraversalException

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

Returns:

this

Throws:

HaltTraversalException

listMember

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

One string from a list.

Parameters:

string - not null

Returns:

this

Throws:

HaltTraversalException

startTestList

SieveHandler startTestList()
                           throws HaltTraversalException

Handles the start of a list of tests.

Returns:

this

Throws:

HaltTraversalException

endTestList

SieveHandler endTestList()
                         throws HaltTraversalException

Handles the end of a list of tests.

Returns:

this

Throws:

HaltTraversalException

startTest

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

Handles the start of a test.

Parameters:

testName - name identifying the test

Returns:

this

Throws:

HaltTraversalException

endTest

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

Handles the end of a test.

Parameters:

testName - name identifying the test

Returns:

this

Throws:

HaltTraversalException