Enum Class Phase

java.lang.Object
java.lang.Enum<Phase>
net.sf.colossus.game.Phase
All Implemented Interfaces:
Serializable, Comparable<Phase>, Constable

public enum Phase extends Enum<Phase>
TODO this should probably start numbering with zero as does the BattlePhase and as does any other Java enum -- currently SPLIT is serialized as "1" TODO instead: now that I added an artificial phase "INIT" (needed during start of the game, otherwise updateStatusScreen tries to do toString on null), - are then the fromInt/toInit still needed?
  • Enum Constant Details

    • INIT

      public static final Phase INIT
    • SPLIT

      public static final Phase SPLIT
    • MOVE

      public static final Phase MOVE
    • FIGHT

      public static final Phase FIGHT
    • MUSTER

      public static final Phase MUSTER
  • Field Details

    • name

      private final String name
  • Constructor Details

    • Phase

      private Phase(String name)
  • Method Details

    • values

      public static Phase[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static Phase valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name
      NullPointerException - if the argument is null
    • fromInt

      public static Phase fromInt(int i)
      Deserialize enum from integer value.
      Parameters:
      i - The number for the phase.
      Returns:
      The matching Phase instance.
      Throws:
      ArrayOutOfBoundsException - iff the number is not valid.
    • toInt

      public int toInt()
      Serialize the object to an integer code. Used for savegames.
      Returns:
      An integer code representing the phase.
    • toString

      public String toString()
      Returns a non-localized UI string for the phase.
      Overrides:
      toString in class Enum<Phase>