io.micronaut.web.router.UriRouteMatch Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of micronaut-router Show documentation

Core components supporting the Micronaut Framework

The newest version!

/*
 * 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.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Map;

/**
 * A {@link RouteMatch} that matches a URI and {@link HttpMethod}.
 *
 * @param  The target type
 * @param  The return type
 * @author Graeme Rocher
 * @since 1.0
 */
public interface UriRouteMatch extends UriMatchInfo, MethodBasedRouteMatch {

    /**
     * @return The backing {@link UriRouteInfo}
     */
    @Override
    UriRouteInfo getRouteInfo();

    /**
     * Returns the required arguments for this RouteMatch.
     *
     * 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
     *
     * @return The required arguments in order to invoke this route
     */
    @Override
    default List> getRequiredArguments() {
        Argument[] arguments = getArguments();
        if (ArrayUtils.isNotEmpty(arguments)) {
            Map matchVariables = getVariableValues();
            List> actualArguments = new ArrayList<>(arguments.length);
            for (Argument argument : arguments) {
                if (!matchVariables.containsKey(argument.getName())) {
                    actualArguments.add(argument);
                }
            }

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

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

}