Package com.amalgamasimulation.desktop.connectivity

Record Class ConnectivityCheckResult

java.lang.Object
java.lang.Record
com.amalgamasimulation.desktop.connectivity.ConnectivityCheckResult
Record Components:
kind - display state of the check
reason - error reason for ERROR, or null
public record ConnectivityCheckResult(ConnectivityCheckResult.Kind kind, String reason) extends Record
Result of a connectivity check shown in the Connectivity Status dialog.

  • Constructor Details

    • ConnectivityCheckResult

      public ConnectivityCheckResult(ConnectivityCheckResult.Kind kind, String reason)
      Creates an instance of a ConnectivityCheckResult record class.
      Parameters:
      kind - the value for the kind record component
      reason - the value for the reason record component

  • Method Details

    • ok

      public static ConnectivityCheckResult ok()

    • error

      public static ConnectivityCheckResult error(String reason)

    • checking

      public static ConnectivityCheckResult checking()

    • notApplicable

      public static ConnectivityCheckResult notApplicable()

    • 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.

    • kind

      public ConnectivityCheckResult.Kind kind()
      Returns the value of the kind record component.
      Returns:
      the value of the kind record component

    • reason

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