public class ClearCommand extends AbstractFlagAffectedCommand implements WriteCommand
Modifier and Type | Field and Description |
---|---|
static byte |
COMMAND_ID |
flags
Constructor and Description |
---|
ClearCommand() |
ClearCommand(CacheNotifier notifier,
Set<Flag> flags) |
Modifier and Type | Method and Description |
---|---|
Object |
acceptVisitor(InvocationContext ctx,
Visitor visitor)
Accept a visitor, and return the result of accepting this visitor.
|
Set<Object> |
getAffectedKeys() |
byte |
getCommandId()
Used by marshallers to convert this command into an id for streaming.
|
Object[] |
getParameters()
Used by marshallers to stream this command across a network
|
boolean |
ignoreCommandOnStatus(ComponentStatus status)
Similar to
VisitableCommand.shouldInvoke(InvocationContext) but evaluated by InvocationContextInterceptor . |
void |
init(CacheNotifier notifier) |
boolean |
isConditional()
Certain commands only work based on a certain condition or state of the cache.
|
boolean |
isReturnValueExpected()
If true, a return value will be provided when performed remotely.
|
boolean |
isSuccessful()
Some commands may want to provide information on whether the command was successful or not.
|
Object |
perform(InvocationContext ctx)
Performs the primary function of the command.
|
void |
setParameters(int commandId,
Object[] parameters)
Used by the
CommandsFactory to create a command from raw data read off a stream. |
boolean |
shouldInvoke(InvocationContext ctx)
Used by the InboundInvocationHandler to determine whether the command should be invoked or not.
|
String |
toString() |
getFlags, hasFlag, setFlags
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
getFlags, hasFlag, setFlags
public static final byte COMMAND_ID
public ClearCommand()
public ClearCommand(CacheNotifier notifier, Set<Flag> flags)
public void init(CacheNotifier notifier)
public Object acceptVisitor(InvocationContext ctx, Visitor visitor) throws Throwable
VisitableCommand
acceptVisitor
in interface VisitableCommand
ctx
- invocation contextvisitor
- visitor to acceptThrowable
- in the event of problemspublic Object perform(InvocationContext ctx) throws Throwable
ReplicableCommand
perform
in interface ReplicableCommand
ctx
- invocation contextThrowable
- in the event of problems.public Object[] getParameters()
ReplicableCommand
getParameters
in interface ReplicableCommand
public byte getCommandId()
ReplicableCommand
getCommandId
in interface ReplicableCommand
public void setParameters(int commandId, Object[] parameters)
ReplicableCommand
CommandsFactory
to create a command from raw data read off a stream.setParameters
in interface ReplicableCommand
commandId
- command id to set. This is usually unused but *could* be used in the event of a command having
multiple IDs, such as PutKeyValueCommand
.parameters
- object array of argspublic boolean shouldInvoke(InvocationContext ctx)
VisitableCommand
shouldInvoke
in interface VisitableCommand
public boolean isSuccessful()
WriteCommand
isSuccessful
in interface WriteCommand
public boolean isConditional()
WriteCommand
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.isConditional
in interface WriteCommand
public Set<Object> getAffectedKeys()
getAffectedKeys
in interface WriteCommand
public boolean isReturnValueExpected()
ReplicableCommand
ResponseGenerator
may choose to simply return null to save on marshalling costs.isReturnValueExpected
in interface ReplicableCommand
public boolean ignoreCommandOnStatus(ComponentStatus status)
VisitableCommand
VisitableCommand.shouldInvoke(InvocationContext)
but evaluated by InvocationContextInterceptor
.
Commands can opt to be discarded in case the cache status is not suited (as InvalidateCommand
)ignoreCommandOnStatus
in interface VisitableCommand
Copyright © 2012 JBoss by Red Hat. All Rights Reserved.