battlecode.common
Enum RobotLevel

java.lang.Object
  extended by java.lang.Enum<RobotLevel>
      extended by battlecode.common.RobotLevel
All Implemented Interfaces:
Serializable, Comparable<RobotLevel>

public enum RobotLevel
extends Enum<RobotLevel>

This enumeration distinguishes objects that are on the ground, or in the encampment level at a given location.

Since RobotLevel is a Java 1.5 enum, you can use it in switch statements, it has all the standard enum methods (valueOf, values, etc.), and you can safely use == for equality tests.


Enum Constant Summary
ON_GROUND
          The vertical location of ground robots.
 
Method Summary
 int getHeight()
          Returns an integral height-wise ordering of the height type.
static RobotLevel valueOf(String name)
          Returns the enum constant of this type with the specified name.
static RobotLevel[] 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

ON_GROUND

public static final RobotLevel ON_GROUND
The vertical location of ground robots.

Method Detail

values

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

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

valueOf

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

getHeight

public int getHeight()
Returns an integral height-wise ordering of the height type.