Module org.panteleyev.commons
Package org.panteleyev.commons.functional

Record Class Failure<T>

java.lang.Object
java.lang.Record
org.panteleyev.commons.functional.Failure<T>
Type Parameters:
T - result type
Record Components:
exception - result exception
All Implemented Interfaces:
Result<T>
public record Failure<T>(Exception exception) extends Record implements Result<T>
This class represents failed result with exception.

  • Constructor Details

    • Failure

      public Failure(Exception exception)
      Creates an instance of a Failure record class.
      Parameters:
      exception - the value for the exception 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.

    • exception

      public Exception exception()
      Returns the value of the exception record component.
      Returns:
      the value of the exception record component