io.github.bucket4j.local

Class LocalBucketBuilder

java.lang.Object

io.github.bucket4j.AbstractBucketBuilder<LocalBucketBuilder>

io.github.bucket4j.local.LocalBucketBuilder

public class LocalBucketBuilder
extends AbstractBucketBuilder<LocalBucketBuilder>

This builder creates in-memory buckets (LockFreeBucket).

Constructor Summary

Constructors

Constructor and Description
LocalBucketBuilder()

Method Summary

Modifier and Type	Method and Description
LocalBucket	build() Constructs the bucket using SynchronizationStrategy.LOCK_FREE synchronization strategy.
LocalBucketBuilder	withCustomTimePrecision(TimeMeter customTimeMeter) Specifies customTimeMeter time meter for buckets that will be created by this builder.
LocalBucketBuilder	withMillisecondPrecision() Specifies TimeMeter.SYSTEM_MILLISECONDS as time meter for buckets that will be created by this builder.
LocalBucketBuilder	withNanosecondPrecision() Specifies TimeMeter.SYSTEM_NANOTIME as time meter for buckets that will be created by this builder.
LocalBucketBuilder	withSynchronizationStrategy(SynchronizationStrategy synchronizationStrategy) Specifies synchronizationStrategy for buckets that will be created by this builder.

Methods inherited from class io.github.bucket4j.AbstractBucketBuilder

addLimit, buildConfiguration

Methods inherited from class java.lang.Object

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

Constructor Detail

LocalBucketBuilder

public LocalBucketBuilder()

Method Detail

withNanosecondPrecision

public LocalBucketBuilder withNanosecondPrecision()

Specifies TimeMeter.SYSTEM_NANOTIME as time meter for buckets that will be created by this builder.

Returns:

this builder instance

withMillisecondPrecision

public LocalBucketBuilder withMillisecondPrecision()

Specifies TimeMeter.SYSTEM_MILLISECONDS as time meter for buckets that will be created by this builder.

Returns:

this builder instance

withCustomTimePrecision

public LocalBucketBuilder withCustomTimePrecision(TimeMeter customTimeMeter)

Specifies customTimeMeter time meter for buckets that will be created by this builder.

Parameters:

customTimeMeter - object which will measure time.

Returns:

this builder instance

withSynchronizationStrategy

public LocalBucketBuilder withSynchronizationStrategy(SynchronizationStrategy synchronizationStrategy)

Specifies synchronizationStrategy for buckets that will be created by this builder.

Parameters:

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

Returns:

this builder instance

build

public LocalBucket build()

Constructs the bucket using SynchronizationStrategy.LOCK_FREE synchronization strategy.

Returns:

the new bucket