org.swblocks.jbl.eh

Class Result<T>

java.lang.Object

org.swblocks.jbl.eh.Result<T>

public final class Result<T>
extends java.lang.Object

Result class used to store the outcome of an operation.

The outcome of an operation is stored as a success or failure result and does not terminate the processing. The result can be used to determine what to do next.

Example usage:

 public boolean carryOutTask() {
     Result result = doProcessing();
     if (result.isSuccess()) {
         return true;
     }
     return false;
 }

  private Result doProcessing() {
      try {
          callAnOperation();
          return Result.success("my success data");
      } catch (Exception exception) {
          return Result.failure(exception);
      }
  }
 

Method Summary

Modifier and Type	Method and Description
static <T> Result<T>	failure(java.util.function.Supplier<java.lang.Exception> exceptionSupplier) Create a failure Result object from an exception supplier.
T	getData() Returns underlying data stored when the result is a success.
java.lang.Exception	getException() Get the failure exception.
boolean	isSuccess() Check if a success result.
static <T> Result<T>	success(T data) Create a success Result object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

success

public static <T> Result<T> success(T data)

Create a success Result object.

Type Parameters:

T - the object type

Parameters:

data - the success data

Returns:

the result object

failure

public static <T> Result<T> failure(java.util.function.Supplier<java.lang.Exception> exceptionSupplier)

Create a failure Result object from an exception supplier.

Type Parameters:

T - the object type

Parameters:

exceptionSupplier - the supplier

Returns:

the result object

isSuccess

public boolean isSuccess()

Check if a success result.

Returns:

true if successful, false otherwise

getData

public T getData()

Returns underlying data stored when the result is a success.

Returns:

the success data

getException

public java.lang.Exception getException()

Get the failure exception.

Returns:

the exception