Enum Class Bucket4jBandwidthLimitProperties.BandwidthRefillStrategies
java.lang.Object
java.lang.Enum<Bucket4jBandwidthLimitProperties.BandwidthRefillStrategies>
org.apereo.cas.configuration.model.support.bucket4j.Bucket4jBandwidthLimitProperties.BandwidthRefillStrategies
- All Implemented Interfaces:
Serializable
,Comparable<Bucket4jBandwidthLimitProperties.BandwidthRefillStrategies>
,Constable
- Enclosing class:
Bucket4jBandwidthLimitProperties
public static enum Bucket4jBandwidthLimitProperties.BandwidthRefillStrategies
extends Enum<Bucket4jBandwidthLimitProperties.BandwidthRefillStrategies>
Describe options available for refill strategy.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantDescriptionThis type of refill regenerates tokens in a greedy manner; it tries to add the tokens to bucket as soon as possible.This type of refill regenerates tokens in intervally manner. -
Method Summary
Modifier and TypeMethodDescriptionReturns the enum constant of this class with the specified name.values()
Returns an array containing the constants of this enum class, in the order they are declared.Methods inherited from class java.lang.Enum
compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
-
Enum Constant Details
-
GREEDY
This type of refill regenerates tokens in a greedy manner; it tries to add the tokens to bucket as soon as possible. For example refill "10 tokens per 1 second" adds 1 token per each 100 millisecond; in other words refill will not wait 1 second to regenerate 10 tokens. -
INTERVALLY
This type of refill regenerates tokens in intervally manner. "Intervally" in opposite to "greedy" will wait until whole period would be elapsed before regenerating tokens.
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException
- if this enum class has no constant with the specified nameNullPointerException
- if the argument is null
-