Record Class HealthProvider.Health

java.lang.Object
java.lang.Record
com.github.jpmsilva.jsystemd.HealthProvider.Health
Record Components:
healthy - true if this object represents a healthy state, false otherwise
details - additional health details for each application component
Enclosing interface:
HealthProvider

public static record HealthProvider.Health(boolean healthy, Map<String,Object> details) extends Record
The health state of an application. Immutable: the details are copied, keeping their order, and cannot be modified.
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    A health object that represents a healthy application state.
  • Constructor Summary

    Constructors
    Constructor
    Description
    Health(boolean healthy, Map<String,Object> details)
    Provides for a health representation (healthy/unhealthy), with health details for each component.
  • Method Summary

    Modifier and Type
    Method
    Description
    Returns the value of the details record component.
    final boolean
    Indicates whether some other object is "equal to" this one.
    final int
    Returns a hash code value for this object.
    boolean
    Returns the value of the healthy record component.
    final String
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait
  • Field Details

    • HEALTHY

      public static final HealthProvider.Health HEALTHY
      A health object that represents a healthy application state.
  • Constructor Details

    • Health

      public Health(boolean healthy, Map<String,Object> details)
      Provides for a health representation (healthy/unhealthy), with health details for each component.
      Parameters:
      healthy - true if this object represents a healthy state, false otherwise
      details - additional health details for each application component
      Throws:
      NullPointerException - if details is null
  • 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.
    • healthy

      public boolean healthy()
      Returns the value of the healthy record component.
      Returns:
      the value of the healthy record component
    • details

      public Map<String,Object> details()
      Returns the value of the details record component.
      Returns:
      the value of the details record component