001/*
002 * Copyright 2012-2016 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.context;
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.context.TypeExcludeFilter;
026import org.springframework.context.annotation.ComponentScan;
027import org.springframework.stereotype.Component;
028
029/**
030 * {@link Component @Component} that can be used when a bean is intended only for tests,
031 * and should be excluded from Spring Boot's component scanning.
032 * <p>
033 * Note that if you directly use {@link ComponentScan @ComponentScan} rather than relying
034 * on {@code @SpringBootApplication} you should ensure that a {@link TypeExcludeFilter} is
035 * declared as an {@link ComponentScan#excludeFilters() excludeFilter}.
036 *
037 * @author Phillip Webb
038 * @since 1.4.0
039 * @see TypeExcludeFilter
040 * @see TestConfiguration
041 */
042@Target(ElementType.TYPE)
043@Retention(RetentionPolicy.RUNTIME)
044@Documented
045@Component
046public @interface TestComponent {
047
048        /**
049         * The value may indicate a suggestion for a logical component name, to be turned into
050         * a Spring bean in case of an auto-detected component.
051         * @return the specified bean name, if any
052         */
053        String value() default "";
054
055}