io.github.bucket4j.grid

Class EstimateAbilityToConsumeCommand

java.lang.Object

io.github.bucket4j.grid.EstimateAbilityToConsumeCommand

All Implemented Interfaces:

GridCommand<EstimationProbe>, Serializable

public class EstimateAbilityToConsumeCommand
extends Object
implements GridCommand<EstimationProbe>

See Also:

Serialized Form

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
EstimateAbilityToConsumeCommand(long tokensToEstimate)

Method Summary

Modifier and Type	Method and Description
EstimationProbe	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<EstimateAbilityToConsumeCommand> SERIALIZATION_HANDLE

Constructor Detail

EstimateAbilityToConsumeCommand

public EstimateAbilityToConsumeCommand(long tokensToEstimate)

Method Detail

execute

public EstimationProbe execute(GridBucketState state,
                               long currentTimeNanos)

Specified by:

execute in interface GridCommand<EstimationProbe>

isBucketStateModified

public boolean isBucketStateModified()

Specified by:

isBucketStateModified in interface GridCommand<EstimationProbe>

getTokensToConsume

public long getTokensToConsume()