BeanDefinitionBuilder (Spring Framework 5.1.19.RELEASE API)

java.lang.Object
- org.springframework.beans.factory.support.BeanDefinitionBuilder

```
public final class BeanDefinitionBuilder
extends Object
```
Programmatic means of constructing BeanDefinitions using the builder pattern. Intended primarily for use when implementing Spring 2.0 NamespaceHandlers.

Since:

2.0

Author:

Rod Johnson, Rob Harrop, Juergen Hoeller

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BeanDefinitionBuilder`	`addConstructorArgReference(String beanName)` Add a reference to a named bean as a constructor arg.
`BeanDefinitionBuilder`	`addConstructorArgValue(Object value)` Add an indexed constructor arg value.
`BeanDefinitionBuilder`	`addDependsOn(String beanName)` Append the specified bean name to the list of beans that this definition depends on.
`BeanDefinitionBuilder`	`addPropertyReference(String name, String beanName)` Add a reference to the specified bean name under the property specified.
`BeanDefinitionBuilder`	`addPropertyValue(String name, Object value)` Add the supplied property value under the given property name.
`BeanDefinitionBuilder`	`applyCustomizers(BeanDefinitionCustomizer... customizers)` Apply the given customizers to the underlying bean definition.
`static BeanDefinitionBuilder`	`childBeanDefinition(String parentName)` Create a new `BeanDefinitionBuilder` used to construct a `ChildBeanDefinition`.
`static BeanDefinitionBuilder`	`genericBeanDefinition()` Create a new `BeanDefinitionBuilder` used to construct a `GenericBeanDefinition`.
`static BeanDefinitionBuilder`	`genericBeanDefinition(Class<?> beanClass)` Create a new `BeanDefinitionBuilder` used to construct a `GenericBeanDefinition`.
`static <T> BeanDefinitionBuilder`	`genericBeanDefinition(Class<T> beanClass, Supplier<T> instanceSupplier)` Create a new `BeanDefinitionBuilder` used to construct a `GenericBeanDefinition`.
`static BeanDefinitionBuilder`	`genericBeanDefinition(String beanClassName)` Create a new `BeanDefinitionBuilder` used to construct a `GenericBeanDefinition`.
`AbstractBeanDefinition`	`getBeanDefinition()` Validate and return the created BeanDefinition object.
`AbstractBeanDefinition`	`getRawBeanDefinition()` Return the current BeanDefinition object in its raw (unvalidated) form.
`static BeanDefinitionBuilder`	`rootBeanDefinition(Class<?> beanClass)` Create a new `BeanDefinitionBuilder` used to construct a `RootBeanDefinition`.
`static BeanDefinitionBuilder`	`rootBeanDefinition(Class<?> beanClass, String factoryMethodName)` Create a new `BeanDefinitionBuilder` used to construct a `RootBeanDefinition`.
`static BeanDefinitionBuilder`	`rootBeanDefinition(String beanClassName)` Create a new `BeanDefinitionBuilder` used to construct a `RootBeanDefinition`.
`static BeanDefinitionBuilder`	`rootBeanDefinition(String beanClassName, String factoryMethodName)` Create a new `BeanDefinitionBuilder` used to construct a `RootBeanDefinition`.
`BeanDefinitionBuilder`	`setAbstract(boolean flag)` Set whether or not this definition is abstract.
`BeanDefinitionBuilder`	`setAutowireMode(int autowireMode)` Set the autowire mode for this definition.
`BeanDefinitionBuilder`	`setDependencyCheck(int dependencyCheck)` Set the dependency check mode for this definition.
`BeanDefinitionBuilder`	`setDestroyMethodName(String methodName)` Set the destroy method for this definition.
`BeanDefinitionBuilder`	`setFactoryMethod(String factoryMethod)` Set the name of a static factory method to use for this definition, to be called on this bean's class.
`BeanDefinitionBuilder`	`setFactoryMethodOnBean(String factoryMethod, String factoryBean)` Set the name of a non-static factory method to use for this definition, including the bean name of the factory instance to call the method on.
`BeanDefinitionBuilder`	`setInitMethodName(String methodName)` Set the init method for this definition.
`BeanDefinitionBuilder`	`setLazyInit(boolean lazy)` Set whether beans for this definition should be lazily initialized or not.
`BeanDefinitionBuilder`	`setParentName(String parentName)` Set the name of the parent definition of this bean definition.
`BeanDefinitionBuilder`	`setPrimary(boolean primary)` Set whether this bean is a primary autowire candidate.
`BeanDefinitionBuilder`	`setRole(int role)` Set the role of this definition.
`BeanDefinitionBuilder`	`setScope(String scope)` Set the scope of this definition.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - genericBeanDefinition
```
public static BeanDefinitionBuilder genericBeanDefinition()
```
    Create a new BeanDefinitionBuilder used to construct a GenericBeanDefinition.
  - genericBeanDefinition
```
public static BeanDefinitionBuilder genericBeanDefinition(String beanClassName)
```
    Create a new BeanDefinitionBuilder used to construct a GenericBeanDefinition.
    
    Parameters:
    
    beanClassName - the class name for the bean that the definition is being created for
  - genericBeanDefinition
```
public static BeanDefinitionBuilder genericBeanDefinition(Class<?> beanClass)
```
    Create a new BeanDefinitionBuilder used to construct a GenericBeanDefinition.
    
    Parameters:
    
    beanClass - the Class of the bean that the definition is being created for
  - genericBeanDefinition
```
public static <T> BeanDefinitionBuilder genericBeanDefinition(Class<T> beanClass,
                                                              Supplier<T> instanceSupplier)
```
    Create a new BeanDefinitionBuilder used to construct a GenericBeanDefinition.
    
    Parameters:
    
    beanClass - the Class of the bean that the definition is being created for
    
    instanceSupplier - a callback for creating an instance of the bean
    
    Since:
    
    5.0
  - rootBeanDefinition
```
public static BeanDefinitionBuilder rootBeanDefinition(String beanClassName)
```
    Create a new BeanDefinitionBuilder used to construct a RootBeanDefinition.
    
    Parameters:
    
    beanClassName - the class name for the bean that the definition is being created for
  - rootBeanDefinition
```
public static BeanDefinitionBuilder rootBeanDefinition(String beanClassName,
                                                       @Nullable
                                                       String factoryMethodName)
```
    Create a new BeanDefinitionBuilder used to construct a RootBeanDefinition.
    
    Parameters:
    
    beanClassName - the class name for the bean that the definition is being created for
    
    factoryMethodName - the name of the method to use to construct the bean instance
  - rootBeanDefinition
```
public static BeanDefinitionBuilder rootBeanDefinition(Class<?> beanClass)
```
    Create a new BeanDefinitionBuilder used to construct a RootBeanDefinition.
    
    Parameters:
    
    beanClass - the Class of the bean that the definition is being created for
  - rootBeanDefinition
```
public static BeanDefinitionBuilder rootBeanDefinition(Class<?> beanClass,
                                                       @Nullable
                                                       String factoryMethodName)
```
    Create a new BeanDefinitionBuilder used to construct a RootBeanDefinition.
    
    Parameters:
    
    beanClass - the Class of the bean that the definition is being created for
    
    factoryMethodName - the name of the method to use to construct the bean instance
  - childBeanDefinition
```
public static BeanDefinitionBuilder childBeanDefinition(String parentName)
```
    Create a new BeanDefinitionBuilder used to construct a ChildBeanDefinition.
    
    Parameters:
    
    parentName - the name of the parent bean
  - getRawBeanDefinition
```
public AbstractBeanDefinition getRawBeanDefinition()
```
    Return the current BeanDefinition object in its raw (unvalidated) form.
    
    See Also:
    
    getBeanDefinition()
  - getBeanDefinition
```
public AbstractBeanDefinition getBeanDefinition()
```
    Validate and return the created BeanDefinition object.
  - setParentName
```
public BeanDefinitionBuilder setParentName(String parentName)
```
    Set the name of the parent definition of this bean definition.
  - setFactoryMethod
```
public BeanDefinitionBuilder setFactoryMethod(String factoryMethod)
```
    Set the name of a static factory method to use for this definition, to be called on this bean's class.
  - setFactoryMethodOnBean
```
public BeanDefinitionBuilder setFactoryMethodOnBean(String factoryMethod,
                                                    String factoryBean)
```
    Set the name of a non-static factory method to use for this definition, including the bean name of the factory instance to call the method on.
    
    Parameters:
    
    factoryMethod - the name of the factory method
    
    factoryBean - the name of the bean to call the specified factory method on
    
    Since:
    
    4.3.6
  - addConstructorArgValue
```
public BeanDefinitionBuilder addConstructorArgValue(@Nullable
                                                    Object value)
```
    Add an indexed constructor arg value. The current index is tracked internally and all additions are at the present point.
  - addConstructorArgReference
```
public BeanDefinitionBuilder addConstructorArgReference(String beanName)
```
    Add a reference to a named bean as a constructor arg.
    
    See Also:
    
    addConstructorArgValue(Object)
  - addPropertyValue
```
public BeanDefinitionBuilder addPropertyValue(String name,
                                              @Nullable
                                              Object value)
```
    Add the supplied property value under the given property name.
  - addPropertyReference
```
public BeanDefinitionBuilder addPropertyReference(String name,
                                                  String beanName)
```
    Add a reference to the specified bean name under the property specified.
    
    Parameters:
    
    name - the name of the property to add the reference to
    
    beanName - the name of the bean being referenced
  - setInitMethodName
```
public BeanDefinitionBuilder setInitMethodName(@Nullable
                                               String methodName)
```
    Set the init method for this definition.
  - setDestroyMethodName
```
public BeanDefinitionBuilder setDestroyMethodName(@Nullable
                                                  String methodName)
```
    Set the destroy method for this definition.
  - setScope
```
public BeanDefinitionBuilder setScope(@Nullable
                                      String scope)
```
    Set the scope of this definition.
    
    See Also:
    
    BeanDefinition.SCOPE_SINGLETON, BeanDefinition.SCOPE_PROTOTYPE
  - setAbstract
```
public BeanDefinitionBuilder setAbstract(boolean flag)
```
    Set whether or not this definition is abstract.
  - setLazyInit
```
public BeanDefinitionBuilder setLazyInit(boolean lazy)
```
    Set whether beans for this definition should be lazily initialized or not.
  - setAutowireMode
```
public BeanDefinitionBuilder setAutowireMode(int autowireMode)
```
    Set the autowire mode for this definition.
  - setDependencyCheck
```
public BeanDefinitionBuilder setDependencyCheck(int dependencyCheck)
```
    Set the dependency check mode for this definition.
  - addDependsOn
```
public BeanDefinitionBuilder addDependsOn(String beanName)
```
    Append the specified bean name to the list of beans that this definition depends on.
  - setPrimary
```
public BeanDefinitionBuilder setPrimary(boolean primary)
```
    Set whether this bean is a primary autowire candidate.
    
    Since:
    
    5.1.11
  - setRole
```
public BeanDefinitionBuilder setRole(int role)
```
    Set the role of this definition.
  - applyCustomizers
```
public BeanDefinitionBuilder applyCustomizers(BeanDefinitionCustomizer... customizers)
```
    Apply the given customizers to the underlying bean definition.
    
    Since:
    
    5.0

Class BeanDefinitionBuilder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

genericBeanDefinition

genericBeanDefinition

genericBeanDefinition

genericBeanDefinition

rootBeanDefinition

rootBeanDefinition

rootBeanDefinition

rootBeanDefinition

childBeanDefinition

getRawBeanDefinition

getBeanDefinition

setParentName

setFactoryMethod

setFactoryMethodOnBean

addConstructorArgValue

addConstructorArgReference

addPropertyValue

addPropertyReference

setInitMethodName

setDestroyMethodName

setScope

setAbstract

setLazyInit

setAutowireMode

setDependencyCheck

addDependsOn

setPrimary

setRole

applyCustomizers