001/*
002 * Copyright 2012-2017 the original author or authors.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *      http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package org.springframework.boot.autoconfigure;
018
019import java.lang.annotation.Documented;
020import java.lang.annotation.ElementType;
021import java.lang.annotation.Retention;
022import java.lang.annotation.RetentionPolicy;
023import java.lang.annotation.Target;
024
025import org.springframework.context.annotation.AnnotationConfigApplicationContext;
026import org.springframework.core.Ordered;
027import org.springframework.core.annotation.Order;
028
029/**
030 * Auto-configuration specific variant of Spring Framework's {@link Order} annotation.
031 * Allows auto-configuration classes to be ordered among themselves without affecting the
032 * order of configuration classes passed to
033 * {@link AnnotationConfigApplicationContext#register(Class...)}.
034 *
035 * @author Andy Wilkinson
036 * @since 1.3.0
037 */
038@Retention(RetentionPolicy.RUNTIME)
039@Target({ ElementType.TYPE, ElementType.METHOD, ElementType.FIELD })
040@Documented
041public @interface AutoConfigureOrder {
042
043        int DEFAULT_ORDER = 0;
044
045        /**
046         * The order value. Default is {@code 0}.
047         * @see Ordered#getOrder()
048         * @return the order value
049         */
050        int value() default DEFAULT_ORDER;
051
052}