Package org.springframework.beans.factory.generator.config

Class BeanDefinitionRegistrar

java.lang.Object

org.springframework.beans.factory.generator.config.BeanDefinitionRegistrar

public final class BeanDefinitionRegistrar
extends Object

BeanDefinition registration mechanism offering transparent dependency resolution, as well as exception management.

Used by code generators and for internal use within the framework only.

Since:

6.0

Author:

Stephane Nicoll

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
final class	BeanDefinitionRegistrar.BeanInstanceContext	Callback interface used by instance suppliers that need to resolve dependencies for the Executable used to create the instance as well as any Member that should be handled by the context.
static interface	BeanDefinitionRegistrar.ThrowableConsumer<T>	A Consumer that allows to invoke code that throws a checked exception.
static interface	BeanDefinitionRegistrar.ThrowableFunction<T,R>	A Function that allows to invoke code that throws a checked exception.
static interface	BeanDefinitionRegistrar.ThrowableSupplier<T>	A Supplier that allows to invoke code that throws a checked exception.

Method Summary

Modifier and Type	Method	Description
BeanDefinitionRegistrar	customize(BeanDefinitionRegistrar.ThrowableConsumer<RootBeanDefinition> bd)	Customize the RootBeanDefinition using the specified consumer.
static BeanDefinitionRegistrar	inner(Class<?> beanType)	Initialize the registration of an inner bean with the specified type.
static BeanDefinitionRegistrar	inner(ResolvableType beanType)	Initialize the registration of an inner bean with the specified type.
BeanDefinitionRegistrar	instanceSupplier(BeanDefinitionRegistrar.ThrowableFunction<BeanDefinitionRegistrar.BeanInstanceContext,?> instanceContext)	Specify how the bean instance should be created and initialized, using the BeanDefinitionRegistrar.BeanInstanceContext to resolve dependencies if necessary.
BeanDefinitionRegistrar	instanceSupplier(BeanDefinitionRegistrar.ThrowableSupplier<?> instanceSupplier)	Specify how the bean instance should be created and initialized.
static BeanDefinitionRegistrar	of(String beanName, Class<?> beanType)	Initialize the registration of a bean with the specified name and type.
static BeanDefinitionRegistrar	of(String beanName, ResolvableType beanType)	Initialize the registration of a bean with the specified name and type.
void	register(DefaultListableBeanFactory beanFactory)	Register the RootBeanDefinition defined by this instance to the specified bean factory.
RootBeanDefinition	toBeanDefinition()	Return the RootBeanDefinition defined by this instance.
BeanDefinitionRegistrar	withConstructor(Class<?>... parameterTypes)	Specify the constructor to use to instantiate the bean.
BeanDefinitionRegistrar	withFactoryMethod(Class<?> declaredType, String name, Class<?>... parameterTypes)	Specify the factory method to use to instantiate the bean.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

of

public static BeanDefinitionRegistrar of(String beanName,
 ResolvableType beanType)

Initialize the registration of a bean with the specified name and type.

Parameters:

beanName - the name of the bean

beanType - the type of the bean

Returns:

a registrar for the specified bean

of

public static BeanDefinitionRegistrar of(String beanName,
 Class<?> beanType)

Initialize the registration of a bean with the specified name and type.

Parameters:

beanName - the name of the bean

beanType - the type of the bean

Returns:

a registrar for the specified bean

inner

public static BeanDefinitionRegistrar inner(ResolvableType beanType)

Initialize the registration of an inner bean with the specified type.

Parameters:

beanType - the type of the inner bean

Returns:

a registrar for the specified inner bean

inner

public static BeanDefinitionRegistrar inner(Class<?> beanType)

Initialize the registration of an inner bean with the specified type.

Parameters:

beanType - the type of the inner bean

Returns:

a registrar for the specified inner bean

withFactoryMethod

public BeanDefinitionRegistrar withFactoryMethod(Class<?> declaredType,
 String name,
 Class<?>... parameterTypes)

Specify the factory method to use to instantiate the bean.

Parameters:

declaredType - the declared type of the factory method.

name - the name of the method

parameterTypes - the parameter types of the method

Returns:

this, to facilitate method chaining

See Also:

• RootBeanDefinition.getResolvedFactoryMethod()

withConstructor

public BeanDefinitionRegistrar withConstructor(Class<?>... parameterTypes)

Specify the constructor to use to instantiate the bean.

Parameters:

parameterTypes - the parameter types of the constructor

Returns:

this, to facilitate method chaining

instanceSupplier

public BeanDefinitionRegistrar instanceSupplier(BeanDefinitionRegistrar.ThrowableFunction<BeanDefinitionRegistrar.BeanInstanceContext,?> instanceContext)

Specify how the bean instance should be created and initialized, using the BeanDefinitionRegistrar.BeanInstanceContext to resolve dependencies if necessary.

Parameters:

instanceContext - the BeanDefinitionRegistrar.BeanInstanceContext to use

Returns:

this, to facilitate method chaining

instanceSupplier

public BeanDefinitionRegistrar instanceSupplier(BeanDefinitionRegistrar.ThrowableSupplier<?> instanceSupplier)

Specify how the bean instance should be created and initialized.

Returns:

this, to facilitate method chaining

customize

public BeanDefinitionRegistrar customize(BeanDefinitionRegistrar.ThrowableConsumer<RootBeanDefinition> bd)

Customize the RootBeanDefinition using the specified consumer.

Parameters:

bd - a consumer for the bean definition

Returns:

this, to facilitate method chaining

register

public void register(DefaultListableBeanFactory beanFactory)

Register the RootBeanDefinition defined by this instance to the specified bean factory.

Parameters:

beanFactory - the bean factory to use

toBeanDefinition

public RootBeanDefinition toBeanDefinition()

Return the RootBeanDefinition defined by this instance.

Returns:

the bean definition