001/* 002 * Copyright 2002-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 * https://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.stereotype; 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 025/** 026 * Indicates that an annotated class is a "component". 027 * Such classes are considered as candidates for auto-detection 028 * when using annotation-based configuration and classpath scanning. 029 * 030 * <p>Other class-level annotations may be considered as identifying 031 * a component as well, typically a special kind of component: 032 * e.g. the {@link Repository @Repository} annotation or AspectJ's 033 * {@link org.aspectj.lang.annotation.Aspect @Aspect} annotation. 034 * 035 * @author Mark Fisher 036 * @since 2.5 037 * @see Repository 038 * @see Service 039 * @see Controller 040 * @see org.springframework.context.annotation.ClassPathBeanDefinitionScanner 041 */ 042@Target(ElementType.TYPE) 043@Retention(RetentionPolicy.RUNTIME) 044@Documented 045public @interface Component { 046 047 /** 048 * The value may indicate a suggestion for a logical component name, 049 * to be turned into a Spring bean in case of an autodetected component. 050 * @return the suggested component name, if any (or empty String otherwise) 051 */ 052 String value() default ""; 053 054}