io.github.bucket4j.local

Class LocalBucketBuilder

java.lang.Object

io.github.bucket4j.ConfigurationBuilder<LocalBucketBuilder>

io.github.bucket4j.local.LocalBucketBuilder

public class LocalBucketBuilder
extends ConfigurationBuilder<LocalBucketBuilder>

This builder creates in-memory buckets (LockFreeBucket).

Constructor Summary

Constructors

Constructor and Description
LocalBucketBuilder()

Method Summary

Modifier and Type	Method and Description
Bucket	build() Constructs the bucket using SynchronizationStrategy.LOCK_FREE synchronization strategy.
Bucket	build(SynchronizationStrategy synchronizationStrategy) Constructs the new instance of local bucket which concrete type depends on synchronizationStrategy

Methods inherited from class io.github.bucket4j.ConfigurationBuilder

addLimit, addLimit, buildConfiguration, toString, withCustomTimePrecision, withMillisecondPrecision, withNanosecondPrecision

Methods inherited from class java.lang.Object

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

Constructor Detail

LocalBucketBuilder

public LocalBucketBuilder()

Method Detail

build

public Bucket build()

Constructs the bucket using SynchronizationStrategy.LOCK_FREE synchronization strategy.

Returns:

the new bucket

build

public Bucket build(SynchronizationStrategy synchronizationStrategy)

Constructs the new instance of local bucket which concrete type depends on synchronizationStrategy

Parameters:

synchronizationStrategy - the strategy of synchronization which need to be applied to prevent data-races in multithreading usage scenario.

Returns:

the new bucket