org.isomorphism.util

Interface TokenBucket.RefillStrategy

All Known Implementing Classes:

FixedIntervalRefillStrategy

Enclosing interface:

TokenBucket

public static interface TokenBucket.RefillStrategy

Encapsulation of a refilling strategy for a token bucket.

Method Summary

Modifier and Type	Method and Description
long	getDurationUntilNextRefill(TimeUnit unit) Returns the amount of time in the specified time unit until the next group of tokens can be added to the token bucket.
long	refill() Returns the number of tokens to add to the token bucket.

Method Detail

refill

long refill()

Returns the number of tokens to add to the token bucket.

Returns:

The number of tokens to add to the token bucket.

getDurationUntilNextRefill

long getDurationUntilNextRefill(TimeUnit unit)
                         throws UnsupportedOperationException

Returns the amount of time in the specified time unit until the next group of tokens can be added to the token bucket. Please note, depending on the SleepStrategy used by the token bucket, tokens may not actually be added until much after the returned duration. If for some reason the implementation of RefillStrategy doesn't support knowing when the next batch of tokens will be added, then an UnsupportedOperationException may be thrown. Lastly, if the duration until the next time tokens will be added to the token bucket is less than a single unit of the passed in time unit then this method will return 0.

Parameters:

unit - The time unit to express the return value in.

Returns:

The amount of time until the next group of tokens can be added to the token bucket.

Throws:

UnsupportedOperationException