Enum InteractionAxis

  • All Implemented Interfaces:
    Serializable, Comparable<InteractionAxis>, Key

    public enum InteractionAxis
    extends Enum<InteractionAxis>
    implements Key
    Can be set to 'x', 'y', or 'xy' to define which directions are used in calculating distances.
    Defaults to 'x' for index mode and 'xy' in dataset and nearest modes.
    Author:
    Andrea "Stock" Stocchero
    • Enum Constant Detail

      • X

        public static final InteractionAxis X
        X directions are used in calculating distances.
      • Y

        public static final InteractionAxis Y
        Y directions are used in calculating distances.
      • XY

        public static final InteractionAxis XY
        XY directions are used in calculating distances.
    • Method Detail

      • values

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

        public static InteractionAxis valueOf​(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:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null
      • value

        public String value()
        Description copied from interface: Key
        Returns the name value of property
        Specified by:
        value in interface Key
        Returns:
        the name value of property