io.micronaut.http.bind.binders.AnnotatedRequestArgumentBinder Maven / Gradle / Ivy

Go to download

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

Natively Cloud Native

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.http.bind.binders;

import io.micronaut.core.bind.ArgumentBinder;
import io.micronaut.core.bind.annotation.AnnotatedArgumentBinder;
import io.micronaut.core.convert.ArgumentConversionContext;
import io.micronaut.http.HttpRequest;

import java.lang.annotation.Annotation;

/**
 * An interface for classes that bind an {@link io.micronaut.core.type.Argument} from an {@link HttpRequest} driven by
 * an annotation.
 *
 * @param  An annotation
 * @param  A type
 * @author Graeme Rocher
 * @see CookieAnnotationBinder
 * @see DefaultUnmatchedRequestArgumentBinder
 * @see HeaderAnnotationBinder
 * @see RequestAttributeAnnotationBinder
 * @since 1.0
 */
public interface AnnotatedRequestArgumentBinder extends RequestArgumentBinder, AnnotatedArgumentBinder> {

    /**
     * Create a binder from an annotation type and another binder.
     *
     * @param annotationType The annotation type
     * @param binder         The binder
     * @param            The annotation generic type
     * @param            The argument type
     * @return The {@link AnnotatedRequestArgumentBinder}
     */
    static  AnnotatedRequestArgumentBinder of(Class annotationType, ArgumentBinder> binder) {
        return new AnnotatedRequestArgumentBinder() {

            @Override
            public BindingResult bind(ArgumentConversionContext argument, HttpRequest source) {
                return binder.bind(argument, source);
            }

            @Override
            public Class getAnnotationType() {
                return annotationType;
            }
        };
    }
}