javastrava.api.v3.model.reference

Enum StravaMeasurementMethod

java.lang.Object

java.lang.Enum<StravaMeasurementMethod>

javastrava.api.v3.model.reference.StravaMeasurementMethod

All Implemented Interfaces:

Serializable, Comparable<StravaMeasurementMethod>

public enum StravaMeasurementMethod
extends Enum<StravaMeasurementMethod>

Preferred measurement system for an athlete. Those of you living in the 19th century will prefer IMPERIAL

Author:

Dan Shannon

Enum Constant Summary

Enum Constants

Enum Constant and Description
IMPERIAL Imperial units
METRIC Metric
UNKNOWN Should never occur but may if Strava API behaviour has changed

Method Summary

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

IMPERIAL

public static final StravaMeasurementMethod IMPERIAL

Imperial units

METRIC

public static final StravaMeasurementMethod METRIC

Metric

UNKNOWN

public static final StravaMeasurementMethod UNKNOWN

Should never occur but may if Strava API behaviour has changed

Method Detail

values

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

Returns:

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

valueOf

public static StravaMeasurementMethod 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 the StravaMeasurementMethod to be used with the Strava API

See Also:

MeasurementMethodSerializer.serialize(StravaMeasurementMethod, java.lang.reflect.Type, com.google.gson.JsonSerializationContext)

create

public static StravaMeasurementMethod create(String id)

Used by JSON deserialisation

Parameters:

id - The string representation of the StravaMeasurementMethod returned by the Strava API

Returns:

The matching StravaMeasurementMethod, or UNKNOWN if there is no match

getId

public String getId()

Returns:

the id

toString

public String toString()

Overrides:

toString in class Enum<StravaMeasurementMethod>

See Also:

Enum.toString()

getDescription

public String getDescription()

Returns:

the description