net.sf.colossus.game
Enum EntrySide

java.lang.Object
  extended by java.lang.Enum<EntrySide>
      extended by net.sf.colossus.game.EntrySide
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<EntrySide>

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

The entry side for a battle.


Enum Constant Summary
BOTTOM
           
LEFT
           
LEFT_DEFENSE
           
NOT_SET
           
RIGHT
           
RIGHT_DEFENSE
           
TOP_DEFENSE
           
 
Field Summary
private  java.lang.String label
           
 
Method Summary
static EntrySide fromLabel(java.lang.String label)
           
 java.lang.String getLabel()
           
 EntrySide getOpposingSide()
           
 boolean isAttackerSide()
           
static EntrySide valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static EntrySide[] 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

TOP_DEFENSE

public static final EntrySide TOP_DEFENSE

RIGHT

public static final EntrySide RIGHT

RIGHT_DEFENSE

public static final EntrySide RIGHT_DEFENSE

BOTTOM

public static final EntrySide BOTTOM

LEFT_DEFENSE

public static final EntrySide LEFT_DEFENSE

LEFT

public static final EntrySide LEFT

NOT_SET

public static final EntrySide NOT_SET
Field Detail

label

private final java.lang.String label
Method Detail

values

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

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

valueOf

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

getLabel

public java.lang.String getLabel()

isAttackerSide

public boolean isAttackerSide()

getOpposingSide

public EntrySide getOpposingSide()

fromLabel

public static EntrySide fromLabel(java.lang.String label)