com.northconcepts.datapipeline.twitter

Enum ApiLimitPolicy

java.lang.Object

java.lang.Enum<ApiLimitPolicy>

com.northconcepts.datapipeline.twitter.ApiLimitPolicy

All Implemented Interfaces:

IApiLimitPolicy, Serializable, Comparable<ApiLimitPolicy>

public enum ApiLimitPolicy
extends Enum<ApiLimitPolicy>
implements IApiLimitPolicy

Indicates the action to take when the Twitter API call limits are reached.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FAIL Stop the reader with an exception if the Twitter API call limit is reached.
STOP Stop the reader normally if the Twitter API call limit is reached.
WAIT Wait for the limits to be reset if the Twitter API call limit is reached.

Method Summary

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

Methods inherited from interface com.northconcepts.datapipeline.twitter.IApiLimitPolicy

onLimitExceeded

Enum Constant Detail

STOP

public static final ApiLimitPolicy STOP

Stop the reader normally if the Twitter API call limit is reached.

FAIL

public static final ApiLimitPolicy FAIL

Stop the reader with an exception if the Twitter API call limit is reached.

WAIT

public static final ApiLimitPolicy WAIT

Wait for the limits to be reset if the Twitter API call limit is reached.

Method Detail

values

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

Returns:

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

valueOf

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