Package kboyle.oktane.core.results.precondition

Record Class PreconditionFailedResult

java.lang.Object
java.lang.Record
kboyle.oktane.core.results.precondition.PreconditionFailedResult
All Implemented Interfaces:
FailedResult, PreconditionResult, Result
public record PreconditionFailedResult(String reason) extends Record implements PreconditionResult, FailedResult

  • Constructor Details

    • PreconditionFailedResult

      public PreconditionFailedResult​(String reason)
      Creates an instance of a PreconditionFailedResult record class.
      Parameters:
      reason - the value for the reason record component

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

    • reason

      public String reason()
      Returns the value of the reason record component.
      Specified by:
      reason in interface FailedResult
      Returns:
      the value of the reason record component