io.github.bucket4j

Class ConfigurationBuilder<T extends ConfigurationBuilder>

java.lang.Object

io.github.bucket4j.ConfigurationBuilder<T>

Direct Known Subclasses:

LocalBucketBuilder

public class ConfigurationBuilder<T extends ConfigurationBuilder>
extends Object

A builder for buckets. Builder can be reused, i.e. one builder can create multiple buckets with similar configuration.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ConfigurationBuilder()

Method Summary

Modifier and Type	Method and Description
T	addLimit(Bandwidth bandwidth) Adds limited bandwidth for all buckets which will be constructed by this builder instance.
T	addLimit(long initialTokens, Bandwidth bandwidth) Adds limited bandwidth for all buckets which will be constructed by this builder instance.
BucketConfiguration	buildConfiguration()
String	toString()
T	withCustomTimePrecision(TimeMeter customTimeMeter) Creates instance of ConfigurationBuilder which will create buckets with customTimeMeter as time meter.
T	withMillisecondPrecision() Creates instance of ConfigurationBuilder which will create buckets with TimeMeter.SYSTEM_MILLISECONDS as time meter.
T	withNanosecondPrecision() Creates instance of ConfigurationBuilder which will create buckets with TimeMeter.SYSTEM_NANOTIME as time meter.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigurationBuilder

protected ConfigurationBuilder()

Method Detail

buildConfiguration

public BucketConfiguration buildConfiguration()

Returns:

configuration which used for bucket construction.

addLimit

public T 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 T addLimit(long initialTokens,
                  Bandwidth bandwidth)

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

Parameters:

bandwidth - limitation

initialTokens - the count of initial tokens

Returns:

this builder instance

withNanosecondPrecision

public T withNanosecondPrecision()

Creates instance of ConfigurationBuilder which will create buckets with TimeMeter.SYSTEM_NANOTIME as time meter.

Returns:

this builder instance

withMillisecondPrecision

public T withMillisecondPrecision()

Creates instance of ConfigurationBuilder which will create buckets with TimeMeter.SYSTEM_MILLISECONDS as time meter.

Returns:

this builder instance

withCustomTimePrecision

public T withCustomTimePrecision(TimeMeter customTimeMeter)

Creates instance of ConfigurationBuilder which will create buckets with customTimeMeter as time meter.

Parameters:

customTimeMeter - object which will measure time.

Returns:

this builder instance

toString

public String toString()

Overrides:

toString in class Object