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 "Controller" (e.g. a web controller).
027 *
028 * <p>This annotation serves as a specialization of {@link Component @Component},
029 * allowing for implementation classes to be autodetected through classpath scanning.
030 * It is typically used in combination with annotated handler methods based on the
031 * {@link org.springframework.web.bind.annotation.RequestMapping} annotation.
032 *
033 * @author Arjen Poutsma
034 * @author Juergen Hoeller
035 * @since 2.5
036 * @see Component
037 * @see org.springframework.web.bind.annotation.RequestMapping
038 * @see org.springframework.context.annotation.ClassPathBeanDefinitionScanner
039 */
040@Target({ElementType.TYPE})
041@Retention(RetentionPolicy.RUNTIME)
042@Documented
043@Component
044public @interface Controller {
045
046        /**
047         * The value may indicate a suggestion for a logical component name,
048         * to be turned into a Spring bean in case of an autodetected component.
049         * @return the suggested component name, if any (or empty String otherwise)
050         */
051        String value() default "";
052
053}