Enum Class TimeType

java.lang.Object

java.lang.Enum<TimeType>

net.flectone.pulse.constant.TimeType

All Implemented Interfaces:

Serializable, Comparable<TimeType>, Constable

public enum TimeType
extends Enum<TimeType>

The play-time figures a placeholder can ask for. Each constant knows how to work its own value out from a stored PlayTime row.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
FIRST
LAST
TOTAL
TOTAL_DYNAMIC

Method Summary

Modifier and Type	Method	Description
static Optional<TimeType>	fromString(String string)	Maps a name back to its constant, ignoring case.
abstract long	getTime(FPlayer fPlayer, PlayTime playTime)	Works out this figure for a player.
static TimeType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static TimeType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

FIRST

public static final TimeType FIRST

LAST

public static final TimeType LAST

TOTAL

public static final TimeType TOTAL

TOTAL_DYNAMIC

public static final TimeType TOTAL_DYNAMIC

Method Details

values

public static TimeType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static TimeType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getTime

public abstract long getTime(FPlayer fPlayer,
 PlayTime playTime)

Works out this figure for a player.

Parameters:

fPlayer - the player, consulted for whether they are online right now

playTime - the stored session statistics

Returns:

the time in milliseconds

fromString

public static Optional<TimeType> fromString(String string)

Maps a name back to its constant, ignoring case.

Parameters:

string - the name to parse

Returns:

the matching figure, or empty if the name is unknown