Package ch.so.agi.hop.doclint.model

Record Class CheckResult

java.lang.Object
java.lang.Record
ch.so.agi.hop.doclint.model.CheckResult
public record CheckResult(String elementId, String check, CheckStatus status, String detail) extends Record
Result of a single check.

elementId may be blank for repository-wide findings, for example an unreadable example pipeline.

  • Constructor Details

    • CheckResult

      public CheckResult(String elementId, String check, CheckStatus status, String detail)
      Creates an instance of a CheckResult record class.
      Parameters:
      elementId - the value for the elementId record component
      check - the value for the check record component
      status - the value for the status record component
      detail - the value for the detail record component

  • Method Details

    • ok

      public static CheckResult ok(String elementId, String check)

    • ok

      public static CheckResult ok(String elementId, String check, String detail)

    • fail

      public static CheckResult fail(String elementId, String check)

    • fail

      public static CheckResult fail(String elementId, String check, String detail)

    • warn

      public static CheckResult warn(String elementId, String check, String detail)

    • skip

      public static CheckResult skip(String elementId, String check)

    • isError

      public boolean isError()

    • isWarning

      public boolean isWarning()

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

    • elementId

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

    • check

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

    • status

      public CheckStatus status()
      Returns the value of the status record component.
      Returns:
      the value of the status record component

    • detail

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