org.jboss.cache.commands.read

Class GetKeyValueCommand

java.lang.Object

org.jboss.cache.commands.read.AbstractDataCommand

org.jboss.cache.commands.read.GetKeyValueCommand

All Implemented Interfaces:

DataCommand, ReplicableCommand, VisitableCommand

public class GetKeyValueCommand
extends AbstractDataCommand

Implements functionality defined by Cache.get(String, Object)

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

Since:

2.2.0

Author:

Mircea.Markus@jboss.com

Field Summary

Fields

Modifier and Type	Field and Description
static int	METHOD_ID

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

dataContainer, fqn

Constructor Summary

Constructors

Constructor and Description
GetKeyValueCommand()
GetKeyValueCommand(Fqn fqn, Object key, boolean sendNodeEvent)

Method Summary

Methods

Modifier and Type	Method and Description
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	getKey()
Object[]	getParameters() Basic versions of these methods
int	hashCode()
void	initialize(DataContainer dataContainer, Notifier notifier)
boolean	isSendNodeEvent()
Object	perform(InvocationContext ctx) Retrieves the value stored under a specified key in a node referenced by the specified Fqn.
void	setKey(Object key)
void	setParameters(int commandId, Object[] args) Basic versions of these methods
String	toString()

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

Field Detail

METHOD_ID

public static final int METHOD_ID

See Also:

Constant Field Values

Constructor Detail

GetKeyValueCommand

public GetKeyValueCommand(Fqn fqn,
                  Object key,
                  boolean sendNodeEvent)

GetKeyValueCommand

public GetKeyValueCommand()

Method Detail

initialize

public void initialize(DataContainer dataContainer,
              Notifier notifier)

perform

public Object perform(InvocationContext ctx)

Retrieves the value stored under a specified key in a node referenced by the specified Fqn.

Parameters:

ctx - invocation context

Returns:

an Object of type V, stored under a specific key 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

getKey

public Object getKey()

isSendNodeEvent

public boolean isSendNodeEvent()

setKey

public void setKey(Object key)

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 AbstractDataCommand

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 AbstractDataCommand

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 AbstractDataCommand

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractDataCommand

toString

public String toString()

Overrides:

toString in class AbstractDataCommand