javastrava.api.v3.model.reference

Enum StravaFollowerState

java.lang.Object

java.lang.Enum<StravaFollowerState>

javastrava.api.v3.model.reference.StravaFollowerState

All Implemented Interfaces:

Serializable, Comparable<StravaFollowerState>

public enum StravaFollowerState
extends Enum<StravaFollowerState>

Status of an athlete's follower relationship with another athlete

Author:

Dan Shannon

Enum Constant Summary

Enum Constants

Enum Constant and Description
ACCEPTED Follower has been accepted
BLOCKED Follower has been blocked
PENDING Follower has been requested but neither accepted nor blocked at this time
UNKNOWN Should never occur but may if Strava API behaviour has changed

Method Summary

Modifier and Type	Method and Description
static StravaFollowerState	create(String id) Used by JSON deserialisation
String	getDescription()
String	getId()
String	getValue() Used by JSON serialisation
String	toString()
static StravaFollowerState	valueOf(String name) Returns the enum constant of this type with the specified name.
static StravaFollowerState[]	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

PENDING

public static final StravaFollowerState PENDING

Follower has been requested but neither accepted nor blocked at this time

ACCEPTED

public static final StravaFollowerState ACCEPTED

Follower has been accepted

BLOCKED

public static final StravaFollowerState BLOCKED

Follower has been blocked

UNKNOWN

public static final StravaFollowerState UNKNOWN

Should never occur but may if Strava API behaviour has changed

Method Detail

values

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

Returns:

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

valueOf

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

getValue

public String getValue()

Used by JSON serialisation

Returns:

The string representation of this StravaFollowerState to be used with the Strava API

See Also:

FollowerStateSerializer.serialize(StravaFollowerState, java.lang.reflect.Type, com.google.gson.JsonSerializationContext)

create

public static StravaFollowerState create(String id)

Used by JSON deserialisation

Parameters:

id - The string representation of a StravaFollowerState as returned by the Strava API

Returns:

The matching StravaFollowerState, or UNKNOWN if there is no match

getId

public String getId()

Returns:

the id

toString

public String toString()

Overrides:

toString in class Enum<StravaFollowerState>

See Also:

Enum.toString()

getDescription

public String getDescription()

Returns:

the description