org.apache.gobblin.util.limiter

Enum BaseLimiterType

java.lang.Object

java.lang.Enum<BaseLimiterType>

org.apache.gobblin.util.limiter.BaseLimiterType

All Implemented Interfaces:

Serializable, Comparable<BaseLimiterType>

public enum BaseLimiterType
extends Enum<BaseLimiterType>

An enumeration of types of Limiters supported out-of-the-box.

Enum Constant Summary

Enum Constants

Enum Constant and Description
COUNT_BASED For CountBasedLimiter.
POOL_BASED For PoolBasedLimiter.
RATE_BASED For RateBasedLimiter.
TIME_BASED For TimeBasedLimiter.

Method Summary

Modifier and Type	Method and Description
static BaseLimiterType	forName(String name) Get a BaseLimiterType for the given name.
String	toString()
static BaseLimiterType	valueOf(String name) Returns the enum constant of this type with the specified name.
static BaseLimiterType[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

RATE_BASED

public static final BaseLimiterType RATE_BASED

For RateBasedLimiter.

TIME_BASED

public static final BaseLimiterType TIME_BASED

For TimeBasedLimiter.

COUNT_BASED

public static final BaseLimiterType COUNT_BASED

For CountBasedLimiter.

POOL_BASED

public static final BaseLimiterType POOL_BASED

For PoolBasedLimiter.

Method Detail

values

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

Returns:

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

valueOf

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

toString

public String toString()

Overrides:

toString in class Enum<BaseLimiterType>

forName

public static BaseLimiterType forName(String name)

Get a BaseLimiterType for the given name.

Parameters:

name - the given name

Returns:

a BaseLimiterType for the given name