io.apimatic.coreinterfaces.http.request.configuration

Enum RetryOption

java.lang.Object

java.lang.Enum<RetryOption>

io.apimatic.coreinterfaces.http.request.configuration.RetryOption

All Implemented Interfaces:

Serializable, Comparable<RetryOption>

public enum RetryOption
extends Enum<RetryOption>

Retry options enumeration for HTTP request.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DEFAULT To use global httpMethods whitelist to determine if request needs retrying.
DISABLE To disable retries for the request.
ENABLE_FOR_HTTP_METHOD To retry request, ignoring httpMethods whitelist.

Method Summary

Modifier and Type	Method and Description
boolean	isRetryAllowed(boolean isWhitelistedRequestMethod) Determines whether retrying for the request is allowed or not.
static RetryOption	valueOf(String name) Returns the enum constant of this type with the specified name.
static RetryOption[]	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

ENABLE_FOR_HTTP_METHOD

public static final RetryOption ENABLE_FOR_HTTP_METHOD

To retry request, ignoring httpMethods whitelist.

DISABLE

public static final RetryOption DISABLE

To disable retries for the request.

DEFAULT

public static final RetryOption DEFAULT

To use global httpMethods whitelist to determine if request needs retrying.

Method Detail

values

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

Returns:

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

valueOf

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

isRetryAllowed

public boolean isRetryAllowed(boolean isWhitelistedRequestMethod)

Determines whether retrying for the request is allowed or not.

Parameters:

isWhitelistedRequestMethod - flag if the global list of HTTP method contains the request method.

Returns:

True if retrying for the request is allowed.