Package com.xinapse.image

Enum Class InputConfigurationType

java.lang.Object
java.lang.Enum<InputConfigurationType>
com.xinapse.image.InputConfigurationType
All Implemented Interfaces:
Serializable, Comparable<InputConfigurationType>, Constable
public enum InputConfigurationType extends Enum<InputConfigurationType>
The types of input image configuration: either a single input image, or multiple input images.

  • Enum Constant Details

    • SINGLE_INPUT_IMAGE

      public static final InputConfigurationType SINGLE_INPUT_IMAGE
      The InputConfigurationType corresponding to a single input image.

    • MULTIPLE_INPUT_IMAGES

      public static final InputConfigurationType MULTIPLE_INPUT_IMAGES
      The InputConfigurationType corresponding to multiple input images.

  • Field Details

  • Method Details

    • values

      public static InputConfigurationType[] 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 InputConfigurationType 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

    • getInstance

      public static InputConfigurationType getInstance(String s) throws InvalidArgumentException
      Returns an InputConfigurationType Object corresponding to a string.
      Parameters:
      s - a String from which the configuration type will be interpreted. Can be:
      • "single",
      • "multiple",
      Interpretation of the String is case-insensitive.
      Returns:
      an InputConfigurationType Object corresponding to a String.
      Throws:
      InvalidArgumentException - if the string is invalid.

    • getPreferredInputConfigurationType

      public static InputConfigurationType getPreferredInputConfigurationType(Preferences prefs)
      Returns the user's preferred InputConfigurationType.
      Parameters:
      prefs - the Preferences in which to search.
      Returns:
      the user's preferred InputConfigurationType set in the Preferences, or the default if not set in the Preferences.

    • savePreferences

      public static void savePreferences(InputConfigurationType preferredType, Preferences prefs)
      Save the input configuration to the Preferences.
      Parameters:
      preferredType - the user's preferred InputConfigurationType.
      prefs - the Preferences into which to save.

    • toString

      public String toString()
      Returns a String describing this InputConfigurationType.
      Overrides:
      toString in class Enum<InputConfigurationType>
      Returns:
      a String describing this InputConfigurationType.