javastrava.api.v3.model.reference

Enum StravaFrameType

java.lang.Object

java.lang.Enum<StravaFrameType>

javastrava.api.v3.model.reference.StravaFrameType

All Implemented Interfaces:

Serializable, Comparable<StravaFrameType>

public enum StravaFrameType
extends Enum<StravaFrameType>

Bicycle frame type

Author:

Dan Shannon

Enum Constant Summary

Enum Constants

Enum Constant and Description
CROSS Cross bike
MOUNTAIN_BIKE Mountain bike
ROAD Road bike
TIME_TRIAL Time trial bike
UNKNOWN Should never occur but may if Strava API behaviour has changed

Method Summary

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

MOUNTAIN_BIKE

public static final StravaFrameType MOUNTAIN_BIKE

Mountain bike

CROSS

public static final StravaFrameType CROSS

Cross bike

ROAD

public static final StravaFrameType ROAD

Road bike

TIME_TRIAL

public static final StravaFrameType TIME_TRIAL

Time trial bike

UNKNOWN

public static final StravaFrameType UNKNOWN

Should never occur but may if Strava API behaviour has changed

Method Detail

values

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

Returns:

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

valueOf

public static StravaFrameType 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 representation of this StravaFrameType to be used with the Strava API

See Also:

FrameTypeSerializer.serialize(StravaFrameType, java.lang.reflect.Type, com.google.gson.JsonSerializationContext)

create

public static StravaFrameType create(Integer id)

Used by JSON deserialisation

Parameters:

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

Returns:

The matching StravaFrameType, or UNKNOWN if there is no match

getId

public Integer getId()

Returns:

the id

getDescription

public String getDescription()

Returns:

the description

toString

public String toString()

Overrides:

toString in class Enum<StravaFrameType>

See Also:

Enum.toString()