io.github.bucket4j.grid

Class GridBucketState

java.lang.Object

io.github.bucket4j.grid.GridBucketState

All Implemented Interfaces:

Serializable

public class GridBucketState
extends Object
implements Serializable

See Also:

Serialized Form

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
GridBucketState(BucketConfiguration configuration, BucketState state)

Method Summary

Modifier and Type	Method and Description
void	addTokens(long tokensToAdd)
long	calculateDelayNanosAfterWillBePossibleToConsume(long tokensToConsume, long currentTimeNanos)
void	consume(long tokensToConsume)
BucketState	copyBucketState()
GridBucketState	deepCopy()
void	forceAddTokens(long tokensToAdd)
long	getAvailableTokens()
BucketConfiguration	getConfiguration()
BucketState	getState()
void	refillAllBandwidth(long currentTimeNanos)
void	replaceConfiguration(BucketConfiguration newConfiguration, TokensInheritanceStrategy tokensInheritanceStrategy, long currentTimeNanos)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

SERIALIZATION_HANDLE

public static final SerializationHandle<GridBucketState> SERIALIZATION_HANDLE

Constructor Detail

GridBucketState

public GridBucketState(BucketConfiguration configuration,
                       BucketState state)

Method Detail

deepCopy

public GridBucketState deepCopy()

refillAllBandwidth

public void refillAllBandwidth(long currentTimeNanos)

getAvailableTokens

public long getAvailableTokens()

consume

public void consume(long tokensToConsume)

calculateDelayNanosAfterWillBePossibleToConsume

public long calculateDelayNanosAfterWillBePossibleToConsume(long tokensToConsume,
                                                            long currentTimeNanos)

addTokens

public void addTokens(long tokensToAdd)

forceAddTokens

public void forceAddTokens(long tokensToAdd)

copyBucketState

public BucketState copyBucketState()

replaceConfiguration

public void replaceConfiguration(BucketConfiguration newConfiguration,
                                 TokensInheritanceStrategy tokensInheritanceStrategy,
                                 long currentTimeNanos)

getConfiguration

public BucketConfiguration getConfiguration()

getState

public BucketState getState()

toString

public String toString()

Overrides:

toString in class Object