org.jboss.cache.commands.write
Class RemoveNodeCommand

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

All Implemented Interfaces:

DataCommand, ReplicableCommand, VersionedDataCommand, VisitableCommand, WriteCommand

Direct Known Subclasses:

PessRemoveNodeCommand

public class RemoveNodeCommand
extends AbstractVersionedDataCommand

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

Since:

2.2

Author:

Mircea.Markus@jboss.com

Field Summary

protected static org.apache.commons.logging.Log	log
static int	METHOD_ID
protected Fqn	parentFqn
protected NodeSPI	targetNode
protected static boolean	trace
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

RemoveNodeCommand()

RemoveNodeCommand(GlobalTransaction globalTransaction, Fqn fqn)

Method Summary

Object	acceptVisitor(InvocationContext ctx, Visitor visitor) Accept a visitor, and return the result of accepting this visitor.
boolean	equals(Object o)
int	getCommandId() Used by marshallers to convert this command into an id for streaming.
Object[]	getParameters() Basic versions of these methods
int	hashCode()
boolean	isSkipSendingNodeEvents()
protected boolean	isVersionedId(int id)
Object	perform(InvocationContext ctx) Removes the node referenced by the specified Fqn.
protected void	recursivelyMarkAsRemoved(NodeSPI node, InvocationContext ctx) Recursively marks a node as removed.
void	setParameters(int commandId, Object[] args) Basic versions of these methods
void	setSkipSendingNodeEvents(boolean skipSendingNodeEvents)
String	toString()

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

getDataVersion, getGlobalTransaction, initialize, isVersioned, peekVersioned, 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

log

protected static final org.apache.commons.logging.Log log

trace

protected static final boolean trace

parentFqn

protected Fqn parentFqn

targetNode

protected NodeSPI targetNode

Constructor Detail

RemoveNodeCommand

public RemoveNodeCommand(GlobalTransaction globalTransaction,
                         Fqn fqn)

RemoveNodeCommand

public RemoveNodeCommand()

Method Detail

perform

public Object perform(InvocationContext ctx)

Removes the node referenced by the specified Fqn.

Parameters:

ctx - invocation context

Returns:

arbitrary return value generated by performing this command

recursivelyMarkAsRemoved

protected void recursivelyMarkAsRemoved(NodeSPI node,
                                        InvocationContext ctx)

Recursively marks a node as removed.

Parameters:

node - Node to mark

ctx - Invocation context

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

isSkipSendingNodeEvents

public boolean isSkipSendingNodeEvents()

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.

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

equals

public boolean equals(Object o)

Overrides:

equals in class AbstractVersionedDataCommand

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractVersionedDataCommand

isVersionedId

protected boolean isVersionedId(int id)

Specified by:

isVersionedId in class AbstractVersionedDataCommand

setSkipSendingNodeEvents

public void setSkipSendingNodeEvents(boolean skipSendingNodeEvents)

toString

public String toString()

Overrides:

toString in class AbstractDataCommand