io.github.bucket4j

Class Bandwidth

java.lang.Object

io.github.bucket4j.Bandwidth

All Implemented Interfaces:

ComparableByContent<Bandwidth>

public class Bandwidth
extends Object
implements ComparableByContent<Bandwidth>

Field Summary

Fields

Modifier and Type	Field and Description
static SerializationHandle<Bandwidth>	SERIALIZATION_HANDLE
static String	UNDEFINED_ID
static long	UNSPECIFIED_TIME_OF_FIRST_REFILL

Method Summary

Modifier and Type	Method and Description
static BandwidthBuilder.BandwidthBuilderCapacityStage	builder() Creates a builder for Bandwidth
static Bandwidth	classic(long capacity, Refill refill) Deprecated.
boolean	equals(Object o)
boolean	equalsByContent(Bandwidth other)
long	getCapacity()
String	getId()
long	getInitialTokens()
long	getRefillPeriodNanos()
long	getRefillTokens()
long	getTimeOfFirstRefillMillis()
int	hashCode()
boolean	hasId()
boolean	isGready()
boolean	isIntervallyAligned()
boolean	isRefillIntervally()
boolean	isUseAdaptiveInitialTokens()
static Bandwidth	simple(long capacity, Duration period) Deprecated.
String	toString()
Bandwidth	withId(String id) Deprecated.
Bandwidth	withInitialTokens(long initialTokens) Deprecated.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.github.bucket4j.util.ComparableByContent

equals

Field Detail

UNDEFINED_ID

public static final String UNDEFINED_ID

UNSPECIFIED_TIME_OF_FIRST_REFILL

public static final long UNSPECIFIED_TIME_OF_FIRST_REFILL

See Also:

Constant Field Values

SERIALIZATION_HANDLE

public static final SerializationHandle<Bandwidth> SERIALIZATION_HANDLE

Method Detail

builder

public static BandwidthBuilder.BandwidthBuilderCapacityStage builder()

Creates a builder for Bandwidth

Returns:

a builder for Bandwidth

simple

@Deprecated
public static Bandwidth simple(long capacity,
                                           Duration period)

Deprecated.

This method is deprecated, you should use builder()

classic

@Deprecated
public static Bandwidth classic(long capacity,
                                            Refill refill)

Deprecated.

This method is deprecated, you should use builder()

withInitialTokens

@Deprecated
public Bandwidth withInitialTokens(long initialTokens)

Deprecated.

This method is deprecated, you should use BandwidthBuilder.BandwidthBuilderBuildStage.initialTokens(long) )}

withId

@Deprecated
public Bandwidth withId(String id)

Deprecated.

This method is deprecated, you should use BandwidthBuilder.BandwidthBuilderBuildStage.id(String)

isIntervallyAligned

public boolean isIntervallyAligned()

getTimeOfFirstRefillMillis

public long getTimeOfFirstRefillMillis()

getCapacity

public long getCapacity()

getInitialTokens

public long getInitialTokens()

getRefillPeriodNanos

public long getRefillPeriodNanos()

getRefillTokens

public long getRefillTokens()

isUseAdaptiveInitialTokens

public boolean isUseAdaptiveInitialTokens()

isRefillIntervally

public boolean isRefillIntervally()

isGready

public boolean isGready()

getId

public String getId()

hasId

public boolean hasId()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

equalsByContent

public boolean equalsByContent(Bandwidth other)

Specified by:

equalsByContent in interface ComparableByContent<Bandwidth>