io.apiman.gateway.engine.policies.config.rates

Enum RateLimitingPeriod

java.lang.Object

java.lang.Enum<RateLimitingPeriod>

io.apiman.gateway.engine.policies.config.rates.RateLimitingPeriod

All Implemented Interfaces:

Serializable, Comparable<RateLimitingPeriod>

public enum RateLimitingPeriod
extends Enum<RateLimitingPeriod>

The period over which rates will be limited.

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 RateLimitingPeriod	valueOf(String name) Returns the enum constant of this type with the specified name.
static RateLimitingPeriod[]	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 RateLimitingPeriod Second

Minute

public static final RateLimitingPeriod Minute

Hour

public static final RateLimitingPeriod Hour

Day

public static final RateLimitingPeriod Day

Month

public static final RateLimitingPeriod Month

Year

public static final RateLimitingPeriod Year

Method Detail

values

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

Returns:

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

valueOf

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