org.springframework.boot.autoconfigure.AutoConfigureOrder Maven / Gradle / Ivy
/*
* Copyright 2012-2020 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
*
* 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 org.springframework.boot.autoconfigure;
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.AnnotationConfigApplicationContext;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.DependsOn;
import org.springframework.core.Ordered;
import org.springframework.core.annotation.Order;
/**
* Auto-configuration specific variant of Spring Framework's {@link Order @Order}
* annotation. Allows auto-configuration classes to be ordered among themselves without
* affecting the order of configuration classes passed to
* {@link AnnotationConfigApplicationContext#register(Class...)}.
*
* As with standard {@link Configuration @Configuration} classes, the order in which
* auto-configuration classes are applied only affects the order in which their beans are
* defined. The order in which those beans are subsequently created is unaffected and is
* determined by each bean's dependencies and any {@link DependsOn @DependsOn}
* relationships.
*
* @author Andy Wilkinson
* @since 1.3.0
*/
@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.TYPE, ElementType.METHOD, ElementType.FIELD })
@Documented
public @interface AutoConfigureOrder {
/**
* The default order value.
*/
int DEFAULT_ORDER = 0;
/**
* The order value. Default is {@code 0}.
* @see Ordered#getOrder()
* @return the order value
*/
int value() default DEFAULT_ORDER;
}