org.robokind.api.common.playable

Enum PlayState

java.lang.Object

java.lang.Enum<PlayState>

org.robokind.api.common.playable.PlayState

All Implemented Interfaces:

Serializable, Comparable<PlayState>

public enum PlayState
extends Enum<PlayState>

States of a Playable.

Author:

Matthew Stevenson

Enum Constant Summary

Enum Constants

Enum Constant and Description
COMPLETED A Playable which is completed and no longer running.
PAUSED A Playable which has been paused.
PENDING A Playable which has not been started.
RUNNING A Playable which is currently running.
STOPPED A Playable which has been stopped before completion.

Method Summary

Methods

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

PENDING

public static final PlayState PENDING

A Playable which has not been started.

RUNNING

public static final PlayState RUNNING

A Playable which is currently running.

PAUSED

public static final PlayState PAUSED

A Playable which has been paused.

STOPPED

public static final PlayState STOPPED

A Playable which has been stopped before completion.

COMPLETED

public static final PlayState COMPLETED

A Playable which is completed and no longer running.

Method Detail

values

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

Returns:

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

valueOf

public static PlayState 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