Package com.planet_ink.coffee_mud.Common.interfaces

Enum TimeClock.TimePeriod

java.lang.Object

java.lang.Enum<TimeClock.TimePeriod>

com.planet_ink.coffee_mud.Common.interfaces.TimeClock.TimePeriod

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<TimeClock.TimePeriod>

Enclosing interface:

TimeClock

public static enum TimeClock.TimePeriod
extends java.lang.Enum<TimeClock.TimePeriod>

Different time periods.

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALLTIME
DAY
HOUR
MONTH
SEASON
WEEK
YEAR

Method Summary

Modifier and Type	Method	Description
long	getIncrement()
long	nextPeriod()
static TimeClock.TimePeriod	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static TimeClock.TimePeriod[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

HOUR

public static final TimeClock.TimePeriod HOUR

DAY

public static final TimeClock.TimePeriod DAY

WEEK

public static final TimeClock.TimePeriod WEEK

MONTH

public static final TimeClock.TimePeriod MONTH

SEASON

public static final TimeClock.TimePeriod SEASON

YEAR

public static final TimeClock.TimePeriod YEAR

ALLTIME

public static final TimeClock.TimePeriod ALLTIME

Method Detail

values

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

Returns:

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

valueOf

public static TimeClock.TimePeriod 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

getIncrement

public long getIncrement()

nextPeriod

public long nextPeriod()