Package games.stendhal.server.core.rp

Enum Class DaylightPhase

java.lang.Object

java.lang.Enum<DaylightPhase>

games.stendhal.server.core.rp.DaylightPhase

All Implemented Interfaces:

Serializable, Comparable<DaylightPhase>, Constable

public enum DaylightPhase
extends Enum<DaylightPhase>

day light phase

Author:

hendrik

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DAWN	early morning before sunrise at
DAY	during the day
DUSK	early night
NIGHT	during the night
SUNRISE	the sun is rising
SUNSET	the sun is setting

Method Summary

Modifier and Type	Method	Description
static DaylightPhase	current()	gets the current daylight phase
Integer	getColor()	gets the color of this daylight phase
String	getGreetingName()	Gets the greeting name
static void	setTestingPhase(DaylightPhase phase)	WARNING: this should only be used for testing purposes.
static void	unsetTestingPhase()	Disables testing phase.
static DaylightPhase	valueOf(String name)	Returns the enum constant of this class with the specified name.
static DaylightPhase[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NIGHT

public static final DaylightPhase NIGHT

during the night

DAWN

public static final DaylightPhase DAWN

early morning before sunrise at

SUNRISE

public static final DaylightPhase SUNRISE

the sun is rising

DAY

public static final DaylightPhase DAY

during the day

SUNSET

public static final DaylightPhase SUNSET

the sun is setting

DUSK

public static final DaylightPhase DUSK

early night

Method Details

values

public static DaylightPhase[] 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 DaylightPhase 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

current

public static DaylightPhase current()

gets the current daylight phase

Returns:

DaylightPhase

getColor

public Integer getColor()

gets the color of this daylight phase

Returns:

color

getGreetingName

public String getGreetingName()

Gets the greeting name

Returns:

greeting name

setTestingPhase

public static void setTestingPhase(DaylightPhase phase)

WARNING: this should only be used for testing purposes.

Parameters:

phase - DaylightPhase to set for testing.

unsetTestingPhase

public static void unsetTestingPhase()

Disables testing phase.