javastrava.api.v3.model.reference

Enum StravaClimbCategory

java.lang.Object

java.lang.Enum<StravaClimbCategory>

javastrava.api.v3.model.reference.StravaClimbCategory

All Implemented Interfaces:

Serializable, Comparable<StravaClimbCategory>

public enum StravaClimbCategory
extends Enum<StravaClimbCategory>

Strava climb categories as applied to segments

Author:

Dan Shannon

Enum Constant Summary

Enum Constants

Enum Constant and Description
CATEGORY1 Category 1
CATEGORY2 Category 2
CATEGORY3 Category 3
CATEGORY4 Category 4
FLAT Category 5
HORS_CATEGORIE Hors categorie
UNKNOWN Should never occur but may if Strava API behaviour has changed

Method Summary

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

HORS_CATEGORIE

public static final StravaClimbCategory HORS_CATEGORIE

Hors categorie

CATEGORY1

public static final StravaClimbCategory CATEGORY1

Category 1

CATEGORY2

public static final StravaClimbCategory CATEGORY2

Category 2

CATEGORY3

public static final StravaClimbCategory CATEGORY3

Category 3

CATEGORY4

public static final StravaClimbCategory CATEGORY4

Category 4

FLAT

public static final StravaClimbCategory FLAT

Category 5

UNKNOWN

public static final StravaClimbCategory UNKNOWN

Should never occur but may if Strava API behaviour has changed

Method Detail

values

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

Returns:

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

valueOf

public static StravaClimbCategory 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 Integer getValue()

Used by JSON serialisation

Returns:

The integer value to be used with the Strava API

See Also:

ClimbCategorySerializer.serialize(StravaClimbCategory, java.lang.reflect.Type, com.google.gson.JsonSerializationContext)

create

public static StravaClimbCategory create(Integer id)

Used by JSON deserialisation

Parameters:

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

Returns:

The matching StravaClimbCategory, or UNKNOWN if there is no match

See Also:

ClimbCategorySerializer.deserialize(com.google.gson.JsonElement, java.lang.reflect.Type, com.google.gson.JsonDeserializationContext)

getId

public Integer getId()

Returns:

the id

getDescription

public String getDescription()

Returns:

the description

toString

public String toString()

Overrides:

toString in class Enum<StravaClimbCategory>

See Also:

Enum.toString()