public class StaticListableBeanFactory extends Object implements ListableBeanFactory
BeanFactory implementation
which allows to register existing singleton instances programmatically.
Does not have support for prototype beans or aliases.
Serves as example for a simple implementation of the
ListableBeanFactory interface,
managing existing bean instances rather than creating new ones based on bean
definitions, and not implementing any extended SPI interfaces (such as
ConfigurableBeanFactory).
For a full-fledged factory based on bean definitions, have a look
at DefaultListableBeanFactory.
DefaultListableBeanFactoryFACTORY_BEAN_PREFIX| Constructor and Description |
|---|
StaticListableBeanFactory()
Create a regular
StaticListableBeanFactory, to be populated
with singleton bean instances through addBean(java.lang.String, java.lang.Object) calls. |
StaticListableBeanFactory(Map<String,Object> beans)
Create a
StaticListableBeanFactory wrapping the given Map. |
| Modifier and Type | Method and Description |
|---|---|
void |
addBean(String name,
Object bean)
Add a new singleton bean.
|
boolean |
containsBean(String name)
Does this bean factory contain a bean definition or externally registered singleton
instance with the given name?
|
boolean |
containsBeanDefinition(String name)
Check if this bean factory contains a bean definition with the given name.
|
<A extends Annotation> |
findAnnotationOnBean(String beanName,
Class<A> annotationType)
Find an
Annotation of annotationType on the specified
bean, traversing its interfaces and super classes if no annotation can be
found on the given class itself. |
String[] |
getAliases(String name)
Return the aliases for the given bean name, if any.
|
<T> T |
getBean(Class<T> requiredType)
Return the bean instance that uniquely matches the given object type, if any.
|
<T> T |
getBean(Class<T> requiredType,
Object... args)
Return an instance, which may be shared or independent, of the specified bean.
|
Object |
getBean(String name)
Return an instance, which may be shared or independent, of the specified bean.
|
<T> T |
getBean(String name,
Class<T> requiredType)
Return an instance, which may be shared or independent, of the specified bean.
|
Object |
getBean(String name,
Object... args)
Return an instance, which may be shared or independent, of the specified bean.
|
int |
getBeanDefinitionCount()
Return the number of beans defined in the factory.
|
String[] |
getBeanDefinitionNames()
Return the names of all beans defined in this factory.
|
String[] |
getBeanNamesForAnnotation(Class<? extends Annotation> annotationType)
Find all names of beans whose
Class has the supplied Annotation
type, without creating any bean instances yet. |
String[] |
getBeanNamesForType(Class<?> type)
Return the names of beans matching the given type (including subclasses),
judging from either bean definitions or the value of
getObjectType
in the case of FactoryBeans. |
String[] |
getBeanNamesForType(Class<?> type,
boolean includeNonSingletons,
boolean allowEagerInit)
Return the names of beans matching the given type (including subclasses),
judging from either bean definitions or the value of
getObjectType
in the case of FactoryBeans. |
String[] |
getBeanNamesForType(org.springframework.core.ResolvableType type)
Return the names of beans matching the given type (including subclasses),
judging from either bean definitions or the value of
getObjectType
in the case of FactoryBeans. |
<T> Map<String,T> |
getBeansOfType(Class<T> type)
Return the bean instances that match the given object type (including
subclasses), judging from either bean definitions or the value of
getObjectType in the case of FactoryBeans. |
<T> Map<String,T> |
getBeansOfType(Class<T> type,
boolean includeNonSingletons,
boolean allowEagerInit)
Return the bean instances that match the given object type (including
subclasses), judging from either bean definitions or the value of
getObjectType in the case of FactoryBeans. |
Map<String,Object> |
getBeansWithAnnotation(Class<? extends Annotation> annotationType)
Find all beans whose
Class has the supplied Annotation type,
returning a Map of bean names with corresponding bean instances. |
Class<?> |
getType(String name)
Determine the type of the bean with the given name.
|
boolean |
isPrototype(String name)
Is this bean a prototype? That is, will
BeanFactory.getBean(java.lang.String) always return
independent instances? |
boolean |
isSingleton(String name)
Is this bean a shared singleton? That is, will
BeanFactory.getBean(java.lang.String) always
return the same instance? |
boolean |
isTypeMatch(String name,
Class<?> typeToMatch)
Check whether the bean with the given name matches the specified type.
|
boolean |
isTypeMatch(String name,
org.springframework.core.ResolvableType typeToMatch)
Check whether the bean with the given name matches the specified type.
|
public StaticListableBeanFactory()
StaticListableBeanFactory, to be populated
with singleton bean instances through addBean(java.lang.String, java.lang.Object) calls.public StaticListableBeanFactory(Map<String,Object> beans)
StaticListableBeanFactory wrapping the given Map.
Note that the given Map may be pre-populated with beans;
or new, still allowing for beans to be registered via addBean(java.lang.String, java.lang.Object);
or Collections.emptyMap() for a dummy factory which
enforces operating against an empty set of beans.
beans - a Map for holding this factory's beans, with the
bean name String as key and the corresponding singleton object as valuepublic void addBean(String name, Object bean)
name - the name of the beanbean - the bean instancepublic Object getBean(String name) throws BeansException
BeanFactoryThis method allows a Spring BeanFactory to be used as a replacement for the Singleton or Prototype design pattern. Callers may retain references to returned objects in the case of Singleton beans.
Translates aliases back to the corresponding canonical bean name. Will ask the parent factory if the bean cannot be found in this factory instance.
getBean in interface BeanFactoryname - the name of the bean to retrieveNoSuchBeanDefinitionException - if there is no bean definition
with the specified nameBeansException - if the bean could not be obtainedpublic <T> T getBean(String name, Class<T> requiredType) throws BeansException
BeanFactoryBehaves the same as BeanFactory.getBean(String), but provides a measure of type
safety by throwing a BeanNotOfRequiredTypeException if the bean is not of the
required type. This means that ClassCastException can't be thrown on casting
the result correctly, as can happen with BeanFactory.getBean(String).
Translates aliases back to the corresponding canonical bean name. Will ask the parent factory if the bean cannot be found in this factory instance.
getBean in interface BeanFactoryname - the name of the bean to retrieverequiredType - type the bean must match. Can be an interface or superclass
of the actual class, or null for any match. For example, if the value
is Object.class, this method will succeed whatever the class of the
returned instance.NoSuchBeanDefinitionException - if there is no such bean definitionBeanNotOfRequiredTypeException - if the bean is not of the required typeBeansException - if the bean could not be createdpublic Object getBean(String name, Object... args) throws BeansException
BeanFactoryAllows for specifying explicit constructor arguments / factory method arguments, overriding the specified default arguments (if any) in the bean definition.
getBean in interface BeanFactoryname - the name of the bean to retrieveargs - arguments to use when creating a bean instance using explicit arguments
(only applied when creating a new instance as opposed to retrieving an existing one)NoSuchBeanDefinitionException - if there is no such bean definitionBeanDefinitionStoreException - if arguments have been given but
the affected bean isn't a prototypeBeansException - if the bean could not be createdpublic <T> T getBean(Class<T> requiredType) throws BeansException
BeanFactoryThis method goes into ListableBeanFactory by-type lookup territory
but may also be translated into a conventional by-name lookup based on the name
of the given type. For more extensive retrieval operations across sets of beans,
use ListableBeanFactory and/or BeanFactoryUtils.
getBean in interface BeanFactoryrequiredType - type the bean must match; can be an interface or superclass.
null is disallowed.NoSuchBeanDefinitionException - if no bean of the given type was foundNoUniqueBeanDefinitionException - if more than one bean of the given type was foundBeansException - if the bean could not be createdListableBeanFactorypublic <T> T getBean(Class<T> requiredType, Object... args) throws BeansException
BeanFactoryAllows for specifying explicit constructor arguments / factory method arguments, overriding the specified default arguments (if any) in the bean definition.
This method goes into ListableBeanFactory by-type lookup territory
but may also be translated into a conventional by-name lookup based on the name
of the given type. For more extensive retrieval operations across sets of beans,
use ListableBeanFactory and/or BeanFactoryUtils.
getBean in interface BeanFactoryrequiredType - type the bean must match; can be an interface or superclass.
null is disallowed.args - arguments to use when creating a bean instance using explicit arguments
(only applied when creating a new instance as opposed to retrieving an existing one)NoSuchBeanDefinitionException - if there is no such bean definitionBeanDefinitionStoreException - if arguments have been given but
the affected bean isn't a prototypeBeansException - if the bean could not be createdpublic boolean containsBean(String name)
BeanFactoryIf the given name is an alias, it will be translated back to the corresponding canonical bean name.
If this factory is hierarchical, will ask any parent factory if the bean cannot be found in this factory instance.
If a bean definition or singleton instance matching the given name is found,
this method will return true whether the named bean definition is concrete
or abstract, lazy or eager, in scope or not. Therefore, note that a true
return value from this method does not necessarily indicate that BeanFactory.getBean(java.lang.String)
will be able to obtain an instance for the same name.
containsBean in interface BeanFactoryname - the name of the bean to querypublic boolean isSingleton(String name) throws NoSuchBeanDefinitionException
BeanFactoryBeanFactory.getBean(java.lang.String) always
return the same instance?
Note: This method returning false does not clearly indicate
independent instances. It indicates non-singleton instances, which may correspond
to a scoped bean as well. Use the BeanFactory.isPrototype(java.lang.String) operation to explicitly
check for independent instances.
Translates aliases back to the corresponding canonical bean name. Will ask the parent factory if the bean cannot be found in this factory instance.
isSingleton in interface BeanFactoryname - the name of the bean to queryNoSuchBeanDefinitionException - if there is no bean with the given nameBeanFactory.getBean(java.lang.String),
BeanFactory.isPrototype(java.lang.String)public boolean isPrototype(String name) throws NoSuchBeanDefinitionException
BeanFactoryBeanFactory.getBean(java.lang.String) always return
independent instances?
Note: This method returning false does not clearly indicate
a singleton object. It indicates non-independent instances, which may correspond
to a scoped bean as well. Use the BeanFactory.isSingleton(java.lang.String) operation to explicitly
check for a shared singleton instance.
Translates aliases back to the corresponding canonical bean name. Will ask the parent factory if the bean cannot be found in this factory instance.
isPrototype in interface BeanFactoryname - the name of the bean to queryNoSuchBeanDefinitionException - if there is no bean with the given nameBeanFactory.getBean(java.lang.String),
BeanFactory.isSingleton(java.lang.String)public boolean isTypeMatch(String name, org.springframework.core.ResolvableType typeToMatch) throws NoSuchBeanDefinitionException
BeanFactoryBeanFactory.getBean(java.lang.String) call for the given name
would return an object that is assignable to the specified target type.
Translates aliases back to the corresponding canonical bean name. Will ask the parent factory if the bean cannot be found in this factory instance.
isTypeMatch in interface BeanFactoryname - the name of the bean to querytypeToMatch - the type to match against (as a ResolvableType)true if the bean type matches,
false if it doesn't match or cannot be determined yetNoSuchBeanDefinitionException - if there is no bean with the given nameBeanFactory.getBean(java.lang.String),
BeanFactory.getType(java.lang.String)public boolean isTypeMatch(String name, Class<?> typeToMatch) throws NoSuchBeanDefinitionException
BeanFactoryBeanFactory.getBean(java.lang.String) call for the given name
would return an object that is assignable to the specified target type.
Translates aliases back to the corresponding canonical bean name. Will ask the parent factory if the bean cannot be found in this factory instance.
isTypeMatch in interface BeanFactoryname - the name of the bean to querytypeToMatch - the type to match against (as a Class)true if the bean type matches,
false if it doesn't match or cannot be determined yetNoSuchBeanDefinitionException - if there is no bean with the given nameBeanFactory.getBean(java.lang.String),
BeanFactory.getType(java.lang.String)public Class<?> getType(String name) throws NoSuchBeanDefinitionException
BeanFactoryBeanFactory.getBean(java.lang.String) would return for the given name.
For a FactoryBean, return the type of object that the FactoryBean creates,
as exposed by FactoryBean.getObjectType().
Translates aliases back to the corresponding canonical bean name. Will ask the parent factory if the bean cannot be found in this factory instance.
getType in interface BeanFactoryname - the name of the bean to querynull if not determinableNoSuchBeanDefinitionException - if there is no bean with the given nameBeanFactory.getBean(java.lang.String),
BeanFactory.isTypeMatch(java.lang.String, org.springframework.core.ResolvableType)public String[] getAliases(String name)
BeanFactoryBeanFactory.getBean(java.lang.String) call.
If the given name is an alias, the corresponding original bean name and other aliases (if any) will be returned, with the original bean name being the first element in the array.
Will ask the parent factory if the bean cannot be found in this factory instance.
getAliases in interface BeanFactoryname - the bean name to check for aliasesBeanFactory.getBean(java.lang.String)public boolean containsBeanDefinition(String name)
ListableBeanFactoryDoes not consider any hierarchy this factory may participate in, and ignores any singleton beans that have been registered by other means than bean definitions.
containsBeanDefinition in interface ListableBeanFactoryname - the name of the bean to look forBeanFactory.containsBean(java.lang.String)public int getBeanDefinitionCount()
ListableBeanFactoryDoes not consider any hierarchy this factory may participate in, and ignores any singleton beans that have been registered by other means than bean definitions.
getBeanDefinitionCount in interface ListableBeanFactorypublic String[] getBeanDefinitionNames()
ListableBeanFactoryDoes not consider any hierarchy this factory may participate in, and ignores any singleton beans that have been registered by other means than bean definitions.
getBeanDefinitionNames in interface ListableBeanFactorypublic String[] getBeanNamesForType(org.springframework.core.ResolvableType type)
ListableBeanFactorygetObjectType
in the case of FactoryBeans.
NOTE: This method introspects top-level beans only. It does not check nested beans which might match the specified type as well.
Does consider objects created by FactoryBeans, which means that FactoryBeans will get initialized. If the object created by the FactoryBean doesn't match, the raw FactoryBean itself will be matched against the type.
Does not consider any hierarchy this factory may participate in.
Use BeanFactoryUtils' beanNamesForTypeIncludingAncestors
to include beans in ancestor factories too.
Note: Does not ignore singleton beans that have been registered by other means than bean definitions.
This version of getBeanNamesForType matches all kinds of beans,
be it singletons, prototypes, or FactoryBeans. In most implementations, the
result will be the same as for getBeanNamesForType(type, true, true).
Bean names returned by this method should always return bean names in the order of definition in the backend configuration, as far as possible.
getBeanNamesForType in interface ListableBeanFactorytype - the class or interface to match, or null for all bean namesBeanFactory.isTypeMatch(String, ResolvableType),
FactoryBean.getObjectType(),
BeanFactoryUtils.beanNamesForTypeIncludingAncestors(ListableBeanFactory, ResolvableType)public String[] getBeanNamesForType(Class<?> type)
ListableBeanFactorygetObjectType
in the case of FactoryBeans.
NOTE: This method introspects top-level beans only. It does not check nested beans which might match the specified type as well.
Does consider objects created by FactoryBeans, which means that FactoryBeans will get initialized. If the object created by the FactoryBean doesn't match, the raw FactoryBean itself will be matched against the type.
Does not consider any hierarchy this factory may participate in.
Use BeanFactoryUtils' beanNamesForTypeIncludingAncestors
to include beans in ancestor factories too.
Note: Does not ignore singleton beans that have been registered by other means than bean definitions.
This version of getBeanNamesForType matches all kinds of beans,
be it singletons, prototypes, or FactoryBeans. In most implementations, the
result will be the same as for getBeanNamesForType(type, true, true).
Bean names returned by this method should always return bean names in the order of definition in the backend configuration, as far as possible.
getBeanNamesForType in interface ListableBeanFactorytype - the class or interface to match, or null for all bean namesFactoryBean.getObjectType(),
BeanFactoryUtils.beanNamesForTypeIncludingAncestors(ListableBeanFactory, Class)public String[] getBeanNamesForType(Class<?> type, boolean includeNonSingletons, boolean allowEagerInit)
ListableBeanFactorygetObjectType
in the case of FactoryBeans.
NOTE: This method introspects top-level beans only. It does not check nested beans which might match the specified type as well.
Does consider objects created by FactoryBeans if the "allowEagerInit" flag is set, which means that FactoryBeans will get initialized. If the object created by the FactoryBean doesn't match, the raw FactoryBean itself will be matched against the type. If "allowEagerInit" is not set, only raw FactoryBeans will be checked (which doesn't require initialization of each FactoryBean).
Does not consider any hierarchy this factory may participate in.
Use BeanFactoryUtils' beanNamesForTypeIncludingAncestors
to include beans in ancestor factories too.
Note: Does not ignore singleton beans that have been registered by other means than bean definitions.
Bean names returned by this method should always return bean names in the order of definition in the backend configuration, as far as possible.
getBeanNamesForType in interface ListableBeanFactorytype - the class or interface to match, or null for all bean namesincludeNonSingletons - whether to include prototype or scoped beans too
or just singletons (also applies to FactoryBeans)allowEagerInit - whether to initialize lazy-init singletons and
objects created by FactoryBeans (or by factory methods with a
"factory-bean" reference) for the type check. Note that FactoryBeans need to be
eagerly initialized to determine their type: So be aware that passing in "true"
for this flag will initialize FactoryBeans and "factory-bean" references.FactoryBean.getObjectType(),
BeanFactoryUtils.beanNamesForTypeIncludingAncestors(ListableBeanFactory, Class, boolean, boolean)public <T> Map<String,T> getBeansOfType(Class<T> type) throws BeansException
ListableBeanFactorygetObjectType in the case of FactoryBeans.
NOTE: This method introspects top-level beans only. It does not check nested beans which might match the specified type as well.
Does consider objects created by FactoryBeans, which means that FactoryBeans will get initialized. If the object created by the FactoryBean doesn't match, the raw FactoryBean itself will be matched against the type.
Does not consider any hierarchy this factory may participate in.
Use BeanFactoryUtils' beansOfTypeIncludingAncestors
to include beans in ancestor factories too.
Note: Does not ignore singleton beans that have been registered by other means than bean definitions.
This version of getBeansOfType matches all kinds of beans, be it
singletons, prototypes, or FactoryBeans. In most implementations, the
result will be the same as for getBeansOfType(type, true, true).
The Map returned by this method should always return bean names and corresponding bean instances in the order of definition in the backend configuration, as far as possible.
getBeansOfType in interface ListableBeanFactorytype - the class or interface to match, or null for all concrete beansBeansException - if a bean could not be createdFactoryBean.getObjectType(),
BeanFactoryUtils.beansOfTypeIncludingAncestors(ListableBeanFactory, Class)public <T> Map<String,T> getBeansOfType(Class<T> type, boolean includeNonSingletons, boolean allowEagerInit) throws BeansException
ListableBeanFactorygetObjectType in the case of FactoryBeans.
NOTE: This method introspects top-level beans only. It does not check nested beans which might match the specified type as well.
Does consider objects created by FactoryBeans if the "allowEagerInit" flag is set, which means that FactoryBeans will get initialized. If the object created by the FactoryBean doesn't match, the raw FactoryBean itself will be matched against the type. If "allowEagerInit" is not set, only raw FactoryBeans will be checked (which doesn't require initialization of each FactoryBean).
Does not consider any hierarchy this factory may participate in.
Use BeanFactoryUtils' beansOfTypeIncludingAncestors
to include beans in ancestor factories too.
Note: Does not ignore singleton beans that have been registered by other means than bean definitions.
The Map returned by this method should always return bean names and corresponding bean instances in the order of definition in the backend configuration, as far as possible.
getBeansOfType in interface ListableBeanFactorytype - the class or interface to match, or null for all concrete beansincludeNonSingletons - whether to include prototype or scoped beans too
or just singletons (also applies to FactoryBeans)allowEagerInit - whether to initialize lazy-init singletons and
objects created by FactoryBeans (or by factory methods with a
"factory-bean" reference) for the type check. Note that FactoryBeans need to be
eagerly initialized to determine their type: So be aware that passing in "true"
for this flag will initialize FactoryBeans and "factory-bean" references.BeansException - if a bean could not be createdFactoryBean.getObjectType(),
BeanFactoryUtils.beansOfTypeIncludingAncestors(ListableBeanFactory, Class, boolean, boolean)public String[] getBeanNamesForAnnotation(Class<? extends Annotation> annotationType)
ListableBeanFactoryClass has the supplied Annotation
type, without creating any bean instances yet.getBeanNamesForAnnotation in interface ListableBeanFactoryannotationType - the type of annotation to look forpublic Map<String,Object> getBeansWithAnnotation(Class<? extends Annotation> annotationType) throws BeansException
ListableBeanFactoryClass has the supplied Annotation type,
returning a Map of bean names with corresponding bean instances.getBeansWithAnnotation in interface ListableBeanFactoryannotationType - the type of annotation to look forBeansException - if a bean could not be createdpublic <A extends Annotation> A findAnnotationOnBean(String beanName, Class<A> annotationType) throws NoSuchBeanDefinitionException
ListableBeanFactoryAnnotation of annotationType on the specified
bean, traversing its interfaces and super classes if no annotation can be
found on the given class itself.findAnnotationOnBean in interface ListableBeanFactorybeanName - the name of the bean to look for annotations onannotationType - the annotation class to look fornullNoSuchBeanDefinitionException - if there is no bean with the given name