org.infinispan.commands.functional

Class ReadOnlyKeyCommand<K,V,R>

java.lang.Object

org.infinispan.commands.AbstractLocalFlagAffectedCommand

org.infinispan.commands.AbstractFlagAffectedCommand

org.infinispan.commands.read.AbstractDataCommand

org.infinispan.commands.functional.ReadOnlyKeyCommand<K,V,R>

All Implemented Interfaces:

DataCommand, FlagAffectedCommand, LocalCommand, LocalFlagAffectedCommand, MetadataAwareCommand, ReplicableCommand, TopologyAffectedCommand, VisitableCommand

public final class ReadOnlyKeyCommand<K,V,R>
extends AbstractDataCommand
implements LocalCommand

Field Summary

Fields inherited from class org.infinispan.commands.read.AbstractDataCommand

key

Fields inherited from class org.infinispan.commands.AbstractLocalFlagAffectedCommand

flags

Constructor Summary

Constructors

Constructor and Description
ReadOnlyKeyCommand()
ReadOnlyKeyCommand(Object key, Function<EntryView.ReadEntryView<K,V>,R> f)

Method Summary

Modifier and Type	Method and Description
Object	acceptVisitor(InvocationContext ctx, Visitor visitor) Accept a visitor, and return the result of accepting this visitor.
boolean	alwaysReadsExistingValues()
byte	getCommandId() Used by marshallers to convert this command into an id for streaming.
Object	perform(CacheEntry<K,V> entry)
Object	perform(InvocationContext ctx) Performs the primary function of the command.
void	readFrom(ObjectInput input) Reads this instance from the stream written by ReplicableCommand.writeTo(ObjectOutput).
boolean	readsExistingValues()
String	toString()
void	writeTo(ObjectOutput output) Writes this instance to the ObjectOutput.

Methods inherited from class org.infinispan.commands.read.AbstractDataCommand

canBlock, equals, getKey, hashCode, ignoreCommandOnStatus, isReturnValueExpected, setKey, shouldInvoke

Methods inherited from class org.infinispan.commands.AbstractFlagAffectedCommand

getMetadata, getTopologyId, setMetadata, setTopologyId

Methods inherited from class org.infinispan.commands.AbstractLocalFlagAffectedCommand

getFlags, setFlags

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.infinispan.commands.TopologyAffectedCommand

getTopologyId, setTopologyId

Methods inherited from interface org.infinispan.commands.ReplicableCommand

getParameters, setParameters

Methods inherited from interface org.infinispan.commands.LocalFlagAffectedCommand

addFlag, addFlags, getFlags, hasFlag, setFlags, setFlags

Constructor Detail

ReadOnlyKeyCommand

public ReadOnlyKeyCommand(Object key,
                          Function<EntryView.ReadEntryView<K,V>,R> f)

ReadOnlyKeyCommand

public ReadOnlyKeyCommand()

Method Detail

getCommandId

public byte getCommandId()

Description copied from interface: ReplicableCommand

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

Specified by:

getCommandId in interface ReplicableCommand

Returns:

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

writeTo

public void writeTo(ObjectOutput output)
             throws IOException

Description copied from interface: ReplicableCommand

Writes this instance to the ObjectOutput.

Specified by:

writeTo in interface ReplicableCommand

Parameters:

output - the stream.

Throws:

IOException - if an error occurred during the I/O.

readFrom

public void readFrom(ObjectInput input)
              throws IOException,
                     ClassNotFoundException

Description copied from interface: ReplicableCommand

Reads this instance from the stream written by ReplicableCommand.writeTo(ObjectOutput).

Specified by:

readFrom in interface ReplicableCommand

Parameters:

input - the stream to read.

Throws:

IOException - if an error occurred during the I/O.

ClassNotFoundException - if it tries to load an undefined class.

perform

public Object perform(InvocationContext ctx)
               throws Throwable

Description copied from interface: ReplicableCommand

Performs the primary function of the command. Please see specific implementation classes for details on what is performed as well as return types. Important: this method will be invoked at the end of interceptors chain. It should never be called directly from a custom interceptor.

Specified by:

perform in interface ReplicableCommand

Parameters:

ctx - invocation context

Returns:

arbitrary return value generated by performing this command

Throws:

Throwable - in the event of problems.

perform

public Object perform(CacheEntry<K,V> entry)

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.

Specified by:

acceptVisitor in interface VisitableCommand

Parameters:

ctx - invocation context

visitor - visitor to accept

Returns:

arbitrary return value

Throws:

Throwable - in the event of problems

readsExistingValues

public boolean readsExistingValues()

Specified by:

readsExistingValues in interface VisitableCommand

Returns:

true if the command needs to read the previous values of the keys it acts on.

alwaysReadsExistingValues

public boolean alwaysReadsExistingValues()

Specified by:

alwaysReadsExistingValues in interface VisitableCommand

Returns:

true if the command needs to read the previous values even on the backup owners. In transactional caches, this refers to all the owners except the originator.

toString

public String toString()

Overrides:

toString in class AbstractDataCommand