sirius.kernel.health.HandledException Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sirius-kernel Show documentation

Provides common core classes and the microkernel powering all Sirius applications

There is a newer version: 12.9.1

/*
 * Made with all the love in the world
 * by scireum in Remshalden, Germany
 *
 * Copyright by scireum GmbH
 * http://www.scireum.de - [email protected]
 */

package sirius.kernel.health;

/**
 * An exception which has already been handled (logged and reacted upon) can be represented by
 * HandledException.
 * 
 * Instances of this type need no further treatment and guarantee to have a properly translated error message,
 * which van be directly shown to the user.
 * 
 * Creating a HandledException is done by using one of the static methods of {@link Exceptions}.
 */
public class HandledException extends RuntimeException {

    private static final long serialVersionUID = 4460968279048068701L;

    /**
     * Creates a new instance with the given message and no exception attached
     *
     * @param message the message to be shown to the user
     */
    protected HandledException(String message) {
        super(message);
    }

    /**
     * Created a new instance with the given message and exception attached
     *
     * @param message the message to be shown to the user
     * @param e       the exception to be attached
     */
    protected HandledException(String message, Throwable e) {
        super(message, e);
    }
}