javastrava.api.v3.model.reference

Enum StravaLeaderboardDateRange

java.lang.Object

java.lang.Enum<StravaLeaderboardDateRange>

javastrava.api.v3.model.reference.StravaLeaderboardDateRange

All Implemented Interfaces:

Serializable, Comparable<StravaLeaderboardDateRange>

public enum StravaLeaderboardDateRange
extends Enum<StravaLeaderboardDateRange>

Date range options used for filtering leaderboards

Author:

Dan Shannon

Enum Constant Summary

Enum Constants

Enum Constant and Description
THIS_MONTH This calendar month
THIS_WEEK This calendar week
THIS_YEAR This calendar year
TODAY Today
UNKNOWN Should never occur but may if Strava API behaviour has changed

Method Summary

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

THIS_YEAR

public static final StravaLeaderboardDateRange THIS_YEAR

This calendar year

THIS_MONTH

public static final StravaLeaderboardDateRange THIS_MONTH

This calendar month

THIS_WEEK

public static final StravaLeaderboardDateRange THIS_WEEK

This calendar week

TODAY

public static final StravaLeaderboardDateRange TODAY

Today

UNKNOWN

public static final StravaLeaderboardDateRange UNKNOWN

Should never occur but may if Strava API behaviour has changed

Method Detail

values

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

Returns:

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

valueOf

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

See Also:

LeaderboardDateRangeSerializer.serialize(StravaLeaderboardDateRange, java.lang.reflect.Type, com.google.gson.JsonSerializationContext)

create

public static StravaLeaderboardDateRange create(String id)

Used by JSON deserialisation

Parameters:

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

Returns:

The matching StravaLeaderboardDateRange, or UNKNOWN if there is no match

getId

public String getId()

Returns:

the id

getDescription

public String getDescription()

Returns:

the description

toString

public String toString()

Overrides:

toString in class Enum<StravaLeaderboardDateRange>

See Also:

Enum.toString()