javastrava.api.v3.model.reference

Enum StravaStreamResolutionType

java.lang.Object

java.lang.Enum<StravaStreamResolutionType>

javastrava.api.v3.model.reference.StravaStreamResolutionType

All Implemented Interfaces:

Serializable, Comparable<StravaStreamResolutionType>

public enum StravaStreamResolutionType
extends Enum<StravaStreamResolutionType>

Resolution type for requested/returned streams

Author:

Dan Shannon

Enum Constant Summary

Enum Constants

Enum Constant and Description
HIGH High resolution (10000 points)
LOW Low resolution (100 points)
MEDIUM Medium resolution (1000 points)
UNKNOWN Should never occur but may if Strava API behaviour has changed

Method Summary

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

LOW

public static final StravaStreamResolutionType LOW

Low resolution (100 points)

MEDIUM

public static final StravaStreamResolutionType MEDIUM

Medium resolution (1000 points)

HIGH

public static final StravaStreamResolutionType HIGH

High resolution (10000 points)

UNKNOWN

public static final StravaStreamResolutionType UNKNOWN

Should never occur but may if Strava API behaviour has changed

Method Detail

values

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

Returns:

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

valueOf

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

See Also:

StreamResolutionTypeSerializer.serialize(StravaStreamResolutionType, java.lang.reflect.Type, com.google.gson.JsonSerializationContext)

create

public static StravaStreamResolutionType create(String id)

Used by JSON deserialisation

Parameters:

id - The string representation of a StravaStreamResolutionType returned by the Strava API

Returns:

The matching StravaStreamResolutionType, or UNKNOWN if there is no match

getId

public String getId()

Returns:

the id

toString

public String toString()

Overrides:

toString in class Enum<StravaStreamResolutionType>

See Also:

Enum.toString()

getDescription

public String getDescription()

Returns:

the description

getSize

public int getSize()

Returns:

the size