Class SizeCommand

java.lang.Object

org.infinispan.commands.remote.BaseRpcCommand

org.infinispan.commands.read.SizeCommand

All Implemented Interfaces:

FlagAffectedCommand, CacheRpcCommand, ReplicableCommand, TopologyAffectedCommand, TracedCommand, VisitableCommand, VersionAware

@ProtoTypeId(1173)
public class SizeCommand
extends BaseRpcCommand
implements FlagAffectedCommand, TopologyAffectedCommand

Command to calculate the size of the cache

Since:

4.0

Author:

Manik Surtani (manik@jboss.org), Mircea.Markus@jboss.com, Trustin Lee

Nested Class Summary

Nested classes/interfaces inherited from interface VisitableCommand

VisitableCommand.LoadType

Field Summary

Fields inherited from class BaseRpcCommand

cacheName, origin

Fields inherited from interface VisitableCommand

log

Constructor Summary

Constructors

Constructor	Description
SizeCommand(ByteString cacheName, org.infinispan.commons.util.IntSet segments, long flags)

Method Summary

Modifier and Type	Method	Description
Object	acceptVisitor(InvocationContext ctx, Visitor visitor)	Accept a visitor, and return the result of accepting this visitor.
long	getFlagsBitSet()
org.infinispan.commons.util.IntSet	getSegments()
int	getTopologyId()
CompletionStage<?>	invokeAsync(ComponentRegistry registry)	Invoke the command asynchronously.
boolean	isReturnValueExpected()	If true, a return value will be provided when performed remotely.
VisitableCommand.LoadType	loadType()
void	setFlagsBitSet(long bitSet)	Set the flags, replacing any existing flags.
void	setTopologyId(int topologyId)
NodeVersion	supportedSince()	Returns a NodeVersion representing the Infinispan version in which this command was added.
String	toString()

Methods inherited from class BaseRpcCommand

getCacheName, getOrigin, setOrigin

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface CacheRpcCommand

getCacheName, getOrigin, setOrigin

Methods inherited from interface FlagAffectedCommand

addFlags, getFlags, hasAllFlags, hasAnyFlag

Methods inherited from interface ReplicableCommand

getCommandId, isSuccessful, logThrowable, readFrom, writeTo

Methods inherited from interface TracedCommand

getOperationName, getSpanAttributes, setSpanAttributes

Methods inherited from interface VisitableCommand

init

Constructor Details

SizeCommand

public SizeCommand(ByteString cacheName,
 org.infinispan.commons.util.IntSet segments,
 long flags)

Method Details

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

invokeAsync

public CompletionStage<?> invokeAsync(ComponentRegistry registry)
                               throws Throwable

Description copied from interface: CacheRpcCommand

Invoke the command asynchronously.

Specified by:

invokeAsync in interface CacheRpcCommand

Specified by:

invokeAsync in interface VisitableCommand

Throws:

Throwable

loadType

public VisitableCommand.LoadType loadType()

Specified by:

loadType in interface VisitableCommand

Returns:

Nodes on which the command needs to read the previous values of the keys it acts on.

isReturnValueExpected

public boolean isReturnValueExpected()

Description copied from interface: ReplicableCommand

If true, a return value will be provided when performed remotely. Otherwise, a remote ResponseGenerator may choose to simply return null to save on marshalling costs.

Specified by:

isReturnValueExpected in interface ReplicableCommand

Returns:

true or false

getTopologyId

@ProtoField(2)
public int getTopologyId()

Specified by:

getTopologyId in interface TopologyAffectedCommand

setTopologyId

public void setTopologyId(int topologyId)

Specified by:

setTopologyId in interface TopologyAffectedCommand

getFlagsBitSet

@ProtoField(3)
public long getFlagsBitSet()

Specified by:

getFlagsBitSet in interface FlagAffectedCommand

Returns:

The command flags. Flags can be modified with FlagAffectedCommand.setFlagsBitSet(long), FlagAffectedCommand.addFlags(long) and FlagAffectedCommand.addFlags(long) methods.

setFlagsBitSet

public void setFlagsBitSet(long bitSet)

Description copied from interface: FlagAffectedCommand

Set the flags, replacing any existing flags.

Specified by:

setFlagsBitSet in interface FlagAffectedCommand

getSegments

public org.infinispan.commons.util.IntSet getSegments()

supportedSince

public NodeVersion supportedSince()

Description copied from interface: ReplicableCommand

Returns a NodeVersion representing the Infinispan version in which this command was added. This value is used to ensure that when the cluster contains different Infinispan versions, only commands compatible with the oldest version are transmitted.

Abstract classes should not implement this method as the version should be specific to an individual implementation. Similarly, implementations which extend another ReplicableCommand should always override this method.

Specified by:

supportedSince in interface ReplicableCommand

Specified by:

supportedSince in interface VersionAware

Returns:

a NodeVersion corresponding to the Infinispan version this command was added.

toString

public String toString()

Overrides:

toString in class BaseRpcCommand