io.github.bucket4j.distributed.remote.commands

Class VerboseCommand<T>

java.lang.Object

io.github.bucket4j.distributed.remote.commands.VerboseCommand<T>

All Implemented Interfaces:

RemoteCommand<RemoteVerboseResult<T>>, ComparableByContent<VerboseCommand<?>>

public class VerboseCommand<T>
extends Object
implements RemoteCommand<RemoteVerboseResult<T>>, ComparableByContent<VerboseCommand<?>>

Field Summary

Fields

Modifier and Type	Field and Description
static SerializationHandle<VerboseCommand<?>>	SERIALIZATION_HANDLE
static VerboseCommand<Boolean>	TRY_CONSUME_ONE_VERBOSE

Method Summary

Modifier and Type	Method and Description
boolean	canBeMerged(RemoteCommand<?> another)
boolean	equalsByContent(VerboseCommand<?> other)
long	estimateTokensToConsume()
CommandResult<RemoteVerboseResult<T>>	execute(MutableBucketEntry mutableEntry, long currentTimeNanos)
static <T> VerboseCommand<T>	from(RemoteCommand<T> targetCommand)
long	getConsumedTokens(RemoteVerboseResult<T> result)
int	getMergedCommandsCount()
Version	getRequiredVersion()
SerializationHandle<RemoteCommand<?>>	getSerializationHandle()
RemoteCommand<T>	getTargetCommand()
boolean	isImmediateSyncRequired(long unsynchronizedTokens, long nanosSinceLastSync)
boolean	isMerged()
void	mergeInto(RemoteCommand<?> mergedCommand)
RemoteCommand<?>	toMergedCommand()
CommandResult<?>	unwrapOneResult(RemoteVerboseResult<T> mergedVerboseResult, int indice)

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.github.bucket4j.distributed.remote.RemoteCommand

asVerbose, deserialize, fromJsonCompatibleSnapshot, isInitializationCommand, serialize, toJsonCompatibleSnapshot

Methods inherited from interface io.github.bucket4j.util.ComparableByContent

equals

Field Detail

TRY_CONSUME_ONE_VERBOSE

public static final VerboseCommand<Boolean> TRY_CONSUME_ONE_VERBOSE

SERIALIZATION_HANDLE

public static final SerializationHandle<VerboseCommand<?>> SERIALIZATION_HANDLE

Method Detail

from

public static <T> VerboseCommand<T> from(RemoteCommand<T> targetCommand)

getTargetCommand

public RemoteCommand<T> getTargetCommand()

canBeMerged

public boolean canBeMerged(RemoteCommand<?> another)

Specified by:

canBeMerged in interface RemoteCommand<RemoteVerboseResult<T>>

toMergedCommand

public RemoteCommand<?> toMergedCommand()

Specified by:

toMergedCommand in interface RemoteCommand<RemoteVerboseResult<T>>

mergeInto

public void mergeInto(RemoteCommand<?> mergedCommand)

Specified by:

mergeInto in interface RemoteCommand<RemoteVerboseResult<T>>

getMergedCommandsCount

public int getMergedCommandsCount()

Specified by:

getMergedCommandsCount in interface RemoteCommand<RemoteVerboseResult<T>>

unwrapOneResult

public CommandResult<?> unwrapOneResult(RemoteVerboseResult<T> mergedVerboseResult,
                                        int indice)

Specified by:

unwrapOneResult in interface RemoteCommand<RemoteVerboseResult<T>>

isMerged

public boolean isMerged()

Specified by:

isMerged in interface RemoteCommand<RemoteVerboseResult<T>>

execute

public CommandResult<RemoteVerboseResult<T>> execute(MutableBucketEntry mutableEntry,
                                                     long currentTimeNanos)

Specified by:

execute in interface RemoteCommand<RemoteVerboseResult<T>>

getSerializationHandle

public SerializationHandle<RemoteCommand<?>> getSerializationHandle()

Specified by:

getSerializationHandle in interface RemoteCommand<RemoteVerboseResult<T>>

equalsByContent

public boolean equalsByContent(VerboseCommand<?> other)

Specified by:

equalsByContent in interface ComparableByContent<VerboseCommand<?>>

isImmediateSyncRequired

public boolean isImmediateSyncRequired(long unsynchronizedTokens,
                                       long nanosSinceLastSync)

Specified by:

isImmediateSyncRequired in interface RemoteCommand<RemoteVerboseResult<T>>

estimateTokensToConsume

public long estimateTokensToConsume()

Specified by:

estimateTokensToConsume in interface RemoteCommand<RemoteVerboseResult<T>>

getConsumedTokens

public long getConsumedTokens(RemoteVerboseResult<T> result)

Specified by:

getConsumedTokens in interface RemoteCommand<RemoteVerboseResult<T>>

getRequiredVersion

public Version getRequiredVersion()

Specified by:

getRequiredVersion in interface RemoteCommand<RemoteVerboseResult<T>>