Package org.opennms.netmgt.rrd.model.v3

Enum CFType

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<CFType>
    public enum CFType
extends java.lang.Enum<CFType>
    The Enumeration CFType (Consolidation Function Type).

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      AVERAGE
      v3: RRA:AVERAGE:xff:steps:rows.
      DEVPREDICT
      v3: RRA:DEVPREDICT:rows:rra-num.
      DEVSEASONAL
      v3: RRA:DEVSEASONAL:seasonal-period:gamma:rra-num[:smoothing-window=fraction].
      FAILURES
      v3: RRA:FAILURES:rows:threshold:window-length:rra-num.
      HWPREDICT
      v3: RRA:HWPREDICT:rows:alpha:beta:seasonal-period[:rra-num].
      LAST
      v3: RRA:LAST:xff:steps:rows.
      MAX
      v3: RRA:MAX:xff:steps:rows.
      MHWPREDICT
      v4: RRA:MHWPREDICT:rows:alpha:beta:seasonal-period[:rra-num]
      MIN
      v3: RRA:MIN:xff:steps:rows.
      SEASONAL
      v3: RRA:SEASONAL:seasonal-period:gamma:rra-num[:smoothing-window=fraction].

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static CFType fromValue​(java.lang.String v)
      From value.
      java.lang.String value()
      Gets the CF Value.
      static CFType valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static CFType[] 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

      • AVERAGE

        public static final CFType AVERAGE
        v3: RRA:AVERAGE:xff:steps:rows.

      • MIN

        public static final CFType MIN
        v3: RRA:MIN:xff:steps:rows.

      • MAX

        public static final CFType MAX
        v3: RRA:MAX:xff:steps:rows.

      • LAST

        public static final CFType LAST
        v3: RRA:LAST:xff:steps:rows.

      • HWPREDICT

        public static final CFType HWPREDICT
        v3: RRA:HWPREDICT:rows:alpha:beta:seasonal-period[:rra-num].

      • SEASONAL

        public static final CFType SEASONAL
        v3: RRA:SEASONAL:seasonal-period:gamma:rra-num[:smoothing-window=fraction].

      • DEVSEASONAL

        public static final CFType DEVSEASONAL
        v3: RRA:DEVSEASONAL:seasonal-period:gamma:rra-num[:smoothing-window=fraction].

      • DEVPREDICT

        public static final CFType DEVPREDICT
        v3: RRA:DEVPREDICT:rows:rra-num.

      • FAILURES

        public static final CFType FAILURES
        v3: RRA:FAILURES:rows:threshold:window-length:rra-num.

      • MHWPREDICT

        public static final CFType MHWPREDICT
        v4: RRA:MHWPREDICT:rows:alpha:beta:seasonal-period[:rra-num]

    • Method Detail

      • values

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

      • valueOf

        public static CFType 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

      • value

        public java.lang.String value()
        Gets the CF Value.
        Returns:
        the string representation of the consolidation function

      • fromValue

        public static CFType fromValue​(java.lang.String v)
        From value.
        Parameters:
        v - the string name of the CF
        Returns:
        the consolidation function type