Package org.infinispan.commands.functional

Class AbstractWriteKeyCommand<K,V>

java.lang.Object

org.infinispan.commands.read.AbstractDataCommand

org.infinispan.commands.write.AbstractDataWriteCommand

org.infinispan.commands.functional.AbstractWriteKeyCommand<K,V>

All Implemented Interfaces:

DataCommand, FlagAffectedCommand, FunctionalCommand<K,V>, ReplicableCommand, SegmentSpecificCommand, TopologyAffectedCommand, VisitableCommand, DataWriteCommand, WriteCommand, RemoteLockCommand

Direct Known Subclasses:

ReadWriteKeyCommand, ReadWriteKeyValueCommand, WriteOnlyKeyCommand, WriteOnlyKeyValueCommand

public abstract class AbstractWriteKeyCommand<K,V>
extends AbstractDataWriteCommand
implements FunctionalCommand<K,V>

Nested Class Summary

Nested classes/interfaces inherited from interface org.infinispan.commands.VisitableCommand

VisitableCommand.LoadType

Field Summary

Fields inherited from class org.infinispan.commands.write.AbstractDataWriteCommand

commandInvocationId

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

key, segment

Constructor Summary

Constructors

Constructor	Description
AbstractWriteKeyCommand()
AbstractWriteKeyCommand(Object key, ValueMatcher valueMatcher, int segment, CommandInvocationId id, Params params, DataConversion keyDataConversion, DataConversion valueDataConversion)

Method Summary

Modifier and Type	Method	Description
void	fail()	Make subsequent invocations of WriteCommand.isSuccessful() return false.
PrivateMetadata	getInternalMetadata()
DataConversion	getKeyDataConversion()
Params	getParams()
DataConversion	getValueDataConversion()
ValueMatcher	getValueMatcher()
void	init(ComponentRegistry componentRegistry)
boolean	isSuccessful()	Some commands may want to provide information on whether the command was successful or not.
void	setInternalMetadata(PrivateMetadata internalMetadata)
void	setValueMatcher(ValueMatcher valueMatcher)
String	toString()

Methods inherited from class org.infinispan.commands.write.AbstractDataWriteCommand

getAffectedKeys, getCommandInvocationId, getKeyLockOwner, getKeysToLock, hasSkipLocking, hasZeroLockAcquisition, isReturnValueExpected

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

equals, getFlagsBitSet, getKey, getSegment, getTopologyId, hashCode, printFlags, setFlagsBitSet, setKey, setTopologyId

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.infinispan.commands.DataCommand

getKey

Methods inherited from interface org.infinispan.commands.write.DataWriteCommand

getInternalMetadata, setInternalMetadata

Methods inherited from interface org.infinispan.commands.FlagAffectedCommand

addFlag, addFlags, addFlags, getFlags, getFlagsBitSet, hasAllFlags, hasAnyFlag, hasFlag, setFlags, setFlagsBitSet

Methods inherited from interface org.infinispan.commands.functional.FunctionalCommand

toMutation

Methods inherited from interface org.infinispan.commands.ReplicableCommand

canBlock, getCommandId, invoke, invokeAsync, readFrom, setOrigin, writeTo

Methods inherited from interface org.infinispan.commands.SegmentSpecificCommand

getSegment

Methods inherited from interface org.infinispan.commands.TopologyAffectedCommand

getTopologyId, setTopologyId

Methods inherited from interface org.infinispan.commands.VisitableCommand

acceptVisitor, loadType

Methods inherited from interface org.infinispan.commands.write.WriteCommand

isConditional, isWriteOnly, updateStatusFromRemoteResponse

Constructor Detail

AbstractWriteKeyCommand

public AbstractWriteKeyCommand(Object key,
                               ValueMatcher valueMatcher,
                               int segment,
                               CommandInvocationId id,
                               Params params,
                               DataConversion keyDataConversion,
                               DataConversion valueDataConversion)

AbstractWriteKeyCommand

public AbstractWriteKeyCommand()

Method Detail

init

public void init(ComponentRegistry componentRegistry)

Specified by:

init in interface VisitableCommand

getValueMatcher

public ValueMatcher getValueMatcher()

Specified by:

getValueMatcher in interface WriteCommand

Returns:

The current value matching policy.

setValueMatcher

public void setValueMatcher(ValueMatcher valueMatcher)

Specified by:

setValueMatcher in interface WriteCommand

Parameters:

valueMatcher - The new value matching policy.

isSuccessful

public boolean isSuccessful()

Description copied from interface: WriteCommand

Some commands may want to provide information on whether the command was successful or not. This is different from a failure, which usually would result in an exception being thrown. An example is a putIfAbsent() not doing anything because the key in question was present. This would result in a isSuccessful() call returning false.

Specified by:

isSuccessful in interface ReplicableCommand

Specified by:

isSuccessful in interface WriteCommand

Returns:

true if the command completed successfully, false otherwise.

getParams

public Params getParams()

Specified by:

getParams in interface FunctionalCommand<K,V>

fail

public void fail()

Description copied from interface: WriteCommand

Make subsequent invocations of WriteCommand.isSuccessful() return false.

Specified by:

fail in interface WriteCommand

toString

public String toString()

Overrides:

toString in class AbstractDataCommand

getKeyDataConversion

public DataConversion getKeyDataConversion()

Specified by:

getKeyDataConversion in interface FunctionalCommand<K,V>

getValueDataConversion

public DataConversion getValueDataConversion()

Specified by:

getValueDataConversion in interface FunctionalCommand<K,V>

getInternalMetadata

public PrivateMetadata getInternalMetadata()

Specified by:

getInternalMetadata in interface DataWriteCommand

setInternalMetadata

public void setInternalMetadata(PrivateMetadata internalMetadata)

Specified by:

setInternalMetadata in interface DataWriteCommand