diff --git a/spring-context/src/main/java/org/springframework/context/annotation/Scope.java b/spring-context/src/main/java/org/springframework/context/annotation/Scope.java index 2e556f51878..c9c45f83d9b 100644 --- a/spring-context/src/main/java/org/springframework/context/annotation/Scope.java +++ b/spring-context/src/main/java/org/springframework/context/annotation/Scope.java @@ -1,5 +1,5 @@ /* - * Copyright 2002-2012 the original author or authors. + * Copyright 2002-2015 the original author or authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -23,30 +23,33 @@ import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; import org.springframework.beans.factory.config.ConfigurableBeanFactory; -import org.springframework.stereotype.Component; /** - * When used as a type-level annotation in conjunction with the {@link Component} - * annotation, indicates the name of a scope to use for instances of the annotated - * type. + * When used as a type-level annotation in conjunction with + * {@link org.springframework.stereotype.Component @Component}, + * {@code @Scope} indicates the name of a scope to use for instances of + * the annotated type. * - *

When used as a method-level annotation in conjunction with the - * {@link Bean} annotation, indicates the name of a scope to use for - * the instance returned from the method. + *

When used as a method-level annotation in conjunction with + * {@link Bean @Bean}, {@code @Scope} indicates the name of a scope to use + * for the instance returned from the method. * - *

In this context, scope means the lifecycle of an instance, such as - * {@code singleton}, {@code prototype}, and so forth. Scopes provided out of the box in - * Spring may be referred to using the {@code SCOPE_*} constants available in - * via {@link ConfigurableBeanFactory} and {@code WebApplicationContext} interfaces. + *

In this context, scope means the lifecycle of an instance, + * such as {@code singleton}, {@code prototype}, and so forth. Scopes + * provided out of the box in Spring may be referred to using the + * {@code SCOPE_*} constants available in the {@link ConfigurableBeanFactory} + * and {@code WebApplicationContext} interfaces. * *

To register additional custom scopes, see - * {@link org.springframework.beans.factory.config.CustomScopeConfigurer CustomScopeConfigurer}. + * {@link org.springframework.beans.factory.config.CustomScopeConfigurer + * CustomScopeConfigurer}. * * @author Mark Fisher * @author Chris Beams + * @author Sam Brannen * @since 2.5 - * @see Component - * @see Bean + * @see org.springframework.stereotype.Component + * @see org.springframework.context.annotation.Bean */ @Target({ElementType.TYPE, ElementType.METHOD}) @Retention(RetentionPolicy.RUNTIME) @@ -55,6 +58,7 @@ public @interface Scope { /** * Specifies the scope to use for the annotated component/bean. + *

Defaults to {@link ConfigurableBeanFactory#SCOPE_SINGLETON SCOPE_SINGLETON}. * @see ConfigurableBeanFactory#SCOPE_SINGLETON * @see ConfigurableBeanFactory#SCOPE_PROTOTYPE * @see org.springframework.web.context.WebApplicationContext#SCOPE_REQUEST @@ -65,9 +69,11 @@ public @interface Scope { /** * Specifies whether a component should be configured as a scoped proxy * and if so, whether the proxy should be interface-based or subclass-based. - *

Defaults to {@link ScopedProxyMode#NO}, indicating that no scoped - * proxy should be created. + *

Defaults to {@link ScopedProxyMode#DEFAULT}, which typically indicates + * that no scoped proxy should be created unless a different default + * has been configured at the component-scan instruction level. *

Analogous to {@code } support in Spring XML. + * @see ScopedProxyMode */ ScopedProxyMode proxyMode() default ScopedProxyMode.DEFAULT;