Enum PlotNumber

  • All Implemented Interfaces:
    IPropCnrNumber, java.io.Serializable, java.lang.Comparable<PlotNumber>

    public enum PlotNumber
    extends java.lang.Enum<PlotNumber>
    implements IPropCnrNumber
    The Plot2D number settings the can be set or retrieved.
    Author:
    Christopher Mindus
    • Enum Constant Summary

      Enum Constants 
      Enum ConstantDescription
      PRECISION
      The precision at which to round data values for display.
      START_ANGLE
      Where to being rendering gradients in slices, in degrees.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      doublegetDefaultValue()
      Gets the default value when the property is not set.
      java.lang.StringgetPropName()
      Returns the name of the property, usually starting with '$'.
      static PlotNumbervalueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static PlotNumber[]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

      • PRECISION

        public static final PlotNumber PRECISION
        The precision at which to round data values for display.

        Default is 1.

      • START_ANGLE

        public static final PlotNumber START_ANGLE
        Where to being rendering gradients in slices, in degrees. Default is 0.
    • Method Detail

      • values

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

        public static PlotNumber 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
      • getDefaultValue

        public double getDefaultValue()
        Gets the default value when the property is not set.
        Specified by:
        getDefaultValue in interface IPropCnrNumber
      • getPropName

        public java.lang.String getPropName()
        Returns the name of the property, usually starting with '$'.
        Specified by:
        getPropName in interface IPropCnrNumber