Package 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:
java.io.Serializable, java.lang.Comparable<FilterKeyType>, java.lang.constant.Constable
@Deprecated
public enum FilterKeyType
extends java.lang.Enum<FilterKeyType>
Deprecated.
Predefined filter type to identify the Bucket4j key which is used to define to whom the rate limit should be applied.

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    java.lang.Enum.EnumDesc<E extends java.lang.Enum<E>>

  • Enum Constant Summary

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

  • Method Summary

    Modifier and Type Method Description
    static FilterKeyType valueOf​(java.lang.String name)
    Deprecated.
    Returns the enum constant of this type with the specified name.
    static FilterKeyType[] values()
    Deprecated.
    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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • DEFAULT

      public static final FilterKeyType DEFAULT
      Deprecated.
      No special filter is applied. All incoming uses the same rate limit key.

    • IP

      public static final FilterKeyType IP
      Deprecated.
      IP based filtering. The rate limit is based on each IP address.

    • EXPRESSION

      public static final FilterKeyType EXPRESSION
      Deprecated.
      The expression type is used to define an individual expression based on the Spring Expression Language.

  • Method Details

    • values

      public static FilterKeyType[] values()
      Deprecated.
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static FilterKeyType valueOf​(java.lang.String name)
      Deprecated.
      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:
      java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
      java.lang.NullPointerException - if the argument is null