io.github.bucket4j.grid

Class TryConsumeAndReturnRemainingTokensCommand

java.lang.Object

io.github.bucket4j.grid.TryConsumeAndReturnRemainingTokensCommand

All Implemented Interfaces:

GridCommand<ConsumptionProbe>, Serializable

public class TryConsumeAndReturnRemainingTokensCommand
extends Object
implements GridCommand<ConsumptionProbe>

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static SerializationHandle<TryConsumeAndReturnRemainingTokensCommand>	SERIALIZATION_HANDLE

Constructor Summary

Constructors

Constructor and Description
TryConsumeAndReturnRemainingTokensCommand(long tokensToConsume)

Method Summary

Modifier and Type	Method and Description
ConsumptionProbe	execute(GridBucketState state, long currentTimeNanos)
long	getTokensToConsume()
boolean	isBucketStateModified()

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.grid.GridCommand

asVerbose

Field Detail

SERIALIZATION_HANDLE

public static final SerializationHandle<TryConsumeAndReturnRemainingTokensCommand> SERIALIZATION_HANDLE

Constructor Detail

TryConsumeAndReturnRemainingTokensCommand

public TryConsumeAndReturnRemainingTokensCommand(long tokensToConsume)

Method Detail

execute

public ConsumptionProbe execute(GridBucketState state,
                                long currentTimeNanos)

Specified by:

execute in interface GridCommand<ConsumptionProbe>

isBucketStateModified

public boolean isBucketStateModified()

Specified by:

isBucketStateModified in interface GridCommand<ConsumptionProbe>

getTokensToConsume

public long getTokensToConsume()