me.alidg.errors.WebErrorHandler Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of errors-spring-boot-starter Show documentation

A Spring Boot starter which provides a few primitives to handle exceptions more elegantly.

The newest version!

package me.alidg.errors;

import org.springframework.lang.NonNull;
import org.springframework.lang.Nullable;

/**
 * Defines a contract to handle exceptions in the Web layer and convert them to appropriate
 * error codes with meaningful status codes. This is a contract for exception handling and
 * nobody's gonna handle the exceptions thrown by the contract methods, so do not throw
 * exceptions in your method implementations.
 *
 * @author Ali Dehghani
 * @implNote Do not throw exceptions in method implementations.
 */
public interface WebErrorHandler {

    /**
     * Determines whether this particular implementation can handle the given exception
     * or not.
     *
     * @param exception The exception to examine.
     * @return {@code true} if this implementation can handle the exception, {@code false}
     * otherwise.
     */
    boolean canHandle(@Nullable Throwable exception);

    /**
     * Handles the given exception and returns an instance of {@link HandledException}.
     * This method should be called iff the call to {@link #canHandle(Throwable)} for
     * the same exception returns {@code true}.
     *
     * @param exception The exception to handle.
     * @return A set of error codes.
     */
    @NonNull
    HandledException handle(@Nullable Throwable exception);
}