io.github.bucket4j

Class Refill

java.lang.Object

io.github.bucket4j.Refill

All Implemented Interfaces:

Serializable

public class Refill
extends Object
implements Serializable

Specifies the speed of tokens regeneration.

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
static Refill	smooth(long tokens, Duration period) Creates refill which regenerates the tokens in greedy manner.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

smooth

public static Refill smooth(long tokens,
                            Duration period)

Creates refill which regenerates the tokens in greedy manner. This factory method is called "smooth" because of refill created by this method will add tokens to bucket as soon as possible. For example smooth refill "10 tokens per 1 second" will add 1 token per each 100 millisecond, in other words refill will not wait 1 second to regenerate whole bunch of 10 tokens:

 Refill.smooth(600, Duration.ofMinutes(1));
 Refill.smooth(10, Duration.ofSeconds(1));
 Refill.smooth(1, Duration.ofMillis(100));
 

The three refills above absolutely equals.

Parameters:

tokens -

period -

Returns:

toString

public String toString()

Overrides:

toString in class Object