Class ClearCommand
java.lang.Object
org.infinispan.commands.AbstractFlagAffectedCommand
org.infinispan.commands.AbstractTopologyAffectedCommand
org.infinispan.commands.write.ClearCommand
- All Implemented Interfaces:
FlagAffectedCommand, CacheRpcCommand, ReplicableCommand, TopologyAffectedCommand, TracedCommand, VisitableCommand, WriteCommand, VersionAware
@ProtoTypeId(1053)
public class ClearCommand
extends AbstractTopologyAffectedCommand
implements WriteCommand
- Since:
- 4.0
- Author:
- Mircea.Markus@jboss.com
-
Nested Class Summary
Nested classes/interfaces inherited from interface VisitableCommand
VisitableCommand.LoadType -
Field Summary
Fields inherited from class AbstractTopologyAffectedCommand
topologyIdFields inherited from class AbstractFlagAffectedCommand
cacheName, flags, origin, spanAttributesFields inherited from interface VisitableCommand
log -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionacceptVisitor(InvocationContext ctx, Visitor visitor) Accept a visitor, and return the result of accepting this visitor.booleanvoidfail()Make subsequent invocations ofWriteCommand.isSuccessful()returnfalse.Collection<?> inthashCode()booleanCertain commands only work based on a certain condition or state of the cache.booleanIf true, a return value will be provided when performed remotely.booleanIf true, a return value will be marshalled as aSuccessfulResponse, otherwise it will be marshalled as aUnsuccessfulResponse.loadType()voidsetInternalMetadata(Object key, PrivateMetadata internalMetadata) voidsetValueMatcher(ValueMatcher valueMatcher) Returns aNodeVersionrepresenting the Infinispan version in which this command was added.toString()Methods inherited from class AbstractTopologyAffectedCommand
getTopologyId, setTopologyIdMethods inherited from class AbstractFlagAffectedCommand
getCacheName, getFlagsBitSet, getFlagsWithoutRemote, getOrigin, getSpanAttributes, hasSameFlags, printFlags, setFlagsBitSet, setOrigin, setSpanAttributesMethods inherited from interface CacheRpcCommand
getCacheName, getOrigin, setOriginMethods inherited from interface FlagAffectedCommand
addFlags, getFlags, getFlagsBitSet, hasAllFlags, hasAnyFlag, setFlagsBitSetMethods inherited from interface ReplicableCommand
getCommandId, logThrowable, readFrom, writeToMethods inherited from interface TopologyAffectedCommand
getTopologyId, setTopologyIdMethods inherited from interface TracedCommand
getOperationName, getSpanAttributes, setSpanAttributesMethods inherited from interface VisitableCommand
init, invokeAsyncMethods inherited from interface WriteCommand
isWriteOnly, shouldReplicate
-
Constructor Details
-
ClearCommand
-
-
Method Details
-
acceptVisitor
Description copied from interface:VisitableCommandAccept a visitor, and return the result of accepting this visitor.- Specified by:
acceptVisitorin interfaceVisitableCommand- Parameters:
ctx- invocation contextvisitor- visitor to accept- Returns:
- arbitrary return value
- Throws:
Throwable- in the event of problems
-
supportedSince
Description copied from interface:ReplicableCommandReturns aNodeVersionrepresenting 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
ReplicableCommandshould always override this method.- Specified by:
supportedSincein interfaceReplicableCommand- Specified by:
supportedSincein interfaceVersionAware- Returns:
- a
NodeVersioncorresponding to the Infinispan version this command was added.
-
toString
-
isSuccessful
public boolean isSuccessful()Description copied from interface:ReplicableCommandIf true, a return value will be marshalled as aSuccessfulResponse, otherwise it will be marshalled as aUnsuccessfulResponse.- Specified by:
isSuccessfulin interfaceReplicableCommand- Specified by:
isSuccessfulin interfaceWriteCommand- Returns:
- true if the command completed successfully, false otherwise.
-
isConditional
public boolean isConditional()Description copied from interface:WriteCommandCertain commands only work based on a certain condition or state of the cache. For example,ConcurrentMap.putIfAbsent(Object, Object)only does anything if a condition is met, i.e., the entry in question is not already present. This method tests whether the command in question is conditional or not.- Specified by:
isConditionalin interfaceWriteCommand- Returns:
- true if the command is conditional, false otherwise
-
getValueMatcher
- Specified by:
getValueMatcherin interfaceWriteCommand- Returns:
- The current value matching policy.
-
setValueMatcher
- Specified by:
setValueMatcherin interfaceWriteCommand- Parameters:
valueMatcher- The new value matching policy.
-
getAffectedKeys
- Specified by:
getAffectedKeysin interfaceWriteCommand- Returns:
- a collection of keys affected by this write command. Some commands - such as ClearCommand - may return an empty collection for this method.
-
fail
public void fail()Description copied from interface:WriteCommandMake subsequent invocations ofWriteCommand.isSuccessful()returnfalse.- Specified by:
failin interfaceWriteCommand
-
getCommandInvocationId
- Specified by:
getCommandInvocationIdin interfaceWriteCommand- Returns:
- the
CommandInvocationIdassociated to the command.
-
getInternalMetadata
- Specified by:
getInternalMetadatain interfaceWriteCommand
-
setInternalMetadata
- Specified by:
setInternalMetadatain interfaceWriteCommand
-
isReturnValueExpected
public boolean isReturnValueExpected()Description copied from interface:ReplicableCommandIf true, a return value will be provided when performed remotely. Otherwise, a remoteResponseGeneratormay choose to simply return null to save on marshalling costs.- Specified by:
isReturnValueExpectedin interfaceReplicableCommand- Returns:
- true or false
-
loadType
- Specified by:
loadTypein interfaceVisitableCommand- Returns:
- Nodes on which the command needs to read the previous values of the keys it acts on.
-
equals
-
hashCode
-