Record Class Check

java.lang.Object
java.lang.Record
com.thirtysevenaudits.auditor.Check
Record Components:
code - structured identity for this check definition (not the individual finding), modeled as CheckCode. Use CheckCode.id() as the stable key when grouping findings—similar in spirit to Hibernate ORM message ids such as HHH000406. Recommended id shapes include 37A-AuditorName-NNN (e.g. 37A-MyAuditor-001) or compact values such as 37A-000123; CheckCode.description() may hold a short human-readable label. Must not be null.
public record Check(CheckStatus status, String resource, String message, String recommendation, int score, Map<String,Object> data, CheckCode code) extends Record
A single audit finding.

  • Constructor Details

    • Check

      public Check(CheckStatus status, String resource, String message, String recommendation, int score, Map<String,Object> data, CheckCode code)
      Creates an instance of a Check record class.
      Parameters:
      status - the value for the status record component
      resource - the value for the resource record component
      message - the value for the message record component
      recommendation - the value for the recommendation record component
      score - the value for the score record component
      data - the value for the data record component
      code - the value for the code record component

  • Method Details

    • countStatus

      public static long countStatus(Collection<Check> checks, CheckStatus status)

    • convertFailToWarning

      public static Check convertFailToWarning(Check c)

    • 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 the compare method from their corresponding wrapper classes.
      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.

    • status

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

    • resource

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

    • message

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

    • recommendation

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

    • score

      public int score()
      Returns the value of the score record component.
      Returns:
      the value of the score record component

    • data

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

    • code

      public CheckCode code()
      Returns the value of the code record component.
      Returns:
      the value of the code record component