Record Class Reason

java.lang.Object
java.lang.Record
be.sddevelopment.validation.core.Reason
public record Reason(String rationale, Evaluation result) extends Record

Reason class.

Represents the evaluation of a single Constraint, and will be included in a Rationale. Each reason will tell the user whether a particular rule passed or failed, and will include a description (aka "rationale") to explain why a certain result was achieved.

This class is immutable, and provides static factory methods to simplify usage, and increase readability..

Since:
1.0.0-SNAPSHOT
Version:
1.0.0-SNAPSHOT

  • Constructor Details

    • Reason

      public Reason(String rationale, Evaluation result)
      Creates an instance of a Reason record class.
      Parameters:
      rationale - the value for the rationale record component
      result - the value for the result record component

  • Method Details

    • passed

      public static Reason passed(String rationale)

    • failed

      public static Reason failed(String rationale)

    • isPassing

      public boolean isPassing()

    • isFailing

      public boolean isFailing()

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

    • rationale

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

    • result

      public Evaluation result()
      Returns the value of the result record component.
      Returns:
      the value of the result record component