Enum MetricRegistry.Type

  • Enclosing class:
    MetricRegistry


    public static enum MetricRegistry.Type
    extends java.lang.Enum<MetricRegistry.Type>
    An enumeration representing the scopes of the MetricRegistry
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      APPLICATION
      The Application (default) scoped MetricRegistry.
      BASE
      The Base scoped MetricRegistry.
      VENDOR
      The Vendor scoped MetricRegistry.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getName​()
      Returns the name of the MetricRegistry scope.
      static MetricRegistry.Type valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static MetricRegistry.Type[] 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

      • APPLICATION

        public static final MetricRegistry.Type APPLICATION
        The Application (default) scoped MetricRegistry. Any metric registered/accessed via CDI will use this MetricRegistry.
      • BASE

        public static final MetricRegistry.Type BASE
        The Base scoped MetricRegistry. This MetricRegistry will contain required metrics specified in the MicroProfile Metrics specification.
      • VENDOR

        public static final MetricRegistry.Type VENDOR
        The Vendor scoped MetricRegistry. This MetricRegistry will contain vendor provided metrics which may vary between different vendors.
    • Method Detail

      • values

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

        public static MetricRegistry.Type 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
      • getName

        public java.lang.String getName​()
        Returns the name of the MetricRegistry scope.
        Returns:
        the scope