javastrava.api.v3.model.reference

Enum StravaTerrainType

java.lang.Object

java.lang.Enum<StravaTerrainType>

javastrava.api.v3.model.reference.StravaTerrainType

All Implemented Interfaces:

Serializable, Comparable<StravaTerrainType>, StravaReferenceType<Integer>

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

Author:

danshannon

Enum Constant Summary

Enum Constants

Enum Constant and Description
KILLER_CLIMBS Killer climbs
MOSTLY_FLAT Mostly flat
ROLLING_HILLS Rolling hills
UNKNOWN Unknown

Method Summary

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

MOSTLY_FLAT

public static final StravaTerrainType MOSTLY_FLAT

Mostly flat

ROLLING_HILLS

public static final StravaTerrainType ROLLING_HILLS

Rolling hills

KILLER_CLIMBS

public static final StravaTerrainType KILLER_CLIMBS

Killer climbs

UNKNOWN

public static final StravaTerrainType UNKNOWN

Unknown

Method Detail

values

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

Returns:

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

valueOf

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

Create the one from the integer id

Parameters:

id - Identifier

Returns:

The enumeration instance with the given id, 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 identifier

toString

public String toString()

Specified by:

toString in interface StravaReferenceType<Integer>

Overrides:

toString in class Enum<StravaTerrainType>

See Also:

Enum.toString()