net.sf.freecol.common.model
Enum CombatModel.CombatResultType

java.lang.Object
  extended by java.lang.Enum<CombatModel.CombatResultType>
      extended by net.sf.freecol.common.model.CombatModel.CombatResultType
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<CombatModel.CombatResultType>
Enclosing interface:
CombatModel

public static enum CombatModel.CombatResultType
extends java.lang.Enum<CombatModel.CombatResultType>


Enum Constant Summary
DONE_SETTLEMENT
           
EVADES
           
GREAT_LOSS
           
GREAT_WIN
           
LOSS
           
WIN
           
 
Method Summary
 boolean isSuccess()
          Returns if this combat result was a success for the attacking unit.
static CombatModel.CombatResultType valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static CombatModel.CombatResultType[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

GREAT_LOSS

public static final CombatModel.CombatResultType GREAT_LOSS

LOSS

public static final CombatModel.CombatResultType LOSS

EVADES

public static final CombatModel.CombatResultType EVADES

WIN

public static final CombatModel.CombatResultType WIN

GREAT_WIN

public static final CombatModel.CombatResultType GREAT_WIN

DONE_SETTLEMENT

public static final CombatModel.CombatResultType DONE_SETTLEMENT
Method Detail

values

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

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

valueOf

public static CombatModel.CombatResultType 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

isSuccess

public boolean isSuccess()
Returns if this combat result was a success for the attacking unit.

Returns:
true if the attack was a success and false otherwise.