com.microsoft.semantickernel.exceptions.SKException Maven / Gradle / Ivy

Go to download
// Copyright (c) Microsoft. All rights reserved.
package com.microsoft.semantickernel.exceptions;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

/**
 * Provides the base exception from which all Semantic Kernel exceptions derive.
 */
public class SKException extends RuntimeException {

    /**
     * Initializes a new instance of the {@code SKException} class with a default message.
     */
    protected SKException() {
        super();
    }

    /**
     * Initializes a new instance of the {@code SKException} class with its message set to
     * {@code message}.
     *
     * @param message A string that describes the error.
     */
    public SKException(@Nullable String message) {
        super(message);
    }

    /**
     * Initializes a new instance of the {@code SKException} class with its message set to
     * {@code message}.
     *
     * @param message A string that describes the error.
     * @param cause   The exception that is the cause of the current exception.
     */
    public SKException(@Nullable String message, @Nullable Throwable cause) {
        super(message, cause);
    }

    public SKException(Throwable e) {
        super(e);
    }

    /**
     * Forms an unchecked exception, if the exception is already an SK exception, it will be
     * unwrapped and the cause extracted.
     *
     * @param message The message to be displayed
     * @param e       The exception to be thrown
     * @return An unchecked exception
     */
    public static SKException build(
        String message,
        @Nullable Exception e) {

        if (e == null) {
            return new SKException(message);
        }

        Throwable cause = e.getCause();

        if ((e instanceof SKCheckedException || e instanceof SKException) && cause != null) {
            return new SKException(message, cause);
        } else {
            return new SKException(message, e);
        }
    }

    /**
     * Translate the error code into a default message format.
     *
     * @param errorMessage The error message from an error code
     * @param message      The message from the code which throws the exception
     * @return A formatted message
     */
    protected static String formatDefaultMessage(
        @Nonnull String errorMessage, @Nullable String message) {
        return String.format("%s: %s", errorMessage, message);
    }
}