io.github.thunderbots.lightning.utility

Enum Alliance

java.lang.Object

java.lang.Enum<Alliance>

io.github.thunderbots.lightning.utility.Alliance

All Implemented Interfaces:

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

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

The Alliance is an enumeration of possible sides of the field. This could be used to write autonomous code that can adapt to changing sides of the field.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BLUE
RED

Field Summary

Fields

Modifier and Type	Field and Description
private int	side The integer that represents the side of the field.

Method Summary

Modifier and Type	Method and Description
int	getSide() Gets the integer side of the field.
static Alliance	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Alliance[]	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

BLUE

public static final Alliance BLUE

RED

public static final Alliance RED

Field Detail

side

private final int side

The integer that represents the side of the field. Blue is 1, and red is -1.

Method Detail

values

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

Returns:

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

valueOf

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

getSide

public int getSide()

Gets the integer side of the field.

Returns:

the side of the field.

See Also:

side