Spring Framework 6.1.4 · org.springframework.beans.factory.config.BeanDefinition

Modifier and Type	Field and Description
public static final int	ROLE_APPLICATION Role hint indicating that a `BeanDefinition` is a major part of the application.
public static final int	ROLE_INFRASTRUCTURE Role hint indicating that a `BeanDefinition` is providing an entirely background role and has no relevance to the end-user.
public static final int	ROLE_SUPPORT Role hint indicating that a `BeanDefinition` is a supporting part of some larger configuration, typically an outer `org.springframework.beans.factory.parsing.ComponentDefinition`.
public static final String	SCOPE_PROTOTYPE Scope identifier for the standard prototype scope: prototype.
public static final String	SCOPE_SINGLETON Scope identifier for the standard singleton scope: singleton.

Method Summary

Modifier and Type	Method and Description
public String	getBeanClassName() Return the current bean class name of this bean definition.
public ConstructorArgumentValues	Returns: the ConstructorArgumentValues object (never `null`) getConstructorArgumentValues() Return the constructor argument values for this bean.
public String[]	getDependsOn() Return the bean names that this bean depends on.
public String	getDescription() Return a human-readable description of this bean definition.
public String	getDestroyMethodName() Return the name of the destroy method.
public String	getFactoryBeanName() Return the factory bean name, if any.
public String	getFactoryMethodName() Return a factory method, if any.
public String	getInitMethodName() Return the name of the initializer method.
public BeanDefinition	getOriginatingBeanDefinition() Return the originating BeanDefinition, or `null` if none.
public String	getParentName() Return the name of the parent definition of this bean definition, if any.
public MutablePropertyValues	Returns: the MutablePropertyValues object (never `null`) getPropertyValues() Return the property values to be applied to a new instance of the bean.
public ResolvableType	Returns: the resolvable type (potentially `ResolvableType#NONE`) getResolvableType() Return a resolvable type for this bean definition, based on the bean class or other specific metadata.
public String	getResourceDescription() Return a description of the resource that this bean definition came from (for the purpose of showing context in case of errors).
public int	getRole() Get the role hint for this `BeanDefinition`.
public String	getScope() Return the name of the current target scope for this bean, or `null` if not known yet.
public default boolean	hasConstructorArgumentValues() Return if there are constructor argument values defined for this bean.
public default boolean	hasPropertyValues() Return if there are property values defined for this bean.
public boolean	isAbstract() Return whether this bean is "abstract", that is, not meant to be instantiated.
public boolean	isAutowireCandidate() Return whether this bean is a candidate for getting autowired into some other bean.
public boolean	isLazyInit() Return whether this bean should be lazily initialized, i.e. not eagerly instantiated on startup.
public boolean	isPrimary() Return whether this bean is a primary autowire candidate.
public boolean	isPrototype() Return whether this a Prototype, with an independent instance returned for each call.
public boolean	isSingleton() Return whether this a Singleton, with a single, shared instance returned on all calls.
public void	setAutowireCandidate(boolean autowireCandidate) Set whether this bean is a candidate for getting autowired into some other bean.
public void	setBeanClassName(String beanClassName) Specify the bean class name of this bean definition.
public void	setDependsOn(String... dependsOn) Set the names of the beans that this bean depends on being initialized.
public void	setDescription(String description) Set a human-readable description of this bean definition.
public void	setDestroyMethodName(String destroyMethodName) Set the name of the destroy method.
public void	setFactoryBeanName(String factoryBeanName) Specify the factory bean to use, if any.
public void	setFactoryMethodName(String factoryMethodName) Specify a factory method, if any.
public void	setInitMethodName(String initMethodName) Set the name of the initializer method.
public void	setLazyInit(boolean lazyInit) Set whether this bean should be lazily initialized.
public void	setParentName(String parentName) Set the name of the parent definition of this bean definition, if any.
public void	setPrimary(boolean primary) Set whether this bean is a primary autowire candidate.
public void	setRole(int role) Set the role hint for this `BeanDefinition`.
public void	setScope(String scope) Override the target scope of this bean, specifying a new scope name.

Inherited from org.springframework.beans.BeanMetadataElement:: getSource
Inherited from org.springframework.core.AttributeAccessor:: attributeNames computeAttribute getAttribute hasAttribute removeAttribute setAttribute

Field Detail

ROLE_APPLICATION	back to summary
public static final int ROLE_APPLICATION Role hint indicating that a `BeanDefinition` is a major part of the application. Typically corresponds to a user-defined bean.

ROLE_INFRASTRUCTURE	back to summary
public static final int ROLE_INFRASTRUCTURE Role hint indicating that a `BeanDefinition` is providing an entirely background role and has no relevance to the end-user. This hint is used when registering beans that are completely part of the internal workings of a `org.springframework.beans.factory.parsing.ComponentDefinition`.

ROLE_SUPPORT back to summary

ROLE_SUPPORT	back to summary
public static final int ROLE_SUPPORT Role hint indicating that a `BeanDefinition` is a supporting part of some larger configuration, typically an outer `org.springframework.beans.factory.parsing.ComponentDefinition`. `SUPPORT` beans are considered important enough to be aware of when looking more closely at a particular `org.springframework.beans.factory.parsing.ComponentDefinition`, but not when looking at the overall configuration of an application.

public static final int ROLE_SUPPORT

Role hint indicating that a BeanDefinition is a supporting part of some larger configuration, typically an outer org.springframework.beans.factory.parsing.ComponentDefinition. SUPPORT beans are considered important enough to be aware of when looking more closely at a particular org.springframework.beans.factory.parsing.ComponentDefinition, but not when looking at the overall configuration of an application.

SCOPE_PROTOTYPE back to summary

SCOPE_PROTOTYPE	back to summary
public static final String SCOPE_PROTOTYPE Scope identifier for the standard prototype scope: prototype. Note that extended bean factories might support further scopes. See Also `setScope`, `ConfigurableBeanFactory#SCOPE_PROTOTYPE`

public static final String SCOPE_PROTOTYPE

Scope identifier for the standard prototype scope: prototype.

Note that extended bean factories might support further scopes.

See Also: setScope, ConfigurableBeanFactory#SCOPE_PROTOTYPE

SCOPE_SINGLETON back to summary

SCOPE_SINGLETON	back to summary
public static final String SCOPE_SINGLETON Scope identifier for the standard singleton scope: singleton. Note that extended bean factories might support further scopes. See Also `setScope`, `ConfigurableBeanFactory#SCOPE_SINGLETON`

public static final String SCOPE_SINGLETON

Scope identifier for the standard singleton scope: singleton.

Note that extended bean factories might support further scopes.

See Also: setScope, ConfigurableBeanFactory#SCOPE_SINGLETON

Method Detail

getBeanClassName back to summary

getBeanClassName	back to summary
public String getBeanClassName() Return the current bean class name of this bean definition. Note that this does not have to be the actual class name used at runtime, in case of a child definition overriding/inheriting the class name from its parent. Also, this may just be the class that a factory method is called on, or it may even be empty in case of a factory bean reference that a method is called on. Hence, do not consider this to be the definitive bean type at runtime but rather only use it for parsing purposes at the individual bean definition level. Annotations @Nullable See Also `getParentName()`, `getFactoryBeanName()`, `getFactoryMethodName()`

public String getBeanClassName()

Return the current bean class name of this bean definition.

Note that this does not have to be the actual class name used at runtime, in case of a child definition overriding/inheriting the class name from its parent. Also, this may just be the class that a factory method is called on, or it may even be empty in case of a factory bean reference that a method is called on. Hence, do not consider this to be the definitive bean type at runtime but rather only use it for parsing purposes at the individual bean definition level.

Annotations

@Nullable

getConstructorArgumentValues back to summary

getConstructorArgumentValues	back to summary
public ConstructorArgumentValues getConstructorArgumentValues() Return the constructor argument values for this bean. The returned instance can be modified during bean factory post-processing. Returns:ConstructorArgumentValues the ConstructorArgumentValues object (never `null`)

public ConstructorArgumentValues getConstructorArgumentValues()

Return the constructor argument values for this bean.

The returned instance can be modified during bean factory post-processing.

Returns:ConstructorArgumentValues: the ConstructorArgumentValues object (never null)

getDependsOn	back to summary
public String[] getDependsOn() Return the bean names that this bean depends on. Annotations @Nullable

getDependsOn

back to summary

public String[] getDependsOn()

Return the bean names that this bean depends on.

Annotations

@Nullable

getDescription	back to summary
public String getDescription() Return a human-readable description of this bean definition. Annotations @Nullable

getDescription

back to summary

public String getDescription()

Return a human-readable description of this bean definition.

Annotations

@Nullable

getDestroyMethodName	back to summary
public String getDestroyMethodName() Return the name of the destroy method. Annotations @Nullable Since 5.1

getDestroyMethodName

back to summary

public String getDestroyMethodName()

Return the name of the destroy method.

Annotations

@Nullable

Since

5.1

getFactoryBeanName	back to summary
public String getFactoryBeanName() Return the factory bean name, if any. Annotations @Nullable

getFactoryBeanName

back to summary

public String getFactoryBeanName()

Return the factory bean name, if any.

Annotations

@Nullable

getFactoryMethodName	back to summary
public String getFactoryMethodName() Return a factory method, if any. Annotations @Nullable

getFactoryMethodName

back to summary

public String getFactoryMethodName()

Return a factory method, if any.

Annotations

@Nullable

getInitMethodName	back to summary
public String getInitMethodName() Return the name of the initializer method. Annotations @Nullable Since 5.1

getInitMethodName

back to summary

public String getInitMethodName()

Return the name of the initializer method.

Annotations

@Nullable

Since

5.1

getOriginatingBeanDefinition back to summary

getOriginatingBeanDefinition	back to summary
public BeanDefinition getOriginatingBeanDefinition() Return the originating BeanDefinition, or `null` if none. Allows for retrieving the decorated bean definition, if any. Note that this method returns the immediate originator. Iterate through the originator chain to find the original BeanDefinition as defined by the user. Annotations @Nullable

public BeanDefinition getOriginatingBeanDefinition()

Return the originating BeanDefinition, or null if none.

Allows for retrieving the decorated bean definition, if any.

Note that this method returns the immediate originator. Iterate through the originator chain to find the original BeanDefinition as defined by the user.

Annotations

@Nullable

getParentName	back to summary
public String getParentName() Return the name of the parent definition of this bean definition, if any. Annotations @Nullable

getParentName

back to summary

public String getParentName()

Return the name of the parent definition of this bean definition, if any.

Annotations

@Nullable

getPropertyValues back to summary

getPropertyValues	back to summary
public MutablePropertyValues getPropertyValues() Return the property values to be applied to a new instance of the bean. The returned instance can be modified during bean factory post-processing. Returns:MutablePropertyValues the MutablePropertyValues object (never `null`)

public MutablePropertyValues getPropertyValues()

Return the property values to be applied to a new instance of the bean.

The returned instance can be modified during bean factory post-processing.

Returns:MutablePropertyValues: the MutablePropertyValues object (never null)

getResolvableType back to summary

getResolvableType	back to summary
public ResolvableType getResolvableType() Return a resolvable type for this bean definition, based on the bean class or other specific metadata. This is typically fully resolved on a runtime-merged bean definition but not necessarily on a configuration-time definition instance. Returns:ResolvableType the resolvable type (potentially `ResolvableType#NONE`) Since 5.2 See Also `ConfigurableBeanFactory#getMergedBeanDefinition`

public ResolvableType getResolvableType()

Return a resolvable type for this bean definition, based on the bean class or other specific metadata.

This is typically fully resolved on a runtime-merged bean definition but not necessarily on a configuration-time definition instance.

Returns:ResolvableType: the resolvable type (potentially ResolvableType#NONE)
Since: 5.2
See Also: ConfigurableBeanFactory#getMergedBeanDefinition

getResourceDescription	back to summary
public String getResourceDescription() Return a description of the resource that this bean definition came from (for the purpose of showing context in case of errors). Annotations @Nullable

getResourceDescription

back to summary

public String getResourceDescription()

Return a description of the resource that this bean definition came from (for the purpose of showing context in case of errors).

Annotations

@Nullable

getRole back to summary

getRole	back to summary
public int getRole() Get the role hint for this `BeanDefinition`. The role hint provides the frameworks as well as tools an indication of the role and importance of a particular `BeanDefinition`. See Also `ROLE_APPLICATION`, `ROLE_SUPPORT`, `ROLE_INFRASTRUCTURE`

public int getRole()

Get the role hint for this BeanDefinition. The role hint provides the frameworks as well as tools an indication of the role and importance of a particular BeanDefinition.

See Also: ROLE_APPLICATION, ROLE_SUPPORT, ROLE_INFRASTRUCTURE

getScope back to summary

getScope	back to summary
public String getScope() Return the name of the current target scope for this bean, or `null` if not known yet. Annotations @Nullable

public String getScope()

Return the name of the current target scope for this bean, or null if not known yet.

Annotations

@Nullable

hasConstructorArgumentValues	back to summary
public default boolean hasConstructorArgumentValues() Return if there are constructor argument values defined for this bean. Since 5.0.2

hasConstructorArgumentValues

back to summary

public default boolean hasConstructorArgumentValues()

Return if there are constructor argument values defined for this bean.

Since: 5.0.2

hasPropertyValues	back to summary
public default boolean hasPropertyValues() Return if there are property values defined for this bean. Since 5.0.2

hasPropertyValues

back to summary

public default boolean hasPropertyValues()

Return if there are property values defined for this bean.

Since: 5.0.2

isAbstract	back to summary
public boolean isAbstract() Return whether this bean is "abstract", that is, not meant to be instantiated.

isAutowireCandidate	back to summary
public boolean isAutowireCandidate() Return whether this bean is a candidate for getting autowired into some other bean.

isLazyInit	back to summary
public boolean isLazyInit() Return whether this bean should be lazily initialized, i.e. not eagerly instantiated on startup. Only applicable to a singleton bean.

isPrimary	back to summary
public boolean isPrimary() Return whether this bean is a primary autowire candidate.

isPrototype back to summary

isPrototype	back to summary
public boolean isPrototype() Return whether this a Prototype, with an independent instance returned for each call. Since 3.0 See Also `SCOPE_PROTOTYPE`

public boolean isPrototype()

Return whether this a Prototype, with an independent instance returned for each call.

Since: 3.0
See Also: SCOPE_PROTOTYPE

isSingleton back to summary

isSingleton	back to summary
public boolean isSingleton() Return whether this a Singleton, with a single, shared instance returned on all calls. See Also `SCOPE_SINGLETON`

public boolean isSingleton()

Return whether this a Singleton, with a single, shared instance returned on all calls.

See Also: SCOPE_SINGLETON

setAutowireCandidate	back to summary
public void setAutowireCandidate(boolean autowireCandidate) Set whether this bean is a candidate for getting autowired into some other bean. Note that this flag is designed to only affect type-based autowiring. It does not affect explicit references by name, which will get resolved even if the specified bean is not marked as an autowire candidate. As a consequence, autowiring by name will nevertheless inject a bean if the name matches.

setAutowireCandidate

back to summary

public void setAutowireCandidate(boolean autowireCandidate)

Set whether this bean is a candidate for getting autowired into some other bean.

Note that this flag is designed to only affect type-based autowiring. It does not affect explicit references by name, which will get resolved even if the specified bean is not marked as an autowire candidate. As a consequence, autowiring by name will nevertheless inject a bean if the name matches.

setBeanClassName back to summary

setBeanClassName	back to summary
public void setBeanClassName(String beanClassName) Specify the bean class name of this bean definition. The class name can be modified during bean factory post-processing, typically replacing the original class name with a parsed variant of it. See Also `setParentName`, `setFactoryBeanName`, `setFactoryMethodName`

public void setBeanClassName(String beanClassName)

Specify the bean class name of this bean definition.

The class name can be modified during bean factory post-processing, typically replacing the original class name with a parsed variant of it.

See Also: setParentName, setFactoryBeanName, setFactoryMethodName

setDependsOn	back to summary
public void setDependsOn(String... dependsOn) Set the names of the beans that this bean depends on being initialized. The bean factory will guarantee that these beans get initialized first.

setDescription	back to summary
public void setDescription(String description) Set a human-readable description of this bean definition. Since 5.1

setDescription

back to summary

public void setDescription(String description)

Set a human-readable description of this bean definition.

Since: 5.1

setDestroyMethodName	back to summary
public void setDestroyMethodName(String destroyMethodName) Set the name of the destroy method. Since 5.1

setDestroyMethodName

back to summary

public void setDestroyMethodName(String destroyMethodName)

Set the name of the destroy method.

Since: 5.1

setFactoryBeanName back to summary

setFactoryBeanName	back to summary
public void setFactoryBeanName(String factoryBeanName) Specify the factory bean to use, if any. This the name of the bean to call the specified factory method on. See Also `setFactoryMethodName`

public void setFactoryBeanName(String factoryBeanName)

Specify the factory bean to use, if any. This the name of the bean to call the specified factory method on.

See Also: setFactoryMethodName

setFactoryMethodName back to summary

setFactoryMethodName	back to summary
public void setFactoryMethodName(String factoryMethodName) Specify a factory method, if any. This method will be invoked with constructor arguments, or with no arguments if none are specified. The method will be invoked on the specified factory bean, if any, or otherwise as a static method on the local bean class. See Also `setFactoryBeanName`, `setBeanClassName`

public void setFactoryMethodName(String factoryMethodName)

Specify a factory method, if any. This method will be invoked with constructor arguments, or with no arguments if none are specified. The method will be invoked on the specified factory bean, if any, or otherwise as a static method on the local bean class.

See Also: setFactoryBeanName, setBeanClassName

setInitMethodName	back to summary
public void setInitMethodName(String initMethodName) Set the name of the initializer method. Since 5.1

setInitMethodName

back to summary

public void setInitMethodName(String initMethodName)

Set the name of the initializer method.

Since: 5.1

setLazyInit back to summary

setLazyInit	back to summary
public void setLazyInit(boolean lazyInit) Set whether this bean should be lazily initialized. If `false`, the bean will get instantiated on startup by bean factories that perform eager initialization of singletons.

public void setLazyInit(boolean lazyInit)

Set whether this bean should be lazily initialized.

If false, the bean will get instantiated on startup by bean factories that perform eager initialization of singletons.

setParentName	back to summary
public void setParentName(String parentName) Set the name of the parent definition of this bean definition, if any.

setPrimary back to summary

setPrimary	back to summary
public void setPrimary(boolean primary) Set whether this bean is a primary autowire candidate. If this value is `true` for exactly one bean among multiple matching candidates, it will serve as a tie-breaker.

public void setPrimary(boolean primary)

Set whether this bean is a primary autowire candidate.

If this value is true for exactly one bean among multiple matching candidates, it will serve as a tie-breaker.

setRole back to summary

setRole	back to summary
public void setRole(int role) Set the role hint for this `BeanDefinition`. The role hint provides the frameworks as well as tools an indication of the role and importance of a particular `BeanDefinition`. Since 5.1 See Also `ROLE_APPLICATION`, `ROLE_SUPPORT`, `ROLE_INFRASTRUCTURE`

public void setRole(int role)

Set the role hint for this BeanDefinition. The role hint provides the frameworks as well as tools an indication of the role and importance of a particular BeanDefinition.

Since: 5.1
See Also: ROLE_APPLICATION, ROLE_SUPPORT, ROLE_INFRASTRUCTURE

setScope back to summary

setScope	back to summary
public void setScope(String scope) Override the target scope of this bean, specifying a new scope name. See Also `SCOPE_SINGLETON`, `SCOPE_PROTOTYPE`

public void setScope(String scope)

Override the target scope of this bean, specifying a new scope name.

See Also: SCOPE_SINGLETON, SCOPE_PROTOTYPE

public Interface BeanDefinition

Field Summary

Method Summary

Field Detail

Method Detail