Package be.uclouvain.orthanc

Enum MetricsType

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<MetricsType>
    public enum MetricsType
extends java.lang.Enum<MetricsType>
    The available types of metrics.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      DEFAULT
      Default metrics
      TIMER
      This metrics represents a time duration.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected static MetricsType getInstance​(int value)
      Return the enumeration value that corresponds to an integer value of interest.
      int getValue()
      Get the integer value corresponding to this enumeration value.
      static MetricsType valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static MetricsType[] 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

      • DEFAULT

        public static final MetricsType DEFAULT
        Default metrics

      • TIMER

        public static final MetricsType TIMER
        This metrics represents a time duration. Orthanc will keep the maximum value of the metrics over a sliding window of ten seconds, which is useful if the metrics is sampled frequently.

    • Method Detail

      • values

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

      • valueOf

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

      • getInstance

        protected static MetricsType getInstance​(int value)
        Return the enumeration value that corresponds to an integer value of interest.
        Parameters:
        value - The integer value.
        Returns:
        The enumeration value.

      • getValue

        public int getValue()
        Get the integer value corresponding to this enumeration value.
        Returns:
        The integer value.