io.github.bucket4j

Class ConfigurationBuilder

java.lang.Object

io.github.bucket4j.ConfigurationBuilder

public class ConfigurationBuilder
extends Object

The builder for BucketConfiguration

Constructor Summary

Constructors

Constructor and Description
ConfigurationBuilder()

Method Summary

Modifier and Type	Method and Description
ConfigurationBuilder	addLimit(Bandwidth bandwidth) Adds limited bandwidth for all buckets which will be constructed by this builder instance.
ConfigurationBuilder	addLimit(Function<BandwidthBuilder.BandwidthBuilderCapacityStage,BandwidthBuilder.BandwidthBuilderBuildStage> bandwidthConfigurator)
BucketConfiguration	build()
BucketConfiguration	buildConfiguration() Deprecated.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ConfigurationBuilder

public ConfigurationBuilder()

Method Detail

build

public BucketConfiguration build()

Returns:

configuration that used for bucket construction.

buildConfiguration

@Deprecated
public BucketConfiguration buildConfiguration()

Deprecated.

See Also:

build()

addLimit

public ConfigurationBuilder addLimit(Bandwidth bandwidth)

Adds limited bandwidth for all buckets which will be constructed by this builder instance.

Parameters:

bandwidth - limitation

Returns:

this builder instance

addLimit

public ConfigurationBuilder addLimit(Function<BandwidthBuilder.BandwidthBuilderCapacityStage,BandwidthBuilder.BandwidthBuilderBuildStage> bandwidthConfigurator)

toString

public String toString()

Overrides:

toString in class Object