Module page.codeberg.friedolyn.Friedolyn

Package page.codeberg.friedolyn.util

Enum Class Countdown.Status

java.lang.Object

java.lang.Enum<Countdown.Status>

page.codeberg.friedolyn.util.Countdown.Status

All Implemented Interfaces:

Serializable, Comparable<Countdown.Status>, Constable

Enclosing class:

Countdown

public static enum Countdown.Status
extends Enum<Countdown.Status>

Indicates what a countdown is currently doing or what it has done.

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
CANCELLED	The countdown has been stopped before it could reach zero.
FINISHED	The countdown has reached zero and is no longer counting down.
PAUSED	The time is currently not being counted down and is instead halted at the current value.
READY	The countdown can be started without further ado.
RUNNING	The time is currently being counted down.

Field Summary

Fields

Modifier and Type	Field	Description
private final String	label

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Status(String label)

Method Summary

Modifier and Type	Method	Description
static Countdown.Status	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Countdown.Status[]	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

READY

public static final Countdown.Status READY

The countdown can be started without further ado.

PAUSED

public static final Countdown.Status PAUSED

The time is currently not being counted down and is instead halted at the current value. Use Countdown.resume() to continue counting down.

RUNNING

public static final Countdown.Status RUNNING

The time is currently being counted down. Use Countdown.pause() to halt the countdown temporarily or Countdown.cancel() to abort it entirely.

FINISHED

public static final Countdown.Status FINISHED

The countdown has reached zero and is no longer counting down. Use Countdown.reset() to change prepare the countdown for being launched once again with the initial time. Use Countdown.restart() to immediately launch the countdown again.

CANCELLED

public static final Countdown.Status CANCELLED

The countdown has been stopped before it could reach zero. Use Countdown.reset() to prepare the countdown for being launched once again with the initial time. Use Countdown.restart() to immediately launch the countdown again.

Field Details

label

private final String label

Constructor Details

Status

private Status(String label)

Method Details

values

public static Countdown.Status[] 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 Countdown.Status 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