/*
 * Copyright 2002-2017 the original author or 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
 *
 *      http://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 org.springframework.web.reactive.config;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import org.springframework.context.annotation.Import;

/**
 * Adding this annotation to an {@code @Configuration} class imports the Spring Web
 * Reactive configuration from {@link WebFluxConfigurationSupport}, e.g.:
 *
 * <pre class="code">
 * @Configuration
 * @EnableWebFlux
 * @ComponentScan(basePackageClasses = MyConfiguration.class)
 * public class MyConfiguration {
 * }
 * </pre>
 *
 * <p>To customize the imported configuration implement
 * {@link WebFluxConfigurer} and override individual methods as shown below:
 *
 * <pre class="code">
 * @Configuration
 * @EnableWebFlux
 * @ComponentScan(basePackageClasses = MyConfiguration.class)
 * public class MyConfiguration implements WebFluxConfigurer {
 *
 * 	   @Override
 * 	   public void addFormatters(FormatterRegistry formatterRegistry) {
 *         formatterRegistry.addConverter(new MyConverter());
 * 	   }
 *
 * 	   @Override
 * 	   public void configureMessageWriters(List<HttpMessageWriter<?>> messageWriters) {
 *         messageWriters.add(new MyHttpMessageWriter());
 * 	   }
 * }
 * </pre>
 *
 * <p><strong>Note:</strong> only one {@code @Configuration} class may have the
 * {@code @EnableWebFlux} annotation to import the Spring WebFlux configuration.
 * There can however be multiple {@code @Configuration} classes implementing
 * {@code WebFluxConfigurer} in order to customize the provided configuration.
 *
 * <p>If {@link WebFluxConfigurer} does not expose some more advanced setting
 * that needs to be configured consider removing the {@code @EnableWebFlux}
 * annotation and extending directly from {@link WebFluxConfigurationSupport}
 * or {@link DelegatingWebFluxConfiguration} if you still want to allow
 * {@link WebFluxConfigurer} instances to customize the configuration.
 *
 * @author Brian Clozel
 * @author Rossen Stoyanchev
 * @since 5.0
 * @see WebFluxConfigurer
 * @see WebFluxConfigurationSupport
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Documented
@Import(DelegatingWebFluxConfiguration.class)
public @interface EnableWebFlux {
}