org.springframework.beans.factory.config.SingletonBeanRegistry |
Known Indirect Subclasses |
Interface that defines a registry for shared bean instances.
Can be implemented by BeanFactory
implementations in order to expose their singleton management facility
in a uniform manner.
The ConfigurableBeanFactory
interface extends this interface.
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Check if this registry contains a singleton instance with the given name.
| |||||||||||
Return the (raw) singleton object registered under the given name.
| |||||||||||
Return the number of singleton beans registered in this registry.
| |||||||||||
Return the names of singleton beans registered in this registry.
| |||||||||||
Register the given existing object as singleton in the bean registry,
under the given bean name.
|
Check if this registry contains a singleton instance with the given name.
Only checks already instantiated singletons; does not return true
for singleton bean definitions which have not been instantiated yet.
The main purpose of this method is to check manually registered singletons
(see registerSingleton(String, Object)
). Can also be used to check whether a
singleton defined by a bean definition has already been created.
To check whether a bean factory contains a bean definition with a given name,
use ListableBeanFactory's containsBeanDefinition
. Calling both
containsBeanDefinition
and containsSingleton
answers
whether a specific bean factory contains a local bean instance with the given name.
Use BeanFactory's containsBean
for general checks whether the
factory knows about a bean with a given name (whether manually registered singleton
instance or created by bean definition), also checking ancestor factories.
NOTE: This lookup method is not aware of FactoryBean prefixes or aliases. You need to resolve the canonical bean name first before checking the singleton status.
beanName | the name of the bean to look for |
---|
Return the (raw) singleton object registered under the given name.
Only checks already instantiated singletons; does not return an Object for singleton bean definitions which have not been instantiated yet.
The main purpose of this method is to access manually registered singletons
(see registerSingleton(String, Object)
). Can also be used to access a singleton
defined by a bean definition that already been created, in a raw fashion.
NOTE: This lookup method is not aware of FactoryBean prefixes or aliases. You need to resolve the canonical bean name first before obtaining the singleton instance.
beanName | the name of the bean to look for |
---|
null
if none foundReturn the number of singleton beans registered in this registry.
Only checks already instantiated singletons; does not count singleton bean definitions which have not been instantiated yet.
The main purpose of this method is to check manually registered singletons
(see registerSingleton(String, Object)
). Can also be used to count the number of
singletons defined by a bean definition that have already been created.
Return the names of singleton beans registered in this registry.
Only checks already instantiated singletons; does not return names for singleton bean definitions which have not been instantiated yet.
The main purpose of this method is to check manually registered singletons
(see registerSingleton(String, Object)
). Can also be used to check which singletons
defined by a bean definition have already been created.
null
)Register the given existing object as singleton in the bean registry, under the given bean name.
The given instance is supposed to be fully initialized; the registry
will not perform any initialization callbacks (in particular, it won't
call InitializingBean's afterPropertiesSet
method).
The given instance will not receive any destruction callbacks
(like DisposableBean's destroy
method) either.
When running within a full BeanFactory: Register a bean definition instead of an existing instance if your bean is supposed to receive initialization and/or destruction callbacks.
Typically invoked during registry configuration, but can also be used for runtime registration of singletons. As a consequence, a registry implementation should synchronize singleton access; it will have to do this anyway if it supports a BeanFactory's lazy initialization of singletons.
beanName | the name of the bean |
---|---|
singletonObject | the existing singleton object |