Package com.inductiveautomation.ignition.gateway.metrics

Record Class IdentifiedMetric

java.lang.Object
java.lang.Record
com.inductiveautomation.ignition.gateway.metrics.IdentifiedMetric
public record IdentifiedMetric(@Nullable String name, com.codahale.metrics.Metric metric) extends Record
A pair of a name and a metric. The name is the one used to find the metric in the registry, see MetricRegistry

  • Constructor Summary

    Constructors
    Constructor
    Description
    IdentifiedMetric(String name, com.codahale.metrics.Metric metric)
    Creates an instance of a IdentifiedMetric record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    com.codahale.metrics.Metric
    metric()
    Returns the value of the metric record component.
    String
    name()
    Returns the value of the name record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • IdentifiedMetric

      public IdentifiedMetric(@Nullable String name, com.codahale.metrics.Metric metric)
      Creates an instance of a IdentifiedMetric record class.
      Parameters:
      name - the value for the name record component
      metric - the value for the metric record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • name

      @Nullable public String name()
      Returns the value of the name record component.
      Returns:
      the value of the name record component

    • metric

      public com.codahale.metrics.Metric metric()
      Returns the value of the metric record component.
      Returns:
      the value of the metric record component