Module org.tquadrat.foundation.base
Package org.tquadrat.foundation.lang

Record Class Status<V,C>

java.lang.Object
java.lang.Record
org.tquadrat.foundation.lang.Status<V,C>
Type Parameters:
V - The type of the result value.
C - The type of the error code.
Record Components:
result - The result value; can be null.
errorCode - The error code; a value of null indicates a success.
@ClassVersion(sourceVersion="$Id: Status.java 1119 2024-03-16 09:03:57Z tquadrat $") @API(status=STABLE, since="0.1.0") public record Status<V,C>(V result, C errorCode) extends Record
Instances of this record are meant to be used as the return values for methods that should either return a proper result, or an error code.

A sample use case may look like this: 
  …
  public final Status<Result,ErrorCode> processInput( final InputStream input ) {…}
  …

  …
  private final Throwable errorHandler( ErrorCode ) {…}
  …

  …
  public final Result execute( final File inputFile ) throws Throwable
  {
      ErrorHandler<ErrorCode> errorHandler =  this::errorHandler;
      try( var inputStream = new FileInputStream( inputFile ) )
      {
          return processInput( inputStream ).getOrElse( errorHandler );
      }
  }
  …
Author:
Thomas Thrien (thomas.thrien@tquadrat.org)
Version:
$Id: Status.java 1119 2024-03-16 09:03:57Z tquadrat $
Since:
0.1.0
UML Diagram
UML Diagram for "org.tquadrat.foundation.lang.Status"⁠

UML Diagram for "org.tquadrat.foundation.lang.Status"

UML Diagram for "org.tquadrat.foundation.lang.Status"⁠

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private final C
    errorCode
    The field for the errorCode record component.
    private final V
    result
    The field for the result record component.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Status(V result, C errorCode)
    Creates an instance of a Status record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    C
    errorCode()
    Returns the value of the errorCode record component.
    final V
    getOrElseThrow(ErrorHandler<? super C> errorHandler)
    Returns the result in case of a success, otherwise executes the given error handler and throws the exception determined by it.
    final int
    hashCode()
    Returns a hash code value for this object.
    final boolean
    isFailure()
    Returns whether this Status instance indicates a failure.
    final boolean
    isSuccess()
    Returns whether this Status instance indicates a success.
    final <R> Optional<R>
    map(Function<? super V,? extends R> conversion)
    Performs the given conversion on success, otherwise returns Optional.empty().
    final void
    onSuccess(Consumer<? super V> action)
    Performs the given action on success, otherwise does nothing.
    final void
    onSuccess(Consumer<? super V> action, ErrorHandler<? super C> errorHandler)
    Performs the given action on success, otherwise throws the exception determined by the error handler.
    final <R> R
    onSuccess(Function<? super V,R> conversion, ErrorHandler<? super C> errorHandler)
    Performs the given conversion on success, otherwise throws the exception determined by the error handler.
    V
    result()
    Returns the value of the result record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Field Details

    • result

      private final V result
      The field for the result record component.

    • errorCode

      private final C errorCode
      The field for the errorCode record component.

  • Constructor Details

    • Status

      public Status(V result, C errorCode)
      Creates an instance of a Status record class.
      Parameters:
      result - the value for the result record component
      errorCode - the value for the errorCode record component

  • Method Details

    • getOrElseThrow

      @API(status=STABLE, since="0.2.1") public final V getOrElseThrow(ErrorHandler<? super C> errorHandler) throws RuntimeException
      Returns the result in case of a success, otherwise executes the given error handler and throws the exception determined by it.
      Parameters:
      errorHandler - The error handler.
      Returns:
      The result.
      Throws:
      RuntimeException - Any exception that is determined by the error handler.
      Since:
      0.2.1

    • isFailure

      public final boolean isFailure()
      Returns whether this Status instance indicates a failure.
      Returns:
      true if the status indicates a failure, false otherwise.

    • isSuccess

      public final boolean isSuccess()
      Returns whether this Status instance indicates a success.
      Returns:
      true if the status indicates a success, false otherwise.

    • map

      public final <R> Optional<R> map(Function<? super V,? extends R> conversion)
      Performs the given conversion on success, otherwise returns Optional.empty().
      Note:
      • As the result can be null, too (or the result of the conversion is null), an empty return value does not necessarily indicate a failure.
      Type Parameters:
      R - The type of the conversion result.
      Parameters:
      conversion - The conversion.
      Returns:
      An instance of Optional that holds the converted result in case of a success, or it will be empty otherwise.

    • onSuccess

      public final void onSuccess(Consumer<? super V> action)
      Performs the given action on success, otherwise does nothing.
      Parameters:
      action - The action.

    • onSuccess

      public final void onSuccess(Consumer<? super V> action, ErrorHandler<? super C> errorHandler) throws RuntimeException
      Performs the given action on success, otherwise throws the exception determined by the error handler.
      Parameters:
      action - The action.
      errorHandler - The error handler.
      Throws:
      RuntimeException - Any exception that is determined by the error handler.

    • onSuccess

      public final <R> R onSuccess(Function<? super V,R> conversion, ErrorHandler<? super C> errorHandler) throws RuntimeException
      Performs the given conversion on success, otherwise throws the exception determined by the error handler.
      Type Parameters:
      R - The type of the conversion result.
      Parameters:
      conversion - The conversion.
      errorHandler - The error handler.
      Returns:
      The converted result.
      Throws:
      RuntimeException - Any exception that is determined by the error handler.

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

    • result

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

    • errorCode

      public C errorCode()
      Returns the value of the errorCode record component.
      Returns:
      the value of the errorCode record component