javastrava.api.v3.auth.ref

Enum AuthorisationResponseType

java.lang.Object

java.lang.Enum<AuthorisationResponseType>

javastrava.api.v3.auth.ref.AuthorisationResponseType

All Implemented Interfaces:

Serializable, Comparable<AuthorisationResponseType>

public enum AuthorisationResponseType
extends Enum<AuthorisationResponseType>

Valid authorisation response types

As of Strava API v3.0, this value must be set to CODE

Author:

Dan Shannon

Enum Constant Summary

Enum Constants

Enum Constant and Description
CODE Currently Strava requires the use of this value when exchanging authorisation via OAuth.
UNKNOWN Should never occur but may if Strava API behaviour has changed

Method Summary

Modifier and Type	Method and Description
static AuthorisationResponseType	create(String id) Required by GSON serialiser
String	getId()
String	toString()
static AuthorisationResponseType	valueOf(String name) Returns the enum constant of this type with the specified name.
static AuthorisationResponseType[]	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

CODE

public static final AuthorisationResponseType CODE

Currently Strava requires the use of this value when exchanging authorisation via OAuth. This is the only valid value.

UNKNOWN

public static final AuthorisationResponseType UNKNOWN

Should never occur but may if Strava API behaviour has changed

Method Detail

values

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

Returns:

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

valueOf

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

create

public static AuthorisationResponseType create(String id)

Required by GSON serialiser

Parameters:

id - The String value of the id

Returns:

An instance of AuthorisationResponseType corresponding to the id, or UNKNOWN if no such instance is available.

getId

public String getId()

Returns:

the id

toString

public String toString()

Overrides:

toString in class Enum<AuthorisationResponseType>

See Also:

Enum.toString()