Module io.github.bucket4j.core
Package io.github.bucket4j
Interface BandwidthBuilder.BandwidthBuilderBuildStage
-
- Enclosing class:
- BandwidthBuilder
public static interface BandwidthBuilder.BandwidthBuilderBuildStageThe final build stage with ability to configure optional parameters of bandwidth, like id or initial tokens
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Bandwidthbuild()Creates the new instance ofBandwidthBandwidthBuilder.BandwidthBuilderBuildStageid(String id)By default, new created bandwidth has no ID.BandwidthBuilder.BandwidthBuilderBuildStageinitialTokens(long initialTokens)By default, new createdBandwidthhas amount tokens that equals its capacity.
-
-
-
Method Detail
-
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 comparision during configuration replacementBucket.replaceConfiguration(BucketConfiguration, TokensInheritanceStrategy)- Parameters:
id- unique identifier of bandwidth that can be used for bandwidth comparision during configuration replacementBucket.replaceConfiguration(BucketConfiguration, TokensInheritanceStrategy)- Returns:
- the copy of this bandwidth with new value ofof initial tokens.
-
initialTokens
BandwidthBuilder.BandwidthBuilderBuildStage initialTokens(long initialTokens)
By default, new createdBandwidthhas amount tokens that equals its capacity. This method allows to replace initial tokens.- Parameters:
initialTokens-- Returns:
- the copy of this bandwidth with new value ofof initial tokens.
-
-