javastrava.api.v3.model.reference

Enum StravaPhotoType

java.lang.Object

java.lang.Enum<StravaPhotoType>

javastrava.api.v3.model.reference.StravaPhotoType

All Implemented Interfaces:

Serializable, Comparable<StravaPhotoType>, StravaReferenceType<String>

public enum StravaPhotoType
extends Enum<StravaPhotoType>
implements StravaReferenceType<String>

Type of photo - currently Instagram only

Author:

Dan Shannon

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTAGRAM Instagram photo
UNKNOWN Should never occur but may if Strava API behaviour has changed

Method Summary

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

INSTAGRAM

public static final StravaPhotoType INSTAGRAM

Instagram photo

UNKNOWN

public static final StravaPhotoType UNKNOWN

Should never occur but may if Strava API behaviour has changed

Method Detail

values

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

Returns:

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

valueOf

public static StravaPhotoType 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 StravaPhotoType create(String id)

Used by JSON deserialisation

Parameters:

id - The string represenation of a StravaPhotoType as returned by the Strava API

Returns:

The matching StravaPhotoType, or UNKNOWN if there is no match

getDescription

public String getDescription()

Specified by:

getDescription in interface StravaReferenceType<String>

Returns:

the description

getId

public String getId()

Specified by:

getId in interface StravaReferenceType<String>

Returns:

the id

getValue

public String getValue()

Used by JSON serialisation

Specified by:

getValue in interface StravaReferenceType<String>

Returns:

The string representation of this StravaPhotoType to be used with the Strava API

See Also:

PhotoTypeSerializer.serialize(StravaPhotoType, java.lang.reflect.Type, com.google.gson.JsonSerializationContext)

toString

public String toString()

Specified by:

toString in interface StravaReferenceType<String>

Overrides:

toString in class Enum<StravaPhotoType>

See Also:

Enum.toString()