Package net.sf.freecol.common.model

Enum BuildQueue.CompletionAction

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      ADD_RANDOM
      Remove the completed item and add a random new item.
      REMOVE
      Always remove the completed item.
      REMOVE_EXCEPT_LAST
      Remove the completed item unless it is the last item and several instances of the item can co-exist (which is true for units, but not buildings).
      SHUFFLE
      Shuffle the items rather than remove the completed item.

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private CompletionAction()  

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static BuildQueue.CompletionAction valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static BuildQueue.CompletionAction[] 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

      • REMOVE

        public static final BuildQueue.CompletionAction REMOVE
        Always remove the completed item. Not used by any build queue at the moment.

      • REMOVE_EXCEPT_LAST

        public static final BuildQueue.CompletionAction REMOVE_EXCEPT_LAST
        Remove the completed item unless it is the last item and several instances of the item can co-exist (which is true for units, but not buildings). This is the strategy used by the colony build queue.

      • SHUFFLE

        public static final BuildQueue.CompletionAction SHUFFLE
        Shuffle the items rather than remove the completed item. This is the strategy used by the colony population queue.

      • ADD_RANDOM

        public static final BuildQueue.CompletionAction ADD_RANDOM
        Remove the completed item and add a random new item. This is the strategy of the immigration queue (which is not implemented as a build queue at the moment, however).

    • Constructor Detail

      • CompletionAction

        private CompletionAction()

    • Method Detail

      • values

        public static BuildQueue.CompletionAction[] 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 (BuildQueue.CompletionAction c : BuildQueue.CompletionAction.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static BuildQueue.CompletionAction 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