javastrava.api.v3.model.reference

Enum StravaResourceState

java.lang.Object

java.lang.Enum<StravaResourceState>

javastrava.api.v3.model.reference.StravaResourceState

All Implemented Interfaces:

Serializable, Comparable<StravaResourceState>, StravaReferenceType<Integer>

public enum StravaResourceState
extends Enum<StravaResourceState>
implements StravaReferenceType<Integer>

State of a resource returned from Strava.

Author:

Dan Shannon

Enum Constant Summary

Enum Constants

Enum Constant and Description
DETAILED This is a detailed representation of the resource
META This is a representation of the resource which contains the id ONLY (other than the resource state)
PRIVATE Indicates that the resource is flagged as PRIVATE and as a result is not accessible.
SUMMARY This is a summary representation of the resource
UNKNOWN Should never occur but may if Strava API behaviour has changed
UPDATING Resource is currently being updated

Method Summary

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

UPDATING

public static final StravaResourceState UPDATING

Resource is currently being updated

META

public static final StravaResourceState META

This is a representation of the resource which contains the id ONLY (other than the resource state)

SUMMARY

public static final StravaResourceState SUMMARY

This is a summary representation of the resource

DETAILED

public static final StravaResourceState DETAILED

This is a detailed representation of the resource

PRIVATE

public static final StravaResourceState PRIVATE

Indicates that the resource is flagged as PRIVATE and as a result is not accessible.

Will be returned as an empty object with only the id and resourceState set.

UNKNOWN

public static final StravaResourceState UNKNOWN

Should never occur but may if Strava API behaviour has changed

Method Detail

values

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

Returns:

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

valueOf

public static StravaResourceState 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 StravaResourceState create(Integer id)

Used by JSON deserialisation

Parameters:

id - The integer representation of this StravaResourceState as returned by the Strava API

Returns:

The matching StravaResourceState, or UNKNOWN if there is no match

getDescription

public String getDescription()

Specified by:

getDescription in interface StravaReferenceType<Integer>

Returns:

the description

getId

public Integer getId()

Specified by:

getId in interface StravaReferenceType<Integer>

Returns:

the id

getValue

public Integer getValue()

Used by JSON serialisation

Specified by:

getValue in interface StravaReferenceType<Integer>

Returns:

The integer representation of this StravaResourceState to be used with the Strava API

See Also:

ResourceStateSerializer.serialize(StravaResourceState, java.lang.reflect.Type, com.google.gson.JsonSerializationContext)

toString

public String toString()

Specified by:

toString in interface StravaReferenceType<Integer>

Overrides:

toString in class Enum<StravaResourceState>

See Also:

Enum.toString()