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.test.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.boot.autoconfigure.EnableAutoConfiguration;
026import org.springframework.boot.autoconfigure.ImportAutoConfiguration;
027
028/**
029 * Annotation that can be used to override
030 * {@link EnableAutoConfiguration @EnableAutoConfiguration}. Often used in combination
031 * with {@link ImportAutoConfiguration} to limit the auto-configuration classes that are
032 * loaded.
033 *
034 * @author Phillip Webb
035 * @since 1.4.0
036 * @see EnableAutoConfiguration#ENABLED_OVERRIDE_PROPERTY
037 */
038@Target(ElementType.TYPE)
039@Retention(RetentionPolicy.RUNTIME)
040@Documented
041public @interface OverrideAutoConfiguration {
042
043        /**
044         * The value of the {@link EnableAutoConfiguration#ENABLED_OVERRIDE_PROPERTY enabled
045         * override property}.
046         * @return the override value
047         */
048        boolean enabled();
049
050}