Module io.github.bucket4j.core

Package io.github.bucket4j

Interface BucketState

All Known Implementing Classes:

BucketState64BitsInteger, BucketStateIEEE754

public interface BucketState

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)
static BucketState	createInitialState(BucketConfiguration configuration, MathType mathType, long currentTimeNanos)
static <S> BucketState	deserialize(DeserializationAdapter<S> adapter, S input, Version backwardCompatibilityVersion)
void	forceAddTokens(long tokensToAdd)
static BucketState	fromJsonCompatibleSnapshot(Map<String,Object> snapshot, Version backwardCompatibilityVersion)
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()
static <O> void	serialize(SerializationAdapter<O> adapter, O output, BucketState state, Version backwardCompatibilityVersion)
void	setConfiguration(BucketConfiguration configuration)
static Object	toJsonCompatibleSnapshot(BucketState state, Version backwardCompatibilityVersion)

Method Detail

copy

BucketState copy()

getConfiguration

BucketConfiguration getConfiguration()

setConfiguration

void setConfiguration(BucketConfiguration configuration)

replaceConfiguration

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

copyStateFrom

void copyStateFrom(BucketState sourceState)

getAvailableTokens

long getAvailableTokens()

consume

void consume(long toConsume)

calculateDelayNanosAfterWillBePossibleToConsume

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

calculateFullRefillingTime

long calculateFullRefillingTime(long currentTimeNanos)

refillAllBandwidth

void refillAllBandwidth(long currentTimeNanos)

addTokens

void addTokens(long tokensToAdd)

reset

void reset()

forceAddTokens

void forceAddTokens(long tokensToAdd)

getCurrentSize

long getCurrentSize(int bandwidth)

getRoundingError

long getRoundingError(int bandwidth)

getMathType

MathType getMathType()

createInitialState

static BucketState createInitialState(BucketConfiguration configuration,
                                      MathType mathType,
                                      long currentTimeNanos)

deserialize

static <S> BucketState deserialize(DeserializationAdapter<S> adapter,
                                   S input,
                                   Version backwardCompatibilityVersion)
                            throws IOException

Throws:

IOException

serialize

static <O> void serialize(SerializationAdapter<O> adapter,
                          O output,
                          BucketState state,
                          Version backwardCompatibilityVersion)
                   throws IOException

Throws:

IOException

fromJsonCompatibleSnapshot

static BucketState fromJsonCompatibleSnapshot(Map<String,Object> snapshot,
                                              Version backwardCompatibilityVersion)
                                       throws IOException

Throws:

IOException

toJsonCompatibleSnapshot

static Object toJsonCompatibleSnapshot(BucketState state,
                                       Version backwardCompatibilityVersion)
                                throws IOException

Throws:

IOException