org.jboss.cache.commands.read
Class GetKeysCommand

java.lang.Object
  org.jboss.cache.commands.read.AbstractDataCommand
      org.jboss.cache.commands.read.GetKeysCommand

All Implemented Interfaces:

DataCommand, ReplicableCommand, VisitableCommand

public class GetKeysCommand
extends AbstractDataCommand

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

This is the equivalent of the old MethodCallDefinitions.getKeysMethodLocal method call from 2.1.x.

Since:

2.2.0

Author:

Mircea.Markus@jboss.com

Field Summary

static int

METHOD_ID

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

dataContainer, fqn

Constructor Summary

GetKeysCommand()

GetKeysCommand(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	perform(InvocationContext ctx) Retrieves Set of keys for all the data stored in a node referenced by the specified Fqn.

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

equals, getFqn, getParameters, hashCode, initialize, setParameters, toString

Methods inherited from class java.lang.Object

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

Field Detail

METHOD_ID

public static final int METHOD_ID

See Also:

Constant Field Values

Constructor Detail

GetKeysCommand

public GetKeysCommand(Fqn fqn)

GetKeysCommand

public GetKeysCommand()

Method Detail

perform

public Object perform(InvocationContext ctx)

Retrieves Set of keys for all the data stored in a node referenced by the specified Fqn.

Parameters:

ctx - invocation context

Returns:

a Set of data keys contained in a node for a given Fqn, or null if the Fqn refers to a node that does not exist.

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.