org.infinispan.commands.read

Class AbstractLocalCommand

java.lang.Object

org.infinispan.commands.AbstractFlagAffectedCommand

org.infinispan.commands.read.AbstractLocalCommand

All Implemented Interfaces:

FlagAffectedCommand, LocalCommand, ReplicableCommand, VisitableCommand

Direct Known Subclasses:

EntrySetCommand, KeySetCommand, SizeCommand

public abstract class AbstractLocalCommand
extends AbstractFlagAffectedCommand
implements LocalCommand

Abstract class

Since:

4.1

Author:

Manik Surtani, Mircea.Markus@jboss.com

Nested Class Summary

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

VisitableCommand.LoadType

Constructor Summary

Constructors

Constructor and Description
AbstractLocalCommand()

Method Summary

Modifier and Type	Method and Description
byte	getCommandId() Used by marshallers to convert this command into an id for streaming.
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	writeTo(ObjectOutput output) Writes this instance to the ObjectOutput.

Methods inherited from class org.infinispan.commands.AbstractFlagAffectedCommand

getFlagsBitSet, hasSameFlags, printFlags, setFlagsBitSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.infinispan.commands.FlagAffectedCommand

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

Methods inherited from interface org.infinispan.commands.VisitableCommand

acceptVisitor, init

Methods inherited from interface org.infinispan.commands.ReplicableCommand

canBlock, invoke, invokeAsync, isSuccessful, setOrigin

Constructor Detail

AbstractLocalCommand

public AbstractLocalCommand()

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 final 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 final 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.

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

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.