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