Interface Meter

All Superinterfaces:
Wrapper, Wrapper
All Known Subinterfaces:
Counter, DistributionSummary, FunctionalCounter, Gauge<N>, Timer
public interface Meter extends Wrapper
Common behavior of all meters.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static class 
    Meter.BaseUnits
    Common unit declarations (inspired by the list from MicroProfile metrics).
    static interface 
    Meter.Builder<B extends Meter.Builder<B,M>, M extends Meter>
    Common behavior of specific meter builders.
    static interface 
    Meter.Id
    Unique idenfier for a meter.
    static class 
    Meter.Scope
    Deprecated, for removal: This API element is subject to removal in a future version.
    Core metrics ignores scope values, and this type will be removed.
    static enum 
    Meter.Type
    Type of meter.

  • Method Summary

    Modifier and Type
    Method
    Description
    Optional<String>
    baseUnit()
    Returns the meter's base unit.
    Optional<String>
    description()
    Returns the meter's description.
    Meter.Id
    id()
    Returns the meter ID.
    default Optional<String>
    scope()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Core metrics does not assign scopes, and this method will be removed.
    Meter.Type
    type()
    Returns the meter type.

    Methods inherited from interface Wrapper

    unwrap
    Modifier and Type
    Method
    Description
    <T> T
    unwrap(Class<? extends T> type)
    Unwraps the delegate as the specified type.

  • Method Details

    • id

      Meter.Id id()
      Returns the meter ID.
      Returns:
      meter ID

    • baseUnit

      Optional<String> baseUnit()
      Returns the meter's base unit.
      Returns:
      base unit

    • description

      Optional<String> description()
      Returns the meter's description.
      Returns:
      description

    • type

      Meter.Type type()
      Returns the meter type.
      Returns:
      meter type

    • scope

      @Deprecated(forRemoval=true, since="27.0.0") default Optional<String> scope()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Core metrics does not assign scopes, and this method will be removed.
      Always returns empty because core metrics does not assign scopes.
      Returns:
      empty