Module com.darkcollective.relix.lang.ast

Package com.darkcollective.relix.lang.ast.source

Enum Class ApiKeyAuth.ApiKeyLocation

java.lang.Object

java.lang.Enum<ApiKeyAuth.ApiKeyLocation>

com.darkcollective.relix.lang.ast.source.ApiKeyAuth.ApiKeyLocation

All Implemented Interfaces:

Serializable, Comparable<ApiKeyAuth.ApiKeyLocation>, Constable

Enclosing class:

ApiKeyAuth

public static enum ApiKeyAuth.ApiKeyLocation
extends Enum<ApiKeyAuth.ApiKeyLocation>

Where an ApiKeyAuth key is placed in the request.

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
HEADER	Sent as a request header.
QUERY	Appended as a URL query parameter.

Method Summary

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

HEADER

public static final ApiKeyAuth.ApiKeyLocation HEADER

Sent as a request header.

QUERY

public static final ApiKeyAuth.ApiKeyLocation QUERY

Appended as a URL query parameter.

Method Details

values

public static ApiKeyAuth.ApiKeyLocation[] 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 ApiKeyAuth.ApiKeyLocation 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