Module io.github.bucket4j.core

Package io.github.bucket4j

Class BucketState64BitsInteger

java.lang.Object

io.github.bucket4j.BucketState64BitsInteger

All Implemented Interfaces:

BucketState, ComparableByContent<BucketState64BitsInteger>

public class BucketState64BitsInteger
extends Object
implements BucketState, ComparableByContent<BucketState64BitsInteger>

Field Summary

Fields

Modifier and Type	Field	Description
static SerializationHandle<BucketState64BitsInteger>	SERIALIZATION_HANDLE

Constructor Summary

Constructors

Constructor	Description
BucketState64BitsInteger(BucketConfiguration configuration, long currentTimeNanos)

Method Summary

Modifier and Type	Method	Description
void	addTokens(long tokensToAdd)
long	calculateDelayNanosAfterWillBePossibleToConsume(long tokensToConsume, long currentTimeNanos, boolean checkTokensToConsumeShouldBeLessThenCapacity)
long	calculateFullRefillingTime(long currentTimeNanos)
void	consume(long toConsume)
BucketState	copy()
void	copyStateFrom(BucketState sourceState)
boolean	equalsByContent(BucketState64BitsInteger other)
void	forceAddTokens(long tokensToAdd)
long	getAvailableTokens()
BucketConfiguration	getConfiguration()
long	getCurrentSize(int bandwidth)
MathType	getMathType()
long	getRoundingError(int bandwidth)
void	refillAllBandwidth(long currentTimeNanos)
BucketState	replaceConfiguration(BucketConfiguration newConfiguration, TokensInheritanceStrategy tokensInheritanceStrategy, long currentTimeNanos)
void	reset()
void	setConfiguration(BucketConfiguration configuration)
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 SerializationHandle<BucketState64BitsInteger> SERIALIZATION_HANDLE

Constructor Detail

BucketState64BitsInteger

public BucketState64BitsInteger(BucketConfiguration configuration,
                                long currentTimeNanos)

Method Detail

copy

public BucketState copy()

Specified by:

copy in interface BucketState

getConfiguration

public BucketConfiguration getConfiguration()

Specified by:

getConfiguration in interface BucketState

setConfiguration

public void setConfiguration(BucketConfiguration configuration)

Specified by:

setConfiguration in interface BucketState

replaceConfiguration

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

Specified by:

replaceConfiguration in interface BucketState

copyStateFrom

public void copyStateFrom(BucketState sourceState)

Specified by:

copyStateFrom in interface BucketState

getAvailableTokens

public long getAvailableTokens()

Specified by:

getAvailableTokens in interface BucketState

consume

public void consume(long toConsume)

Specified by:

consume in interface BucketState

calculateDelayNanosAfterWillBePossibleToConsume

public long calculateDelayNanosAfterWillBePossibleToConsume(long tokensToConsume,
                                                            long currentTimeNanos,
                                                            boolean checkTokensToConsumeShouldBeLessThenCapacity)

Specified by:

calculateDelayNanosAfterWillBePossibleToConsume in interface BucketState

refillAllBandwidth

public void refillAllBandwidth(long currentTimeNanos)

Specified by:

refillAllBandwidth in interface BucketState

addTokens

public void addTokens(long tokensToAdd)

Specified by:

addTokens in interface BucketState

reset

public void reset()

Specified by:

reset in interface BucketState

forceAddTokens

public void forceAddTokens(long tokensToAdd)

Specified by:

forceAddTokens in interface BucketState

calculateFullRefillingTime

public long calculateFullRefillingTime(long currentTimeNanos)

Specified by:

calculateFullRefillingTime in interface BucketState

getCurrentSize

public long getCurrentSize(int bandwidth)

Specified by:

getCurrentSize in interface BucketState

getRoundingError

public long getRoundingError(int bandwidth)

Specified by:

getRoundingError in interface BucketState

getMathType

public MathType getMathType()

Specified by:

getMathType in interface BucketState

toString

public String toString()

Overrides:

toString in class Object

equalsByContent

public boolean equalsByContent(BucketState64BitsInteger other)

Specified by:

equalsByContent in interface ComparableByContent<BucketState64BitsInteger>