/*
 * 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.annotation;

import io.micronaut.http.HttpMethod;

import java.lang.annotation.*;

Stereotype annotation that helps to link together instance of the filter and http client that filter should be applied to. In order to use you will need to create new annotation and apply FilterMatcher on it. After that apply newly created annotation on both instance of the http filter and instance of a http client. 

Example:
 @FilterMatcher public @interface Metered { ... } 
Author:
svishnyakoff, James Kleeh, graemerocher
@Metered

public class MeteredHttpFilter implements HttpClientFilter {
    ....
}
@Metered

private HttpClient httpClient;
} In the example above only clients annotated with @Metered annotations are going to be filtered by MeteredHttpFilter
Since:
1.3.0/**
 * Stereotype annotation that helps to link together instance of the filter and http client that filter should be applied to.
 *
 * In order to use you will need to create new annotation and apply {@link FilterMatcher} on it. After that apply newly
 * created annotation on both instance of the http filter and instance of a http client.
 *
 * <pre>{@code
 * Example:
 *
 * @FilterMatcher
 * public @interface Metered {
 *     ...
 * }
 *
 * @Metered
 * public class MeteredHttpFilter implements HttpClientFilter {
 *     ....
 * }
 *
 * @Metered
 * private HttpClient httpClient;
 * }</pre>
 *
 * In the example above only clients annotated with {@code @Metered} annotations are going to be filtered by MeteredHttpFilter
 *
 * @author svishnyakoff
 * @author James Kleeh
 * @author graemerocher
 * @since 1.3.0
 */
@Documented
@Target({ElementType.ANNOTATION_TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface FilterMatcher {

    
The name of this annotation.
/**
     * The name of this annotation.
     */
    String NAME = FilterMatcher.class.getName();

    
Returns:
The methods to match. Defaults to all/**
     * @return The methods to match. Defaults to all
     */
    HttpMethod[] methods() default {};
}