io.github.bucket4j

Class Bucket4j

java.lang.Object

io.github.bucket4j.Bucket4j

public class Bucket4j
extends Object

This is entry point for functionality provided bucket4j library. It is always better to initialize the buckets through this class.

Method Summary

Modifier and Type	Method and Description
static LocalBucketBuilder	builder() Creates the new builder of in-memory buckets.
static ConfigurationBuilder	configurationBuilder() Creates new instance of ConfigurationBuilder
static <T extends ConfigurationBuilder<T>,E extends Extension<T>> E	extension(Class<E> extensionClass) Locates Bucket4j extension by class extensionClass.

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static LocalBucketBuilder builder()

Creates the new builder of in-memory buckets.

Returns:

new instance of LocalBucketBuilder

configurationBuilder

public static ConfigurationBuilder configurationBuilder()

Creates new instance of ConfigurationBuilder

Returns:

instance of ConfigurationBuilder

extension

public static <T extends ConfigurationBuilder<T>,E extends Extension<T>> E extension(Class<E> extensionClass)

Locates Bucket4j extension by class extensionClass.

Type Parameters:

T -

E -

Parameters:

extensionClass - must be registered in "/META-INF/services/io.github.bucket4j.Extension" according to java SPI rules.

Returns:

library extension