Package org.infinispan.commands.read

Class SizeCommand

java.lang.Object

org.infinispan.commands.remote.BaseRpcCommand

org.infinispan.commands.read.SizeCommand

All Implemented Interfaces:

FlagAffectedCommand, CacheRpcCommand, ReplicableCommand, TopologyAffectedCommand, TracedCommand, VisitableCommand

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 org.infinispan.commands.VisitableCommand

VisitableCommand.LoadType

Field Summary

Fields

Modifier and Type	Field	Description
static final byte	COMMAND_ID

Fields inherited from class org.infinispan.commands.remote.BaseRpcCommand

cacheName, origin

Constructor Summary

Constructors

Constructor	Description
SizeCommand(ByteString name)
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.
byte	getCommandId()	Used by marshallers to convert this command into an id for streaming.
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	readFrom(ObjectInput input)	Reads this instance from the stream written by ReplicableCommand.writeTo(ObjectOutput).
void	setFlagsBitSet(long bitSet)	Set the flags, replacing any existing flags.
void	setTopologyId(int topologyId)
String	toString()
void	writeTo(ObjectOutput output)	Writes this instance to the ObjectOutput.

Methods inherited from class org.infinispan.commands.remote.BaseRpcCommand

getCacheName, getOrigin, setOrigin

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.infinispan.commands.FlagAffectedCommand

addFlags, getFlags, hasAllFlags, hasAnyFlag

Methods inherited from interface org.infinispan.commands.ReplicableCommand

canBlock, invoke, invokeAsync, isSuccessful, logThrowable

Methods inherited from interface org.infinispan.commands.TracedCommand

getOperationName, getSpanAttributes, setSpanAttributes

Methods inherited from interface org.infinispan.commands.VisitableCommand

init

Field Details

COMMAND_ID

public static final byte COMMAND_ID

See Also:

• Constant Field Values

Constructor Details

SizeCommand

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

SizeCommand

public SizeCommand(ByteString name)

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.

This method replaces ReplicableCommand.invoke() for remote execution. The default implementation and ReplicableCommand.invoke() will be removed in future versions.

Specified by:

invokeAsync in interface CacheRpcCommand

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.

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.

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

public int getTopologyId()

Specified by:

getTopologyId in interface TopologyAffectedCommand

setTopologyId

public void setTopologyId(int topologyId)

Specified by:

setTopologyId in interface TopologyAffectedCommand

getFlagsBitSet

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()

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.

toString

public String toString()

Overrides:

toString in class BaseRpcCommand