Package com.patelheet.capitalengine.api.service

Record Class Indicator

java.lang.Object
java.lang.Record
com.patelheet.capitalengine.api.service.Indicator
Record Components:
key - stable machine key
label - plain-language label
value - current value
unit - how to display it
public record Indicator(String key, String label, double value, Unit unit) extends Record
A named number an add-on publishes for dashboards.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Indicator(String key, String label, double value, Unit unit)
    Creates an instance of a Indicator 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.
    String
    key()
    Returns the value of the key record component.
    String
    label()
    Returns the value of the label record component.
    final String
    toString()
    Returns a string representation of this record class.
    Unit
    unit()
    Returns the value of the unit record component.
    double
    value()
    Returns the value of the value record component.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • Indicator

      public Indicator(String key, String label, double value, Unit unit)
      Creates an instance of a Indicator record class.
      Parameters:
      key - the value for the key record component
      label - the value for the label record component
      value - the value for the value record component
      unit - the value for the unit 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      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.

    • key

      public String key()
      Returns the value of the key record component.
      Returns:
      the value of the key record component

    • label

      public String label()
      Returns the value of the label record component.
      Returns:
      the value of the label record component

    • value

      public double value()
      Returns the value of the value record component.
      Returns:
      the value of the value record component

    • unit

      public Unit unit()
      Returns the value of the unit record component.
      Returns:
      the value of the unit record component