com.giffing.bucket4j.spring.boot.starter.context

Enum FilterKeyType

java.lang.Object

java.lang.Enum<FilterKeyType>

com.giffing.bucket4j.spring.boot.starter.context.FilterKeyType

All Implemented Interfaces:

Serializable, Comparable<FilterKeyType>

public enum FilterKeyType
extends Enum<FilterKeyType>

Predefined filter type to identify the Bucket4j key which is used to define to whom the rate limit should be applied.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DEFAULT No special filter is applied.
EXPRESSION The expression type is used to define an individual expression based on the Spring Expression Language.
IP IP based filtering.

Method Summary

Modifier and Type	Method and Description
static FilterKeyType	valueOf(String name) Returns the enum constant of this type with the specified name.
static FilterKeyType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DEFAULT

public static final FilterKeyType DEFAULT

No special filter is applied. All incoming uses the same rate limit key.

IP

public static final FilterKeyType IP

IP based filtering. The rate limit is based on each IP address.

EXPRESSION

public static final FilterKeyType EXPRESSION

The expression type is used to define an individual expression based on the Spring Expression Language.

Method Detail

values

public static FilterKeyType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (FilterKeyType c : FilterKeyType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static FilterKeyType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null