public interface BeanDefinition extends AttributeAccessor, BeanMetadataElement
This is just a minimal interface: The main intention is to allow a
BeanFactoryPostProcessor
such as PropertyPlaceholderConfigurer
to introspect and modify property values and other bean metadata.
ConfigurableListableBeanFactory.getBeanDefinition(java.lang.String)
,
RootBeanDefinition
,
ChildBeanDefinition
Modifier and Type | Field and Description |
---|---|
static int |
ROLE_APPLICATION
Role hint indicating that a
BeanDefinition is a major part
of the application. |
static int |
ROLE_INFRASTRUCTURE
Role hint indicating that a
BeanDefinition is providing an
entirely background role and has no relevance to the end-user. |
static int |
ROLE_SUPPORT
Role hint indicating that a
BeanDefinition is a supporting
part of some larger configuration, typically an outer
ComponentDefinition . |
static java.lang.String |
SCOPE_PROTOTYPE
Scope identifier for the standard prototype scope: "prototype".
|
static java.lang.String |
SCOPE_SINGLETON
Scope identifier for the standard singleton scope: "singleton".
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getBeanClassName()
Return the current bean class name of this bean definition.
|
ConstructorArgumentValues |
getConstructorArgumentValues()
Return the constructor argument values for this bean.
|
java.lang.String[] |
getDependsOn()
Return the bean names that this bean depends on.
|
java.lang.String |
getDescription()
Return a human-readable description of this bean definition.
|
java.lang.String |
getFactoryBeanName()
Return the factory bean name, if any.
|
java.lang.String |
getFactoryMethodName()
Return a factory method, if any.
|
BeanDefinition |
getOriginatingBeanDefinition()
Return the originating BeanDefinition, or
null if none. |
java.lang.String |
getParentName()
Return the name of the parent definition of this bean definition, if any.
|
MutablePropertyValues |
getPropertyValues()
Return the property values to be applied to a new instance of the bean.
|
java.lang.String |
getResourceDescription()
Return a description of the resource that this bean definition
came from (for the purpose of showing context in case of errors).
|
int |
getRole()
Get the role hint for this
BeanDefinition . |
java.lang.String |
getScope()
Return the name of the current target scope for this bean,
or
null if not known yet. |
default boolean |
hasConstructorArgumentValues()
Return if there are constructor argument values defined for this bean.
|
default boolean |
hasPropertyValues()
Return if there are property values values defined for this bean.
|
boolean |
isAbstract()
Return whether this bean is "abstract", that is, not meant to be instantiated.
|
boolean |
isAutowireCandidate()
Return whether this bean is a candidate for getting autowired into some other bean.
|
boolean |
isLazyInit()
Return whether this bean should be lazily initialized, i.e.
|
boolean |
isPrimary()
Return whether this bean is a primary autowire candidate.
|
boolean |
isPrototype()
Return whether this a Prototype, with an independent instance
returned for each call.
|
boolean |
isSingleton()
Return whether this a Singleton, with a single, shared instance
returned on all calls.
|
void |
setAutowireCandidate(boolean autowireCandidate)
Set whether this bean is a candidate for getting autowired into some other bean.
|
void |
setBeanClassName(java.lang.String beanClassName)
Specify the bean class name of this bean definition.
|
void |
setDependsOn(java.lang.String... dependsOn)
Set the names of the beans that this bean depends on being initialized.
|
void |
setFactoryBeanName(java.lang.String factoryBeanName)
Specify the factory bean to use, if any.
|
void |
setFactoryMethodName(java.lang.String factoryMethodName)
Specify a factory method, if any.
|
void |
setLazyInit(boolean lazyInit)
Set whether this bean should be lazily initialized.
|
void |
setParentName(java.lang.String parentName)
Set the name of the parent definition of this bean definition, if any.
|
void |
setPrimary(boolean primary)
Set whether this bean is a primary autowire candidate.
|
void |
setScope(java.lang.String scope)
Override the target scope of this bean, specifying a new scope name.
|
attributeNames, getAttribute, hasAttribute, removeAttribute, setAttribute
getSource
static final java.lang.String SCOPE_SINGLETON
Note that extended bean factories might support further scopes.
setScope(java.lang.String)
,
Constant Field Valuesstatic final java.lang.String SCOPE_PROTOTYPE
Note that extended bean factories might support further scopes.
setScope(java.lang.String)
,
Constant Field Valuesstatic final int ROLE_APPLICATION
BeanDefinition
is a major part
of the application. Typically corresponds to a user-defined bean.static final int ROLE_SUPPORT
BeanDefinition
is a supporting
part of some larger configuration, typically an outer
ComponentDefinition
.
SUPPORT
beans are considered important enough to be aware
of when looking more closely at a particular
ComponentDefinition
,
but not when looking at the overall configuration of an application.static final int ROLE_INFRASTRUCTURE
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 ComponentDefinition
.void setParentName(@Nullable java.lang.String parentName)
@Nullable java.lang.String getParentName()
void setBeanClassName(@Nullable java.lang.String beanClassName)
The class name can be modified during bean factory post-processing, typically replacing the original class name with a parsed variant of it.
@Nullable java.lang.String getBeanClassName()
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.
void setScope(@Nullable java.lang.String scope)
SCOPE_SINGLETON
,
SCOPE_PROTOTYPE
@Nullable java.lang.String getScope()
null
if not known yet.void setLazyInit(boolean lazyInit)
If false
, the bean will get instantiated on startup by bean
factories that perform eager initialization of singletons.
boolean isLazyInit()
void setDependsOn(@Nullable java.lang.String... dependsOn)
@Nullable java.lang.String[] getDependsOn()
void setAutowireCandidate(boolean autowireCandidate)
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.
boolean isAutowireCandidate()
void setPrimary(boolean primary)
If this value is true
for exactly one bean among multiple
matching candidates, it will serve as a tie-breaker.
boolean isPrimary()
void setFactoryBeanName(@Nullable java.lang.String factoryBeanName)
setFactoryMethodName(java.lang.String)
@Nullable java.lang.String getFactoryBeanName()
void setFactoryMethodName(@Nullable java.lang.String factoryMethodName)
@Nullable java.lang.String getFactoryMethodName()
ConstructorArgumentValues getConstructorArgumentValues()
The returned instance can be modified during bean factory post-processing.
null
)default boolean hasConstructorArgumentValues()
MutablePropertyValues getPropertyValues()
The returned instance can be modified during bean factory post-processing.
null
)default boolean hasPropertyValues()
boolean isSingleton()
SCOPE_SINGLETON
boolean isPrototype()
SCOPE_PROTOTYPE
boolean isAbstract()
int getRole()
BeanDefinition
. The role hint
provides the frameworks as well as tools with an indication of
the role and importance of a particular BeanDefinition
.ROLE_APPLICATION
,
ROLE_SUPPORT
,
ROLE_INFRASTRUCTURE
@Nullable java.lang.String getDescription()
@Nullable java.lang.String getResourceDescription()
@Nullable BeanDefinition getOriginatingBeanDefinition()
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.