Module io.github.bucket4j.core

Package io.github.bucket4j

Interface VerboseBucket

public interface VerboseBucket

Intent of this interface is to provide the verbose version of Bucket API. All methods obey the same semantic but its results are more verbose.

Method Summary

Modifier and Type	Method	Description
VerboseResult<Nothing>	addTokens(long tokensToAdd)	Does the same that Bucket.addTokens(long)
VerboseResult<Long>	consumeIgnoringRateLimits(long tokens)	Does the same that Bucket.consumeIgnoringRateLimits(long)
VerboseResult<EstimationProbe>	estimateAbilityToConsume(long numTokens)	Does the same that Bucket.estimateAbilityToConsume(long)
VerboseResult<Nothing>	forceAddTokens(long tokensToAdd)	Does the same that Bucket.forceAddTokens(long)
VerboseResult<Long>	getAvailableTokens()	Does the same that Bucket.getAvailableTokens()
VerboseResult<Nothing>	replaceConfiguration(BucketConfiguration newConfiguration, TokensInheritanceStrategy tokensInheritanceStrategy)	Does the same that Bucket.replaceConfiguration(BucketConfiguration, TokensInheritanceStrategy)
VerboseResult<Nothing>	reset()	Does the same that Bucket.reset()
VerboseResult<Boolean>	tryConsume(long numTokens)	Does the same that Bucket.tryConsume(long)
VerboseResult<ConsumptionProbe>	tryConsumeAndReturnRemaining(long numTokens)	Does the same that Bucket.tryConsumeAndReturnRemaining(long)
VerboseResult<Long>	tryConsumeAsMuchAsPossible()	Does the same that Bucket.tryConsumeAsMuchAsPossible()
VerboseResult<Long>	tryConsumeAsMuchAsPossible(long limit)	Does the same that Bucket.tryConsumeAsMuchAsPossible(long)

Method Detail

tryConsume

VerboseResult<Boolean> tryConsume(long numTokens)

Does the same that Bucket.tryConsume(long)

consumeIgnoringRateLimits

VerboseResult<Long> consumeIgnoringRateLimits(long tokens)

Does the same that Bucket.consumeIgnoringRateLimits(long)

tryConsumeAndReturnRemaining

VerboseResult<ConsumptionProbe> tryConsumeAndReturnRemaining(long numTokens)

Does the same that Bucket.tryConsumeAndReturnRemaining(long)

estimateAbilityToConsume

VerboseResult<EstimationProbe> estimateAbilityToConsume(long numTokens)

Does the same that Bucket.estimateAbilityToConsume(long)

tryConsumeAsMuchAsPossible

VerboseResult<Long> tryConsumeAsMuchAsPossible()

Does the same that Bucket.tryConsumeAsMuchAsPossible()

tryConsumeAsMuchAsPossible

VerboseResult<Long> tryConsumeAsMuchAsPossible(long limit)

Does the same that Bucket.tryConsumeAsMuchAsPossible(long)

getAvailableTokens

VerboseResult<Long> getAvailableTokens()

Does the same that Bucket.getAvailableTokens()

addTokens

VerboseResult<Nothing> addTokens(long tokensToAdd)

Does the same that Bucket.addTokens(long)

reset

VerboseResult<Nothing> reset()

Does the same that Bucket.reset()

forceAddTokens

VerboseResult<Nothing> forceAddTokens(long tokensToAdd)

Does the same that Bucket.forceAddTokens(long)

replaceConfiguration

VerboseResult<Nothing> replaceConfiguration(BucketConfiguration newConfiguration,
                                            TokensInheritanceStrategy tokensInheritanceStrategy)

Does the same that Bucket.replaceConfiguration(BucketConfiguration, TokensInheritanceStrategy)