java.lang.Object | |
↳ | org.springframework.beans.factory.config.AbstractFactoryBean<T> |
Known Direct Subclasses |
Known Indirect Subclasses |
Simple template superclass for FactoryBean
implementations that
creates a singleton or a prototype object, depending on a flag.
If the "singleton" flag is true
(the default),
this class will create the object that it creates exactly once
on initialization and subsequently return said singleton instance
on all calls to the getObject()
method.
Else, this class will create a new instance every time the
getObject()
method is invoked. Subclasses are responsible
for implementing the abstract createInstance()
template
method to actually create the object(s) to expose.
Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
logger | Logger available to subclasses |
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Eagerly create the singleton instance, if necessary.
| |||||||||||
Destroy the singleton instance, if any.
| |||||||||||
Expose the singleton instance or create a new prototype instance.
| |||||||||||
This abstract method declaration mirrors the method in the FactoryBean
interface, for a consistent offering of abstract template methods.
| |||||||||||
Is the object managed by this factory a singleton? That is,
will
getObject() always return the same object
(a reference that can be cached)?
NOTE: If a FactoryBean indicates to hold a singleton object,
the object returned from | |||||||||||
Callback that supplies the bean
class loader to
a bean instance. | |||||||||||
Callback that supplies the owning factory to a bean instance.
| |||||||||||
Set if a singleton should be created, or a new object on each request
otherwise.
|
Protected Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Template method that subclasses must override to construct
the object returned by this factory.
| |||||||||||
Callback for destroying a singleton instance.
| |||||||||||
Return the BeanFactory that this bean runs in.
| |||||||||||
Obtain a bean type converter from the BeanFactory that this bean
runs in.
| |||||||||||
Return an array of interfaces that a singleton object exposed by this
FactoryBean is supposed to implement, for use with an 'early singleton
proxy' that will be exposed in case of a circular reference.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
From interface
org.springframework.beans.factory.BeanClassLoaderAware
| |||||||||||
From interface
org.springframework.beans.factory.BeanFactoryAware
| |||||||||||
From interface
org.springframework.beans.factory.DisposableBean
| |||||||||||
From interface
org.springframework.beans.factory.FactoryBean
| |||||||||||
From interface
org.springframework.beans.factory.InitializingBean
|
Eagerly create the singleton instance, if necessary.
Exception |
---|
Expose the singleton instance or create a new prototype instance.
null
)Exception |
---|
This abstract method declaration mirrors the method in the FactoryBean interface, for a consistent offering of abstract template methods.
null
if not known at the time of the callIs the object managed by this factory a singleton? That is,
will getObject()
always return the same object
(a reference that can be cached)?
NOTE: If a FactoryBean indicates to hold a singleton object,
the object returned from getObject()
might get cached
by the owning BeanFactory. Hence, do not return true
unless the FactoryBean always exposes the same reference.
The singleton status of the FactoryBean itself will generally be provided by the owning BeanFactory; usually, it has to be defined as singleton there.
NOTE: This method returning false
does not
necessarily indicate that returned objects are independent instances.
An implementation of the extended SmartFactoryBean
interface
may explicitly indicate independent instances through its
isPrototype()
method. Plain FactoryBean
implementations which do not implement this extended interface are
simply assumed to always return independent instances if the
isSingleton()
implementation returns false
.
Callback that supplies the bean class loader
to
a bean instance.
Invoked after the population of normal bean properties but
before an initialization callback such as
InitializingBean's
afterPropertiesSet()
method or a custom init-method.
classLoader | the owning class loader; may be null in
which case a default ClassLoader must be used, for example
the ClassLoader obtained via
getDefaultClassLoader()
|
---|
Callback that supplies the owning factory to a bean instance.
Invoked after the population of normal bean properties
but before an initialization callback such as
afterPropertiesSet()
or a custom init-method.
beanFactory | owning BeanFactory (never null ).
The bean can immediately call methods on the factory. |
---|
Set if a singleton should be created, or a new object on each request
otherwise. Default is true
(a singleton).
Template method that subclasses must override to construct the object returned by this factory.
Invoked on initialization of this FactoryBean in case of
a singleton; else, on each getObject()
call.
Exception | if an exception occured during object creation |
---|
Callback for destroying a singleton instance. Subclasses may override this to destroy the previously created instance.
The default implementation is empty.
instance | the singleton instance, as returned by
createInstance() |
---|
Exception | in case of shutdown errors |
---|
Return the BeanFactory that this bean runs in.
Obtain a bean type converter from the BeanFactory that this bean runs in. This is typically a fresh instance for each call, since TypeConverters are usually not thread-safe.
Falls back to a SimpleTypeConverter when not running in a BeanFactory.
Return an array of interfaces that a singleton object exposed by this FactoryBean is supposed to implement, for use with an 'early singleton proxy' that will be exposed in case of a circular reference.
The default implementation returns this FactoryBean's object type,
provided that it is an interface, or null
else. The latter
indicates that early singleton access is not supported by this FactoryBean.
This will lead to a FactoryBeanNotInitializedException getting thrown.
null
to indicate a FactoryBeanNotInitializedException