Enum Class CombineMode

java.lang.Object
java.lang.Enum<CombineMode>
com.xinapse.multisliceimage.roi.CombineMode
All Implemented Interfaces:
Serializable, Comparable<CombineMode>, Constable

public enum CombineMode extends Enum<CombineMode>
An enumeration of possible ROI combination operations that can be be applied to a set of ROIs to create a single resulting ROI.
  • Enum Constant Details

  • Method Details

    • values

      public static CombineMode[] 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 CombineMode 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
    • toString

      public String toString()
      Returns a string describing this CombineMode.
      Overrides:
      toString in class Enum<CombineMode>
      Returns:
      a String describing this CombineMode.
    • savePreferences

      public static void savePreferences(CombineMode combineMode, Preferences prefs)
      Saves the supplied CombineMode as the user's preferrred CombineMode.
      Parameters:
      combineMode - the CombineMode to save in the user's preferences.
      prefs - the user Preferences in which to save the CombineMode.
    • getPreferredCombineMode

      public static CombineMode getPreferredCombineMode(Preferences prefs, CombineMode defaultCombineMode)
      Returns the CombineMode set in the UserPreferences, or the default CombineMode, if none is set in the Preferences.
      Parameters:
      prefs - the user Preferences in which to look for the preferred CombineMode.
      defaultCombineMode - the default to return if the preferred CombineMode cannot be found in the user Preferences.
      Returns:
      the user's preferred CombineMode.