Package dev.voidframework.restclient.retrofit.interceptor

Enum Class ApiKeyAuthenticationInterceptor.AddTo

java.lang.Object

java.lang.Enum<ApiKeyAuthenticationInterceptor.AddTo>

dev.voidframework.restclient.retrofit.interceptor.ApiKeyAuthenticationInterceptor.AddTo

All Implemented Interfaces:

Serializable, Comparable<ApiKeyAuthenticationInterceptor.AddTo>, Constable

Enclosing class:

ApiKeyAuthenticationInterceptor

public static enum ApiKeyAuthenticationInterceptor.AddTo
extends Enum<ApiKeyAuthenticationInterceptor.AddTo>

Available locations where to add API key.

Since:

1.10.0

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
COOKIE	API authentication will be added to request cookie.
HEADER	API authentication will be added to request headers.
QUERY_PARAMETER	API authentication will be added to request query parameters.

Method Summary

Modifier and Type	Method	Description
static ApiKeyAuthenticationInterceptor.AddTo	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ApiKeyAuthenticationInterceptor.AddTo[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

COOKIE

public static final ApiKeyAuthenticationInterceptor.AddTo COOKIE

API authentication will be added to request cookie.

Since:

1.10.0

HEADER

public static final ApiKeyAuthenticationInterceptor.AddTo HEADER

API authentication will be added to request headers.

Since:

1.10.0

QUERY_PARAMETER

public static final ApiKeyAuthenticationInterceptor.AddTo QUERY_PARAMETER

API authentication will be added to request query parameters.

Since:

1.10.0

Method Details

values

public static ApiKeyAuthenticationInterceptor.AddTo[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static ApiKeyAuthenticationInterceptor.AddTo valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null