inf112.fiasko.roborally.objects.properties

Enum RobotID

java.lang.Object

java.lang.Enum<RobotID>

inf112.fiasko.roborally.objects.properties.RobotID

All Implemented Interfaces:

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

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

This class represents an id for marking specific robots

Enum Constant Summary

Enum Constants

Enum Constant and Description
ROBOT_1 The id of the first robot (white)
ROBOT_2 The id of the second robot (pink)
ROBOT_3 The id of the third robot (light green)
ROBOT_4 The id of the fourth robot (blue)
ROBOT_5 The id of the fifth robot (yellow)
ROBOT_6 The id of the sixth robot (dark green)
ROBOT_7 The id of the seventh robot (orange)
ROBOT_8 The id of the eight robot (red)

Method Summary

Modifier and Type	Method and Description
static RobotID	getRobotIDFromID(int robotID) Gets a robot ID value from its numerical representation
int	getRobotIDID() Gets the numerical id used for identification of a robot id
static RobotID	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static RobotID[]	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

ROBOT_1

public static final RobotID ROBOT_1

The id of the first robot (white)

ROBOT_2

public static final RobotID ROBOT_2

The id of the second robot (pink)

ROBOT_3

public static final RobotID ROBOT_3

The id of the third robot (light green)

ROBOT_4

public static final RobotID ROBOT_4

The id of the fourth robot (blue)

ROBOT_5

public static final RobotID ROBOT_5

The id of the fifth robot (yellow)

ROBOT_6

public static final RobotID ROBOT_6

The id of the sixth robot (dark green)

ROBOT_7

public static final RobotID ROBOT_7

The id of the seventh robot (orange)

ROBOT_8

public static final RobotID ROBOT_8

The id of the eight robot (red)

Method Detail

values

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

Returns:

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

valueOf

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

getRobotIDFromID

public static RobotID getRobotIDFromID(int robotID)

Gets a robot ID value from its numerical representation

Parameters:

robotID - The numerical representation of a robot id

Returns:

The enum value representing the robot ID, or null if the id is invalid

getRobotIDID

public int getRobotIDID()

Gets the numerical id used for identification of a robot id

Returns:

The numerical id of the robot id