com.captainup.android.core.model

Enum LeaderboardTime

java.lang.Object

java.lang.Enum<LeaderboardTime>

com.captainup.android.core.model.LeaderboardTime

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<LeaderboardTime>

public enum LeaderboardTime
extends java.lang.Enum<LeaderboardTime>

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALL_TIME The global leaderboard, based on the number of points each user earned.
DAILY The daily leaderboard, based on the number of points each user earned today (starting from midnight, UTC time).
MONTHLY The monthly leaderboard, based on the number of points the users earned in this calendar month.
WEEKLY The weekly leaderboard, based on the number of points the users earned in this week (Sunday to Saturday)

Method Summary

Modifier and Type	Method and Description
static LeaderboardTime	fromValue(java.lang.String value)
java.lang.String	getRequestParam()
java.lang.String	toString()
static LeaderboardTime	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static LeaderboardTime[]	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

ALL_TIME

public static final LeaderboardTime ALL_TIME

The global leaderboard, based on the number of points each user earned.

MONTHLY

public static final LeaderboardTime MONTHLY

The monthly leaderboard, based on the number of points the users earned in this calendar month.

WEEKLY

public static final LeaderboardTime WEEKLY

The weekly leaderboard, based on the number of points the users earned in this week (Sunday to Saturday)

DAILY

public static final LeaderboardTime DAILY

The daily leaderboard, based on the number of points each user earned today (starting from midnight, UTC time).

Method Detail

values

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

Returns:

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

valueOf

public static LeaderboardTime valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<LeaderboardTime>

getRequestParam

public java.lang.String getRequestParam()

fromValue

public static LeaderboardTime fromValue(java.lang.String value)