futur4j/futur-api/src/main/java/dev/tommyjs/futur/promise/PromiseCompletion.java

package dev.tommyjs.futur.promise;

import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

import java.util.concurrent.CancellationException;
import java.util.concurrent.CompletionException;
import java.util.concurrent.ExecutionException;

/**
 * Represents the result of a {@link Promise}, containing either an optional result or an exception.
 */
public record PromiseCompletion<T>(@Nullable T result, @Nullable Throwable exception) {

    /**
     * Creates a new successful completion.
     *
     * @param result the result
     */
    public PromiseCompletion(@Nullable T result) {
        this(result, null);
    }

    /**
     * Creates a new exceptional completion.
     *
     * @param exception the exception
     */
    public PromiseCompletion(@NotNull Throwable exception) {
        this(null, exception);
    }

    /**
     * Creates a new successful completion with a result of {@code null}.
     */
    public PromiseCompletion() {
        this(null, null);
    }

    /**
     * Checks if the completion was successful.
     *
     * @return {@code true} if the completion was successful, {@code false} otherwise
     */
    public boolean isSuccess() {
        return exception == null;
    }

    /**
     * Checks if the completion was exceptional.
     *
     * @return {@code true} if the completion was exceptional, {@code false} otherwise
     */
    public boolean isError() {
        return exception != null;
    }

    /**
     * Checks if the completion was cancelled.
     *
     * @return {@code true} if the completion was cancelled, {@code false} otherwise
     */
    public boolean wasCancelled() {
        return exception instanceof CancellationException;
    }

    /**
     * Gets the result of the completion.
     *
     * @return the result, or {@code null} if the completion was exceptional
     */
    public @Nullable T getResult() {
        return result;
    }

    /**
     * Gets the exception of the completion.
     *
     * @return the exception, or {@code null} if the completion was successful
     */
    public @Nullable Throwable getException() {
        return exception;
    }

    /**
     * Gets the result or throws a {@link CompletionException} if the completion was exceptional.
     *
     * @return the result of the completion
     * @throws CompletionException if the completion was exceptional
     */
    public T get() {
        if (isSuccess()) return getResult();
        throw new CompletionException(getException());
    }

    /**
     * Gets the result or throws an {@link ExecutionException} if the completion was exceptional.
     *
     * @return the result of the completion
     * @throws ExecutionException if the completion was exceptional
     */
    public T getChecked() throws ExecutionException {
        if (isSuccess()) return getResult();
        throw new ExecutionException(getException());
    }

}