io.apiman.gateway.engine.rates

Enum RateBucketPeriod

java.lang.Object

java.lang.Enum<RateBucketPeriod>

io.apiman.gateway.engine.rates.RateBucketPeriod

All Implemented Interfaces:

Serializable, Comparable<RateBucketPeriod>

public enum RateBucketPeriod
extends Enum<RateBucketPeriod>

The type of bucket to use when enforcing rate limits.

Author:

eric.wittmann@redhat.com

Enum Constant Summary

Enum Constants

Enum Constant and Description
Day
Hour
Minute
Month
Second
Year

Method Summary

Methods

Modifier and Type	Method and Description
static RateBucketPeriod	valueOf(String name) Returns the enum constant of this type with the specified name.
static RateBucketPeriod[]	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

Second

public static final RateBucketPeriod Second

Minute

public static final RateBucketPeriod Minute

Hour

public static final RateBucketPeriod Hour

Day

public static final RateBucketPeriod Day

Month

public static final RateBucketPeriod Month

Year

public static final RateBucketPeriod Year

Method Detail

values

public static RateBucketPeriod[] 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 (RateBucketPeriod c : RateBucketPeriod.values())
    System.out.println(c);

Returns:

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

valueOf

public static RateBucketPeriod 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