/*
 * Copyright 2017-2020 original authors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package io.micronaut.web.router;

import io.micronaut.http.HttpRequest;
import io.micronaut.http.MediaType;

import java.util.Optional;
import java.util.function.Predicate;

Represents a Route that matches an exception. 
Author:
Graeme Rocher
Since:
1.0/**
 * Represents a {@link Route} that matches an exception.
 *
 * @author Graeme Rocher
 * @since 1.0
 */
public interface ErrorRoute extends MethodBasedRoute {

    
Returns:
The type the exception originates from. Null if the error route is global./**
     * @return The type the exception originates from. Null if the error route is global.
     */
    Class<?> originatingType();

    
Returns:
The type of exception/**
     * @return The type of exception
     */
    Class<? extends Throwable> exceptionType();

    
Match the given exception.
Params:
exception – The exception to match
Type parameters:
<T> –       The type
Returns:
The route match/**
     * Match the given exception.
     *
     * @param exception The exception to match
     * @param <T>       The type
     * @return The route match
     */
    <T> Optional<RouteMatch<T>> match(Throwable exception);

    
Match the given exception.
Params:
originatingClass – The class where the error originates from
exception –        The exception to match
Type parameters:
<T> –              The type
Returns:
The route match/**
     * Match the given exception.
     *
     * @param originatingClass The class where the error originates from
     * @param exception        The exception to match
     * @param <T>              The type
     * @return The route match
     */
    <T> Optional<RouteMatch<T>> match(Class originatingClass, Throwable exception);

    @Override
    ErrorRoute consumes(MediaType... mediaType);

    @Override
    ErrorRoute nest(Runnable nested);

    @Override
    ErrorRoute where(Predicate<HttpRequest<?>> condition);

    @Override
    ErrorRoute produces(MediaType... mediaType);
}