org.jboss.cache.commands

Class AbstractVisitor

java.lang.Object

org.jboss.cache.commands.AbstractVisitor

All Implemented Interfaces:

Visitor

Direct Known Subclasses:

CacheStoreInterceptor.StoreModificationsBuilder, CommandInterceptor, Fqn2BuddyFqnVisitor, InvalidationInterceptor.InvalidationFilterVisitor, OptimisticReplicationInterceptor.DataVersionPopulator

public abstract class AbstractVisitor
extends Object
implements Visitor

An abstract implementation of a Visitor that delegates all visit calls to a default handler which can be overridden.

Since:

2.2.0

Author:

Mircea.Markus@jboss.com, Manik Surtani

Constructor Summary

Constructors

Constructor and Description
AbstractVisitor()

Method Summary

Methods

Modifier and Type	Method and Description
protected Object	handleDefault(InvocationContext ctx, VisitableCommand command) A default handler for all commands visited.
Object	visitClearDataCommand(InvocationContext ctx, ClearDataCommand command) Visits a RemoveDataCommand.
void	visitCollection(InvocationContext ctx, Collection<? extends VisitableCommand> toVisit) Helper method to visit a collection of VisitableCommands.
Object	visitCommitCommand(InvocationContext ctx, CommitCommand command) Visits a CommitCommand.
Object	visitCreateNodeCommand(InvocationContext ctx, CreateNodeCommand command) Visits a CreateNodeCommand.
Object	visitEvictFqnCommand(InvocationContext ctx, EvictCommand command) Visits a EvictCommand.
Object	visitExistsNodeCommand(InvocationContext ctx, ExistsCommand command) Visits a RemoteExistsCommand.
Object	visitGetChildrenNamesCommand(InvocationContext ctx, GetChildrenNamesCommand command) Visits a GetChildrenNamesCommand.
Object	visitGetDataMapCommand(InvocationContext ctx, GetDataMapCommand command) Visits a GetDataMapCommand.
Object	visitGetKeysCommand(InvocationContext ctx, GetKeysCommand command) Visits a GetKeysCommand.
Object	visitGetKeyValueCommand(InvocationContext ctx, GetKeyValueCommand command) Visits a GetKeyValueCommand.
Object	visitGetNodeCommand(InvocationContext ctx, GetNodeCommand command) Visits a GetNodeCommand.
Object	visitGravitateDataCommand(InvocationContext ctx, GravitateDataCommand command) Visits a GravitateDataCommand.
Object	visitInvalidateCommand(InvocationContext ctx, InvalidateCommand command) Visits a InvalidateCommand.
Object	visitMoveCommand(InvocationContext ctx, MoveCommand command) Visits a MoveCommand.
Object	visitOptimisticPrepareCommand(InvocationContext ctx, OptimisticPrepareCommand command) Visits a OptimisticPrepareCommand.
Object	visitPrepareCommand(InvocationContext ctx, PrepareCommand command) Visits a PrepareCommand.
Object	visitPutDataMapCommand(InvocationContext ctx, PutDataMapCommand command) Visits a PutDataMapCommand.
Object	visitPutForExternalReadCommand(InvocationContext ctx, PutForExternalReadCommand command) Visits a PutForExternalReadCommand.
Object	visitPutKeyValueCommand(InvocationContext ctx, PutKeyValueCommand command) Visits a PutKeyValueCommand.
Object	visitRemoveKeyCommand(InvocationContext ctx, RemoveKeyCommand command) Visits a RemoveKeyCommand.
Object	visitRemoveNodeCommand(InvocationContext ctx, RemoveNodeCommand command) Visits a RemoveNodeCommand.
Object	visitRollbackCommand(InvocationContext ctx, RollbackCommand command) Visits a RollbackCommand.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractVisitor

public AbstractVisitor()

Method Detail

visitPutDataMapCommand

public Object visitPutDataMapCommand(InvocationContext ctx,
                            PutDataMapCommand command)
                              throws Throwable

Description copied from interface: Visitor

Visits a PutDataMapCommand.

Specified by:

visitPutDataMapCommand in interface Visitor

Parameters:

ctx - invocation context

command - command to visit

Returns:

response from the visit

Throws:

Throwable - in the event of problems.

visitPutKeyValueCommand

public Object visitPutKeyValueCommand(InvocationContext ctx,
                             PutKeyValueCommand command)
                               throws Throwable

Description copied from interface: Visitor

Visits a PutKeyValueCommand.

Specified by:

visitPutKeyValueCommand in interface Visitor

Parameters:

ctx - invocation context

command - command to visit

Returns:

response from the visit

Throws:

Throwable - in the event of problems.

visitPutForExternalReadCommand

public Object visitPutForExternalReadCommand(InvocationContext ctx,
                                    PutForExternalReadCommand command)
                                      throws Throwable

Description copied from interface: Visitor

Visits a PutForExternalReadCommand.

Specified by:

visitPutForExternalReadCommand in interface Visitor

Parameters:

ctx - invocation context

command - command to visit

Returns:

response from the visit

Throws:

Throwable - in the event of problems.

visitRemoveNodeCommand

public Object visitRemoveNodeCommand(InvocationContext ctx,
                            RemoveNodeCommand command)
                              throws Throwable

Description copied from interface: Visitor

Visits a RemoveNodeCommand.

Specified by:

visitRemoveNodeCommand in interface Visitor

Parameters:

ctx - invocation context

command - command to visit

Returns:

response from the visit

Throws:

Throwable - in the event of problems.

visitClearDataCommand

public Object visitClearDataCommand(InvocationContext ctx,
                           ClearDataCommand command)
                             throws Throwable

Description copied from interface: Visitor

Visits a RemoveDataCommand.

Specified by:

visitClearDataCommand in interface Visitor

Parameters:

ctx - invocation context

command - command to visit

Returns:

response from the visit

Throws:

Throwable - in the event of problems.

visitEvictFqnCommand

public Object visitEvictFqnCommand(InvocationContext ctx,
                          EvictCommand command)
                            throws Throwable

Description copied from interface: Visitor

Visits a EvictCommand.

Specified by:

visitEvictFqnCommand in interface Visitor

Parameters:

ctx - invocation context

command - command to visit

Returns:

response from the visit

Throws:

Throwable - in the event of problems.

visitInvalidateCommand

public Object visitInvalidateCommand(InvocationContext ctx,
                            InvalidateCommand command)
                              throws Throwable

Description copied from interface: Visitor

Visits a InvalidateCommand.

Specified by:

visitInvalidateCommand in interface Visitor

Parameters:

ctx - invocation context

command - command to visit

Returns:

response from the visit

Throws:

Throwable - in the event of problems.

visitRemoveKeyCommand

public Object visitRemoveKeyCommand(InvocationContext ctx,
                           RemoveKeyCommand command)
                             throws Throwable

Description copied from interface: Visitor

Visits a RemoveKeyCommand.

Specified by:

visitRemoveKeyCommand in interface Visitor

Parameters:

ctx - invocation context

command - command to visit

Returns:

response from the visit

Throws:

Throwable - in the event of problems.

visitGetDataMapCommand

public Object visitGetDataMapCommand(InvocationContext ctx,
                            GetDataMapCommand command)
                              throws Throwable

Description copied from interface: Visitor

Visits a GetDataMapCommand.

Specified by:

visitGetDataMapCommand in interface Visitor

Parameters:

ctx - invocation context

command - command to visit

Returns:

response from the visit

Throws:

Throwable - in the event of problems.

visitExistsNodeCommand

public Object visitExistsNodeCommand(InvocationContext ctx,
                            ExistsCommand command)
                              throws Throwable

Description copied from interface: Visitor

Visits a RemoteExistsCommand.

Specified by:

visitExistsNodeCommand in interface Visitor

Parameters:

ctx - invocation context

command - command to visit

Returns:

response from the visit

Throws:

Throwable - in the event of problems.

visitGetKeyValueCommand

public Object visitGetKeyValueCommand(InvocationContext ctx,
                             GetKeyValueCommand command)
                               throws Throwable

Description copied from interface: Visitor

Visits a GetKeyValueCommand.

Specified by:

visitGetKeyValueCommand in interface Visitor

Parameters:

ctx - invocation context

command - command to visit

Returns:

response from the visit

Throws:

Throwable - in the event of problems.

visitGetNodeCommand

public Object visitGetNodeCommand(InvocationContext ctx,
                         GetNodeCommand command)
                           throws Throwable

Description copied from interface: Visitor

Visits a GetNodeCommand.

Specified by:

visitGetNodeCommand in interface Visitor

Parameters:

ctx - invocation context

command - command to visit

Returns:

response from the visit

Throws:

Throwable - in the event of problems.

visitGetKeysCommand

public Object visitGetKeysCommand(InvocationContext ctx,
                         GetKeysCommand command)
                           throws Throwable

Description copied from interface: Visitor

Visits a GetKeysCommand.

Specified by:

visitGetKeysCommand in interface Visitor

Parameters:

ctx - invocation context

command - command to visit

Returns:

response from the visit

Throws:

Throwable - in the event of problems.

visitGetChildrenNamesCommand

public Object visitGetChildrenNamesCommand(InvocationContext ctx,
                                  GetChildrenNamesCommand command)
                                    throws Throwable

Description copied from interface: Visitor

Visits a GetChildrenNamesCommand.

Specified by:

visitGetChildrenNamesCommand in interface Visitor

Parameters:

ctx - invocation context

command - command to visit

Returns:

response from the visit

Throws:

Throwable - in the event of problems.

visitMoveCommand

public Object visitMoveCommand(InvocationContext ctx,
                      MoveCommand command)
                        throws Throwable

Description copied from interface: Visitor

Visits a MoveCommand.

Specified by:

visitMoveCommand in interface Visitor

Parameters:

ctx - invocation context

command - command to visit

Returns:

response from the visit

Throws:

Throwable - in the event of problems.

visitGravitateDataCommand

public Object visitGravitateDataCommand(InvocationContext ctx,
                               GravitateDataCommand command)
                                 throws Throwable

Description copied from interface: Visitor

Visits a GravitateDataCommand.

Specified by:

visitGravitateDataCommand in interface Visitor

Parameters:

ctx - invocation context

command - command to visit

Returns:

response from the visit

Throws:

Throwable - in the event of problems.

visitPrepareCommand

public Object visitPrepareCommand(InvocationContext ctx,
                         PrepareCommand command)
                           throws Throwable

Description copied from interface: Visitor

Visits a PrepareCommand.

Specified by:

visitPrepareCommand in interface Visitor

Parameters:

ctx - invocation context

command - command to visit

Returns:

response from the visit

Throws:

Throwable - in the event of problems.

visitRollbackCommand

public Object visitRollbackCommand(InvocationContext ctx,
                          RollbackCommand command)
                            throws Throwable

Description copied from interface: Visitor

Visits a RollbackCommand.

Specified by:

visitRollbackCommand in interface Visitor

Parameters:

ctx - invocation context

command - command to visit

Returns:

response from the visit

Throws:

Throwable - in the event of problems.

visitCommitCommand

public Object visitCommitCommand(InvocationContext ctx,
                        CommitCommand command)
                          throws Throwable

Description copied from interface: Visitor

Visits a CommitCommand.

Specified by:

visitCommitCommand in interface Visitor

Parameters:

ctx - invocation context

command - command to visit

Returns:

response from the visit

Throws:

Throwable - in the event of problems.

visitOptimisticPrepareCommand

public Object visitOptimisticPrepareCommand(InvocationContext ctx,
                                   OptimisticPrepareCommand command)
                                     throws Throwable

Description copied from interface: Visitor

Visits a OptimisticPrepareCommand.

Specified by:

visitOptimisticPrepareCommand in interface Visitor

Parameters:

ctx - invocation context

command - command to visit

Returns:

response from the visit

Throws:

Throwable - in the event of problems.

visitCreateNodeCommand

public Object visitCreateNodeCommand(InvocationContext ctx,
                            CreateNodeCommand command)
                              throws Throwable

Description copied from interface: Visitor

Visits a CreateNodeCommand.

Specified by:

visitCreateNodeCommand in interface Visitor

Parameters:

ctx - invocation context

command - command to visit

Returns:

response from the visit

Throws:

Throwable - in the event of problems.

handleDefault

protected Object handleDefault(InvocationContext ctx,
                   VisitableCommand command)
                        throws Throwable

A default handler for all commands visited. This is called for any visit method called, unless a visit command is appropriately overridden.

Parameters:

ctx - invocation context

command - command to handle

Returns:

return value

Throws:

Throwable - in the case of a problem

visitCollection

public void visitCollection(InvocationContext ctx,
                   Collection<? extends VisitableCommand> toVisit)
                     throws Throwable

Helper method to visit a collection of VisitableCommands.

Parameters:

ctx - Invocation context

toVisit - collection of commands to visit

Throws:

Throwable - in the event of problems