de.weltraumschaf.commons.time

Enum StopWatch.State

java.lang.Object

java.lang.Enum<StopWatch.State>

de.weltraumschaf.commons.time.StopWatch.State

All Implemented Interfaces:

Serializable, Comparable<StopWatch.State>

Enclosing class:

StopWatch

private static enum StopWatch.State
extends Enum<StopWatch.State>

Enumeration type which indicates the status of stopwatch.

Enum Constant Summary

Enum Constants

Enum Constant and Description
RUNNING Stopwatch is running.
STOPPED Stopwatch is stopped.
SUSPENDED Stopwatch is suspended.
UNSTARTED Stopwatch is not started.

Method Summary

Methods

Modifier and Type	Method and Description
(package private) abstract boolean	isStarted() The method is used to find out if the StopWatch is started.
(package private) abstract boolean	isStopped() This method is used to find out whether the StopWatch is stopped.
(package private) abstract boolean	isSuspended() This method is used to find out whether the StopWatch is suspended.
static StopWatch.State	valueOf(String name) Returns the enum constant of this type with the specified name.
static StopWatch.State[]	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

UNSTARTED

public static final StopWatch.State UNSTARTED

Stopwatch is not started.

RUNNING

public static final StopWatch.State RUNNING

Stopwatch is running.

STOPPED

public static final StopWatch.State STOPPED

Stopwatch is stopped.

SUSPENDED

public static final StopWatch.State SUSPENDED

Stopwatch is suspended.

Method Detail

values

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

Returns:

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

valueOf

public static StopWatch.State valueOf(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:

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

NullPointerException - if the argument is null

isStarted

abstract boolean isStarted()

The method is used to find out if the StopWatch is started. A suspended StopWatch is also started watch.

Returns:

boolean If the StopWatch is started.

isStopped

abstract boolean isStopped()

This method is used to find out whether the StopWatch is stopped. The stopwatch which's not yet started and explicitly stopped stopwatch is considered as stopped.

Returns:

boolean If the StopWatch is stopped.

isSuspended

abstract boolean isSuspended()

This method is used to find out whether the StopWatch is suspended.

Returns:

boolean If the StopWatch is suspended.