io.github.robolib.robot

Enum GameMode

java.lang.Object

java.lang.Enum<GameMode>

io.github.robolib.robot.GameMode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<GameMode>

public enum GameMode
extends java.lang.Enum<GameMode>

The Enum GameMode.

Since:

0.1.0

Author:

noriah

Enum Constant Summary

Enum Constants

Enum Constant and Description
AUTON The auton.
DISABLED The disabled.
NONE The none.
TELEOP The teleop.
TEST The test.

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	m_abbr The m_abbr.
private java.lang.String	m_name The m_name.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAbbreviation() Get the abbreviation of the GameMode.
java.lang.String	getName() Get the name of the GameMode.
static GameMode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static GameMode[]	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

NONE

public static final GameMode NONE

The none.

DISABLED

public static final GameMode DISABLED

The disabled.

TEST

public static final GameMode TEST

The test.

AUTON

public static final GameMode AUTON

The auton.

TELEOP

public static final GameMode TELEOP

The teleop.

Field Detail

m_name

private final java.lang.String m_name

The m_name.

m_abbr

private final java.lang.String m_abbr

The m_abbr.

Method Detail

values

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

Returns:

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

valueOf

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

getName

public java.lang.String getName()

Get the name of the GameMode.

Returns:

the GameMode Name

getAbbreviation

public java.lang.String getAbbreviation()

Get the abbreviation of the GameMode.

Returns:

the GameMode abbreviation