Module io.github.bucket4j.core

Package io.github.bucket4j

Interface BandwidthBuilder.BandwidthBuilderBuildStage

Enclosing class:

BandwidthBuilder

public static interface BandwidthBuilder.BandwidthBuilderBuildStage

The final build stage with ability to configure optional parameters of bandwidth, like id or initial tokens

Method Summary

Modifier and Type	Method	Description
Bandwidth	build()	Creates the new instance of Bandwidth
BandwidthBuilder.BandwidthBuilderBuildStage	id(String id)	By default, new created bandwidth has no ID.
BandwidthBuilder.BandwidthBuilderBuildStage	initialTokens(long initialTokens)	By default, new created Bandwidth has amount tokens that equals its capacity.

Method Details

build

Bandwidth build()

Creates the new instance of Bandwidth

Returns:

new instance of Bandwidth

id

BandwidthBuilder.BandwidthBuilderBuildStage id(String id)

By default, new created bandwidth has no ID. This method allows to specify unique identifier of bandwidth that can be used for bandwidth comparison during configuration replacement Bucket.replaceConfiguration(BucketConfiguration, TokensInheritanceStrategy)

Parameters:

id - unique identifier of bandwidth that can be used for bandwidth comparison during configuration replacement Bucket.replaceConfiguration(BucketConfiguration, TokensInheritanceStrategy)

Returns:

the copy of this bandwidth with new value of initial tokens.

initialTokens

BandwidthBuilder.BandwidthBuilderBuildStage initialTokens(long initialTokens)

By default, new created Bandwidth has amount tokens that equals its capacity. This method allows to replace initial tokens.

Parameters:

initialTokens -

Returns:

the copy of this bandwidth with new value of initial tokens.