Class BeanOverrideHandler

java.lang.Object

org.springframework.test.context.bean.override.BeanOverrideHandler

public abstract class BeanOverrideHandler
extends Object

Handler for Bean Override injection points that is responsible for creating the bean override instance for a given set of metadata and potentially for tracking the created instance.

WARNING: Implementations are used as a cache key and must implement proper equals() and hashCode() methods based on the unique set of metadata used to identify the bean to override. Overridden equals() and hashCode() methods should also delegate to the super implementations in this class in order to support the basic metadata used by all bean overrides. In addition, it is recommended that implementations override toString() to include all relevant metadata in order to enhance diagnostics.

Concrete implementations of BeanOverrideHandler can store additional metadata to use during override instance creation — for example, based on further processing of the annotation, the annotated field, or the annotated class.

Singleton Semantics

When replacing a non-singleton bean, the non-singleton bean will be replaced with a singleton bean corresponding to bean override instance created by the handler, and the corresponding bean definition will be converted to a singleton. Consequently, if a handler overrides a prototype or custom scoped bean, the overridden bean will be treated as a singleton.

When replacing a bean created by a FactoryBean, the FactoryBean itself will be replaced with a singleton bean corresponding to bean override instance created by the handler.

When wrapping a bean created by a FactoryBean, the object created by the FactoryBean will be wrapped, not the FactoryBean itself.

Since:

6.2

Author:

Simon Baslé, Stephane Nicoll, Sam Brannen

See Also:

• BeanOverrideStrategy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BeanOverrideHandler(@Nullable Field field, ResolvableType beanType, @Nullable String beanName, String contextName, BeanOverrideStrategy strategy)	Construct a new BeanOverrideHandler from the supplied values.
protected	BeanOverrideHandler(@Nullable Field field, ResolvableType beanType, @Nullable String beanName, BeanOverrideStrategy strategy)	Deprecated, for removal: This API element is subject to removal in a future version. As of Spring Framework 6.2.6, in favor of BeanOverrideHandler(Field, ResolvableType, String, String, BeanOverrideStrategy)

Method Summary

Modifier and Type	Method	Description
protected abstract Object	createOverrideInstance(String beanName, @Nullable BeanDefinition existingBeanDefinition, @Nullable Object existingBeanInstance)	Create a bean override instance for an existing BeanDefinition or an existing singleton bean, based on the metadata in this BeanOverrideHandler.
boolean	equals(Object other)
static List<BeanOverrideHandler>	forTestClass(Class<?> testClass)	Process the given testClass and build the corresponding BeanOverrideHandler list derived from @BeanOverride fields in the test class and its type hierarchy.
final @Nullable String	getBeanName()	Get the bean name to override, or null to look for a single matching bean of type getBeanType().
final ResolvableType	getBeanType()	Get the bean type to override.
final String	getContextName()	Get the name of the context hierarchy level in which this handler should be applied.
final @Nullable Field	getField()	Get the Field annotated with @BeanOverride.
final BeanOverrideStrategy	getStrategy()	Get the BeanOverrideStrategy for this BeanOverrideHandler, which influences how and when the bean override instance should be created.
int	hashCode()
String	toString()
protected void	trackOverrideInstance(Object override, SingletonBeanRegistry singletonBeanRegistry)	Track the supplied bean override instance that was created by this BeanOverrideHandler.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

BeanOverrideHandler

@Deprecated(since="6.2.6",
            forRemoval=true)
protected BeanOverrideHandler(@Nullable Field field,
 ResolvableType beanType,
 @Nullable String beanName,
 BeanOverrideStrategy strategy)

Deprecated, for removal: This API element is subject to removal in a future version.

As of Spring Framework 6.2.6, in favor of BeanOverrideHandler(Field, ResolvableType, String, String, BeanOverrideStrategy)

Construct a new BeanOverrideHandler from the supplied values.

To provide proper support for @ContextHierarchy, invoke BeanOverrideHandler(Field, ResolvableType, String, String, BeanOverrideStrategy) instead.

Parameters:

field - the Field annotated with @BeanOverride, or null if @BeanOverride was declared at the type level

beanType - the type of bean to override

beanName - the name of the bean to override, or null to look for a single matching bean by type

strategy - the BeanOverrideStrategy to use

BeanOverrideHandler

protected BeanOverrideHandler(@Nullable Field field,
 ResolvableType beanType,
 @Nullable String beanName,
 String contextName,
 BeanOverrideStrategy strategy)

Construct a new BeanOverrideHandler from the supplied values.

Parameters:

field - the Field annotated with @BeanOverride, or null if @BeanOverride was declared at the type level

beanType - the type of bean to override

beanName - the name of the bean to override, or null to look for a single matching bean by type

contextName - the name of the context hierarchy level in which the handler should be applied, or an empty string to indicate that the handler should be applied to all application contexts within a context hierarchy

strategy - the BeanOverrideStrategy to use

Since:

6.2.6

Method Details

forTestClass

public static List<BeanOverrideHandler> forTestClass(Class<?> testClass)

Process the given testClass and build the corresponding BeanOverrideHandler list derived from @BeanOverride fields in the test class and its type hierarchy.

This method does not search the enclosing class hierarchy and does not search for @BeanOverride declarations on classes or interfaces.

Parameters:

testClass - the test class to process

Returns:

a list of bean override handlers

See Also:

• findAllHandlers(Class)

getField

public final @Nullable Field getField()

Get the Field annotated with @BeanOverride.

getBeanType

public final ResolvableType getBeanType()

Get the bean type to override.

getBeanName

public final @Nullable String getBeanName()

Get the bean name to override, or null to look for a single matching bean of type getBeanType().

getContextName

public final String getContextName()

Get the name of the context hierarchy level in which this handler should be applied.

An empty string indicates that this handler should be applied to all application contexts.

If a context name is configured for this handler, it must match a name configured via @ContextConfiguration(name=...).

Since:

6.2.6

See Also:

• @ContextHierarchy
• ContextConfiguration.name()

getStrategy

public final BeanOverrideStrategy getStrategy()

Get the BeanOverrideStrategy for this BeanOverrideHandler, which influences how and when the bean override instance should be created.

createOverrideInstance

protected abstract Object createOverrideInstance(String beanName,
 @Nullable BeanDefinition existingBeanDefinition,
 @Nullable Object existingBeanInstance)

Create a bean override instance for an existing BeanDefinition or an existing singleton bean, based on the metadata in this BeanOverrideHandler.

Parameters:

beanName - the name of the bean being overridden

existingBeanDefinition - an existing bean definition for the supplied bean name, or null if not available or not relevant

existingBeanInstance - an existing instance for the supplied bean name for wrapping purposes, or null if not available or not relevant

Returns:

the instance with which to override the bean

See Also:

• trackOverrideInstance(Object, SingletonBeanRegistry)

trackOverrideInstance

protected void trackOverrideInstance(Object override,
 SingletonBeanRegistry singletonBeanRegistry)

Track the supplied bean override instance that was created by this BeanOverrideHandler.

The default implementation does not track the supplied instance, but this can be overridden in subclasses as appropriate.

Parameters:

override - the bean override instance to track

singletonBeanRegistry - a registry in which this handler can store tracking state in the form of a singleton bean

See Also:

• createOverrideInstance(String, BeanDefinition, Object)

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object