org.jboss.cache.commands.write
Class EvictCommand

java.lang.Object
  org.jboss.cache.commands.read.AbstractDataCommand
      org.jboss.cache.commands.write.AbstractVersionedDataCommand
          org.jboss.cache.commands.write.EvictCommand

All Implemented Interfaces:

Cloneable, DataCommand, ReplicableCommand, ReversibleCommand, VersionedDataCommand, VisitableCommand

Direct Known Subclasses:

InvalidateCommand

public class EvictCommand
extends AbstractVersionedDataCommand

Implements functionality defined by Cache.evict(org.jboss.cache.Fqn)

Since:

2.2

Author:

Mircea.Markus@jboss.com

Field Summary

static int	METHOD_ID
static int	VERSIONED_METHOD_ID

Fields inherited from class org.jboss.cache.commands.write.AbstractVersionedDataCommand

dataVersion, globalTransaction, notifier

Fields inherited from class org.jboss.cache.commands.read.AbstractDataCommand

dataContainer, fqn

Constructor Summary

EvictCommand()

EvictCommand(Fqn fqn)

Method Summary

Object	acceptVisitor(InvocationContext ctx, Visitor visitor) Accept a visitor, and return the result of accepting this visitor.
int	getCommandId() Used by marshallers to convert this command into an id for streaming.
Object[]	getParameters() Basic versions of these methods
boolean	isRecursive()
protected boolean	isVersionedId(int id)
Object	perform(InvocationContext ctx) Evicts a node.
void	rollback() Reverses a command that has already been invoked.
void	setParameters(int commandId, Object[] args) Basic versions of these methods
void	setRecursive(boolean recursive)
String	toString()

Methods inherited from class org.jboss.cache.commands.write.AbstractVersionedDataCommand

equals, getDataVersion, getGlobalTransaction, hashCode, initialize, isVersioned, setDataVersion, setGlobalTransaction

Methods inherited from class org.jboss.cache.commands.read.AbstractDataCommand

getFqn, initialize

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.jboss.cache.commands.DataCommand

getFqn

Field Detail

METHOD_ID

public static final int METHOD_ID

See Also:

Constant Field Values

VERSIONED_METHOD_ID

public static final int VERSIONED_METHOD_ID

See Also:

Constant Field Values

Constructor Detail

EvictCommand

public EvictCommand(Fqn fqn)

EvictCommand

public EvictCommand()

Method Detail

perform

public Object perform(InvocationContext ctx)

Evicts a node.

See EvictionInterceptor.visitEvictFqnCommand(org.jboss.cache.InvocationContext, EvictCommand) which is where the return value is used

Parameters:

ctx - invocaton context

Returns:

true if the node was removed from the tree. Returns false if the node still exists; i.e. was only data removed because it still has children.

acceptVisitor

public Object acceptVisitor(InvocationContext ctx,
                            Visitor visitor)
                     throws Throwable

Description copied from interface: VisitableCommand

Accept a visitor, and return the result of accepting this visitor.

Parameters:

ctx - invocation context

visitor - visitor to accept

Returns:

arbitrary return value

Throws:

Throwable - in the event of problems

getCommandId

public int getCommandId()

Description copied from interface: ReplicableCommand

Used by marshallers to convert this command into an id for streaming.

Returns:

the method id of this command. This is compatible with pre-2.2.0 MethodCall ids.

isVersionedId

protected boolean isVersionedId(int id)

Specified by:

isVersionedId in class AbstractVersionedDataCommand

isRecursive

public boolean isRecursive()

setRecursive

public void setRecursive(boolean recursive)

getParameters

public Object[] getParameters()

Description copied from class: AbstractDataCommand

Basic versions of these methods

Specified by:

getParameters in interface ReplicableCommand

Overrides:

getParameters in class AbstractVersionedDataCommand

Returns:

an object array of arguments, compatible with pre-2.2.0 MethodCall args.

setParameters

public void setParameters(int commandId,
                          Object[] args)

Description copied from class: AbstractDataCommand

Basic versions of these methods

Specified by:

setParameters in interface ReplicableCommand

Overrides:

setParameters in class AbstractVersionedDataCommand

Parameters:

commandId - command id to set. This is usually unused but *could* be used in the event of a command having multiple IDs, such as PutKeyValueCommand.

args - object array of args

toString

public String toString()

Overrides:

toString in class AbstractDataCommand

rollback

public void rollback()

Description copied from interface: ReversibleCommand

Reverses a command that has already been invoked. Important: this method will be invoked at the end of interceptors chain. It should never be called directly from a custom interceptor.