/*
 * 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.core.type.Argument;
import io.micronaut.core.util.ArrayUtils;
import io.micronaut.http.HttpMethod;
import io.micronaut.http.uri.UriMatchInfo;

import java.util.*;
import java.util.function.Function;

A RouteMatch that matches a URI and HttpMethod. 
Author:
Graeme Rocher
Type parameters:
<T> – The target type
<R> – The return type
Since:
1.0/**
 * A {@link RouteMatch} that matches a URI and {@link HttpMethod}.
 *
 * @param <T> The target type
 * @param <R> The return type
 * @author Graeme Rocher
 * @since 1.0
 */
public interface UriRouteMatch<T, R> extends UriMatchInfo, MethodBasedRouteMatch<T, R> {

    
Returns:
The backing UriRoute/**
     * @return The backing {@link UriRoute}
     */
    UriRoute getRoute();

    
Returns the required arguments for this RouteMatch.

Note that this is not the save as ExecutionHandle.getArguments() as it will include a subset of the arguments excluding those that have been subtracted from the URI variables
Returns:
The required arguments in order to invoke this route/**
     * <p>Returns the required arguments for this RouteMatch.</p>
     * <p>
     * <p>Note that this is not the save as {@link #getArguments()} as it will include a subset of the arguments
     * excluding those that have been subtracted from the URI variables</p>
     *
     * @return The required arguments in order to invoke this route
     */
    @Override
    default List<Argument> getRequiredArguments() {
        Argument[] arguments = getArguments();
        if (ArrayUtils.isNotEmpty(arguments)) {
            Map<String, Object> matchVariables = getVariableValues();
            List<Argument> actualArguments = new ArrayList<>(arguments.length);
            for (Argument argument : arguments) {
                if (!matchVariables.containsKey(argument.getName())) {
                    actualArguments.add(argument);
                }
            }

            return actualArguments;
        }
        return Collections.emptyList();
    }

    
Returns:
The matched HTTP method/**
     * @return The matched HTTP method
     */
    HttpMethod getHttpMethod();

    @Override
    UriRouteMatch<T, R> fulfill(Map<String, Object> argumentValues);

    @Override
    UriRouteMatch<T, R> decorate(Function<RouteMatch<R>, R> executor);
}