Class StaticListableBeanFactory
- All Implemented Interfaces:
BeanFactory,ListableBeanFactory
BeanFactory implementation
which allows one to register existing singleton instances programmatically.
Does not have support for prototype beans or aliases.
Serves as an 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.
- Since:
- 06.01.2003
- Author:
- Rod Johnson, Juergen Hoeller, Sam Brannen
- See Also:
-
Field Summary
Fields inherited from interface org.springframework.beans.factory.BeanFactory
FACTORY_BEAN_PREFIX -
Constructor Summary
ConstructorsConstructorDescriptionCreate a regularStaticListableBeanFactory, to be populated with singleton bean instances throughaddBean(java.lang.String, java.lang.Object)calls.StaticListableBeanFactory(Map<String, Object> beans) Create aStaticListableBeanFactorywrapping the givenMap. -
Method Summary
Modifier and TypeMethodDescriptionvoidAdd a new singleton bean.booleancontainsBean(String name) Does this bean factory contain a bean definition or externally registered singleton instance with the given name?booleancontainsBeanDefinition(String name) Check if this bean factory contains a bean definition with the given name.<A extends Annotation>
AfindAnnotationOnBean(String beanName, Class<A> annotationType) Find anAnnotationofannotationTypeon the specified bean, traversing its interfaces and super classes if no annotation can be found on the given class itself, as well as checking the bean's factory method (if any).<A extends Annotation>
AfindAnnotationOnBean(String beanName, Class<A> annotationType, boolean allowFactoryBeanInit) Find anAnnotationofannotationTypeon the specified bean, traversing its interfaces and super classes if no annotation can be found on the given class itself, as well as checking the bean's factory method (if any).String[]getAliases(String name) Return the aliases for the given bean name, if any.<T> TReturn the bean instance that uniquely matches the given object type, if any.<T> TReturn an instance, which may be shared or independent, of the specified bean.Return an instance, which may be shared or independent, of the specified bean.<T> TReturn an instance, which may be shared or independent, of the specified bean.Return an instance, which may be shared or independent, of the specified bean.intReturn the number of beans defined in the factory.String[]Return the names of all beans defined in this factory.String[]getBeanNamesForAnnotation(Class<? extends Annotation> annotationType) Find all names of beans which are annotated with the suppliedAnnotationtype, without creating corresponding 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 ofgetObjectTypein 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 ofgetObjectTypein the case of FactoryBeans.String[]Return the names of beans matching the given type (including subclasses), judging from either bean definitions or the value ofgetObjectTypein the case of FactoryBeans.String[]getBeanNamesForType(ResolvableType type, boolean includeNonSingletons, boolean allowEagerInit) Return the names of beans matching the given type (including subclasses), judging from either bean definitions or the value ofgetObjectTypein the case of FactoryBeans.<T> ObjectProvider<T>getBeanProvider(Class<T> requiredType) Return a provider for the specified bean, allowing for lazy on-demand retrieval of instances, including availability and uniqueness options.<T> ObjectProvider<T>getBeanProvider(Class<T> requiredType, boolean allowEagerInit) Return a provider for the specified bean, allowing for lazy on-demand retrieval of instances, including availability and uniqueness options.<T> ObjectProvider<T>getBeanProvider(ResolvableType requiredType) Return a provider for the specified bean, allowing for lazy on-demand retrieval of instances, including availability and uniqueness options.<T> ObjectProvider<T>getBeanProvider(ResolvableType requiredType, boolean allowEagerInit) Return a provider for the specified bean, allowing for lazy on-demand retrieval of instances, including availability and uniqueness options.getBeansOfType(Class<T> type) Return the bean instances that match the given object type (including subclasses), judging from either bean definitions or the value ofgetObjectTypein the case of FactoryBeans.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 ofgetObjectTypein the case of FactoryBeans.getBeansWithAnnotation(Class<? extends Annotation> annotationType) Find all beans which are annotated with the suppliedAnnotationtype, returning a Map of bean names with corresponding bean instances.Class<?>Determine the type of the bean with the given name.Class<?>Determine the type of the bean with the given name.booleanisPrototype(String name) Is this bean a prototype? That is, willBeanFactory.getBean(java.lang.String)always return independent instances?booleanisSingleton(String name) Is this bean a shared singleton? That is, willBeanFactory.getBean(java.lang.String)always return the same instance?booleanisTypeMatch(String name, Class<?> typeToMatch) Check whether the bean with the given name matches the specified type.booleanisTypeMatch(String name, ResolvableType typeToMatch) Check whether the bean with the given name matches the specified type.
-
Constructor Details
-
StaticListableBeanFactory
public StaticListableBeanFactory()Create a regularStaticListableBeanFactory, to be populated with singleton bean instances throughaddBean(java.lang.String, java.lang.Object)calls. -
StaticListableBeanFactory
Create aStaticListableBeanFactorywrapping the givenMap.Note that the given
Mapmay be pre-populated with beans; or new, still allowing for beans to be registered viaaddBean(java.lang.String, java.lang.Object); orCollections.emptyMap()for a dummy factory which enforces operating against an empty set of beans.- Parameters:
beans- aMapfor holding this factory's beans, with the bean name as key and the corresponding singleton object as value- Since:
- 4.3
-
-
Method Details
-
addBean
Add a new singleton bean.Will overwrite any existing instance for the given name.
- Parameters:
name- the name of the beanbean- the bean instance
-
getBean
Description copied from interface:BeanFactoryReturn an instance, which may be shared or independent, of the specified bean.This 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.
- Specified by:
getBeanin interfaceBeanFactory- Parameters:
name- the name of the bean to retrieve- Returns:
- an instance of the bean
- Throws:
NoSuchBeanDefinitionException- if there is no bean with the specified nameBeansException- if the bean could not be obtained
-
getBean
Description copied from interface:BeanFactoryReturn an instance, which may be shared or independent, of the specified bean.Behaves 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 withBeanFactory.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.
- Specified by:
getBeanin interfaceBeanFactory- Parameters:
name- the name of the bean to retrieverequiredType- type the bean must match; can be an interface or superclass- Returns:
- an instance of the bean
- Throws:
NoSuchBeanDefinitionException- if there is no such bean definitionBeanNotOfRequiredTypeException- if the bean is not of the required typeBeansException- if the bean could not be created
-
getBean
Description copied from interface:BeanFactoryReturn an instance, which may be shared or independent, of the specified bean.Allows for specifying explicit constructor arguments / factory method arguments, overriding the specified default arguments (if any) in the bean definition.
- Specified by:
getBeanin interfaceBeanFactory- Parameters:
name- 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)- Returns:
- an instance of the bean
- Throws:
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 created
-
getBean
Description copied from interface:BeanFactoryReturn the bean instance that uniquely matches the given object type, if any.This method goes into
ListableBeanFactoryby-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, useListableBeanFactoryand/orBeanFactoryUtils.- Specified by:
getBeanin interfaceBeanFactory- Parameters:
requiredType- type the bean must match; can be an interface or superclass- Returns:
- an instance of the single bean matching the required type
- Throws:
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 created- See Also:
-
getBean
Description copied from interface:BeanFactoryReturn an instance, which may be shared or independent, of the specified bean.Allows for specifying explicit constructor arguments / factory method arguments, overriding the specified default arguments (if any) in the bean definition.
This method goes into
ListableBeanFactoryby-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, useListableBeanFactoryand/orBeanFactoryUtils.- Specified by:
getBeanin interfaceBeanFactory- Parameters:
requiredType- type the bean must match; can be an interface or superclassargs- 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)- Returns:
- an instance of the bean
- Throws:
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 created
-
getBeanProvider
Description copied from interface:BeanFactoryReturn a provider for the specified bean, allowing for lazy on-demand retrieval of instances, including availability and uniqueness options.For matching a generic type, consider
BeanFactory.getBeanProvider(ResolvableType).- Specified by:
getBeanProviderin interfaceBeanFactory- Parameters:
requiredType- type the bean must match; can be an interface or superclass- Returns:
- a corresponding provider handle
- Throws:
BeansException- See Also:
-
getBeanProvider
Description copied from interface:BeanFactoryReturn a provider for the specified bean, allowing for lazy on-demand retrieval of instances, including availability and uniqueness options. This variant allows for specifying a generic type to match, similar to reflective injection points with generic type declarations in method/constructor parameters.Note that collections of beans are not supported here, in contrast to reflective injection points. For programmatically retrieving a list of beans matching a specific type, specify the actual bean type as an argument here and subsequently use
ObjectProvider.orderedStream()or its lazy streaming/iteration options.Also, generics matching is strict here, as per the Java assignment rules. For lenient fallback matching with unchecked semantics (similar to the ´unchecked´ Java compiler warning), consider calling
BeanFactory.getBeanProvider(Class)with the raw type as a second step if no full generic match isavailablewith this variant.- Specified by:
getBeanProviderin interfaceBeanFactory- Parameters:
requiredType- type the bean must match; can be a generic type declaration- Returns:
- a corresponding provider handle
- See Also:
-
containsBean
Description copied from interface:BeanFactoryDoes this bean factory contain a bean definition or externally registered singleton instance with the given name?If 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
truewhether the named bean definition is concrete or abstract, lazy or eager, in scope or not. Therefore, note that atruereturn value from this method does not necessarily indicate thatBeanFactory.getBean(java.lang.String)will be able to obtain an instance for the same name.- Specified by:
containsBeanin interfaceBeanFactory- Parameters:
name- the name of the bean to query- Returns:
- whether a bean with the given name is present
-
isSingleton
Description copied from interface:BeanFactoryIs this bean a shared singleton? That is, willBeanFactory.getBean(java.lang.String)always return the same instance?Note: This method returning
falsedoes not clearly indicate independent instances. It indicates non-singleton instances, which may correspond to a scoped bean as well. Use theBeanFactory.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.
- Specified by:
isSingletonin interfaceBeanFactory- Parameters:
name- the name of the bean to query- Returns:
- whether this bean corresponds to a singleton instance
- Throws:
NoSuchBeanDefinitionException- if there is no bean with the given name- See Also:
-
isPrototype
Description copied from interface:BeanFactoryIs this bean a prototype? That is, willBeanFactory.getBean(java.lang.String)always return independent instances?Note: This method returning
falsedoes not clearly indicate a singleton object. It indicates non-independent instances, which may correspond to a scoped bean as well. Use theBeanFactory.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.
- Specified by:
isPrototypein interfaceBeanFactory- Parameters:
name- the name of the bean to query- Returns:
- whether this bean will always deliver independent instances
- Throws:
NoSuchBeanDefinitionException- if there is no bean with the given name- See Also:
-
isTypeMatch
public boolean isTypeMatch(String name, ResolvableType typeToMatch) throws NoSuchBeanDefinitionException Description copied from interface:BeanFactoryCheck whether the bean with the given name matches the specified type. More specifically, check whether aBeanFactory.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.
- Specified by:
isTypeMatchin interfaceBeanFactory- Parameters:
name- the name of the bean to querytypeToMatch- the type to match against (as aResolvableType)- Returns:
trueif the bean type matches,falseif it doesn't match or cannot be determined yet- Throws:
NoSuchBeanDefinitionException- if there is no bean with the given name- See Also:
-
isTypeMatch
public boolean isTypeMatch(String name, @Nullable Class<?> typeToMatch) throws NoSuchBeanDefinitionException Description copied from interface:BeanFactoryCheck whether the bean with the given name matches the specified type. More specifically, check whether aBeanFactory.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.
- Specified by:
isTypeMatchin interfaceBeanFactory- Parameters:
name- the name of the bean to querytypeToMatch- the type to match against (as aClass)- Returns:
trueif the bean type matches,falseif it doesn't match or cannot be determined yet- Throws:
NoSuchBeanDefinitionException- if there is no bean with the given name- See Also:
-
getType
Description copied from interface:BeanFactoryDetermine the type of the bean with the given name. More specifically, determine the type of object thatBeanFactory.getBean(java.lang.String)would return for the given name.For a
FactoryBean, return the type of object that the FactoryBean creates, as exposed byFactoryBean.getObjectType(). This may lead to the initialization of a previously uninitializedFactoryBean(seeBeanFactory.getType(String, boolean)).Translates aliases back to the corresponding canonical bean name.
Will ask the parent factory if the bean cannot be found in this factory instance.
- Specified by:
getTypein interfaceBeanFactory- Parameters:
name- the name of the bean to query- Returns:
- the type of the bean, or
nullif not determinable - Throws:
NoSuchBeanDefinitionException- if there is no bean with the given name- See Also:
-
getType
public Class<?> getType(String name, boolean allowFactoryBeanInit) throws NoSuchBeanDefinitionException Description copied from interface:BeanFactoryDetermine the type of the bean with the given name. More specifically, determine the type of object thatBeanFactory.getBean(java.lang.String)would return for the given name.For a
FactoryBean, return the type of object that the FactoryBean creates, as exposed byFactoryBean.getObjectType(). Depending on theallowFactoryBeanInitflag, this may lead to the initialization of a previously uninitializedFactoryBeanif no early type information is available.Translates aliases back to the corresponding canonical bean name.
Will ask the parent factory if the bean cannot be found in this factory instance.
- Specified by:
getTypein interfaceBeanFactory- Parameters:
name- the name of the bean to queryallowFactoryBeanInit- whether aFactoryBeanmay get initialized just for the purpose of determining its object type- Returns:
- the type of the bean, or
nullif not determinable - Throws:
NoSuchBeanDefinitionException- if there is no bean with the given name- See Also:
-
getAliases
Description copied from interface:BeanFactoryReturn the aliases for the given bean name, if any.All of those aliases point to the same bean when used in a
BeanFactory.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.
- Specified by:
getAliasesin interfaceBeanFactory- Parameters:
name- the bean name to check for aliases- Returns:
- the aliases, or an empty array if none
- See Also:
-
containsBeanDefinition
Description copied from interface:ListableBeanFactoryCheck if this bean factory contains a bean definition with the given name.Does not consider any hierarchy this factory may participate in, and ignores any singleton beans that have been registered by other means than bean definitions.
- Specified by:
containsBeanDefinitionin interfaceListableBeanFactory- Parameters:
name- the name of the bean to look for- Returns:
- if this bean factory contains a bean definition with the given name
- See Also:
-
getBeanDefinitionCount
public int getBeanDefinitionCount()Description copied from interface:ListableBeanFactoryReturn the number of beans defined in the factory.Does not consider any hierarchy this factory may participate in, and ignores any singleton beans that have been registered by other means than bean definitions.
- Specified by:
getBeanDefinitionCountin interfaceListableBeanFactory- Returns:
- the number of beans defined in the factory
-
getBeanDefinitionNames
Description copied from interface:ListableBeanFactoryReturn the names of all beans defined in this factory.Does not consider any hierarchy this factory may participate in, and ignores any singleton beans that have been registered by other means than bean definitions.
- Specified by:
getBeanDefinitionNamesin interfaceListableBeanFactory- Returns:
- the names of all beans defined in this factory, or an empty array if none defined
-
getBeanProvider
Description copied from interface:ListableBeanFactoryReturn a provider for the specified bean, allowing for lazy on-demand retrieval of instances, including availability and uniqueness options.- Specified by:
getBeanProviderin interfaceListableBeanFactory- Parameters:
requiredType- type the bean must match; can be an interface or superclassallowEagerInit- whether stream-based access may initialize lazy-init singletons and objects created by FactoryBeans (or by factory methods with a "factory-bean" reference) for the type check- Returns:
- a corresponding provider handle
- See Also:
-
getBeanProvider
Description copied from interface:ListableBeanFactoryReturn a provider for the specified bean, allowing for lazy on-demand retrieval of instances, including availability and uniqueness options.- Specified by:
getBeanProviderin interfaceListableBeanFactory- Parameters:
requiredType- type the bean must match; can be a generic type declaration. Note that collection types are not supported here, in contrast to reflective injection points. For programmatically retrieving a list of beans matching a specific type, specify the actual bean type as an argument here and subsequently useObjectProvider.orderedStream()or its lazy streaming/iteration options.allowEagerInit- whether stream-based access may initialize lazy-init singletons and objects created by FactoryBeans (or by factory methods with a "factory-bean" reference) for the type check- Returns:
- a corresponding provider handle
- See Also:
-
getBeanNamesForType
Description copied from interface:ListableBeanFactoryReturn the names of beans matching the given type (including subclasses), judging from either bean definitions or the value ofgetObjectTypein 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'
beanNamesForTypeIncludingAncestorsto 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
getBeanNamesForTypematches all kinds of beans, be it singletons, prototypes, or FactoryBeans. In most implementations, the result will be the same as forgetBeanNamesForType(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.
- Specified by:
getBeanNamesForTypein interfaceListableBeanFactory- Parameters:
type- the generically typed class or interface to match- Returns:
- the names of beans (or objects created by FactoryBeans) matching the given object type (including subclasses), or an empty array if none
- See Also:
-
getBeanNamesForType
public String[] getBeanNamesForType(@Nullable ResolvableType type, boolean includeNonSingletons, boolean allowEagerInit) Description copied from interface:ListableBeanFactoryReturn the names of beans matching the given type (including subclasses), judging from either bean definitions or the value ofgetObjectTypein 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'
beanNamesForTypeIncludingAncestorsto 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.
- Specified by:
getBeanNamesForTypein interfaceListableBeanFactory- Parameters:
type- the generically typed class or interface to matchincludeNonSingletons- 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.- Returns:
- the names of beans (or objects created by FactoryBeans) matching the given object type (including subclasses), or an empty array if none
- See Also:
-
getBeanNamesForType
Description copied from interface:ListableBeanFactoryReturn the names of beans matching the given type (including subclasses), judging from either bean definitions or the value ofgetObjectTypein 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'
beanNamesForTypeIncludingAncestorsto 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
getBeanNamesForTypematches all kinds of beans, be it singletons, prototypes, or FactoryBeans. In most implementations, the result will be the same as forgetBeanNamesForType(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.
- Specified by:
getBeanNamesForTypein interfaceListableBeanFactory- Parameters:
type- the class or interface to match, ornullfor all bean names- Returns:
- the names of beans (or objects created by FactoryBeans) matching the given object type (including subclasses), or an empty array if none
- See Also:
-
getBeanNamesForType
public String[] getBeanNamesForType(@Nullable Class<?> type, boolean includeNonSingletons, boolean allowEagerInit) Description copied from interface:ListableBeanFactoryReturn the names of beans matching the given type (including subclasses), judging from either bean definitions or the value ofgetObjectTypein 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'
beanNamesForTypeIncludingAncestorsto 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.
- Specified by:
getBeanNamesForTypein interfaceListableBeanFactory- Parameters:
type- the class or interface to match, ornullfor 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.- Returns:
- the names of beans (or objects created by FactoryBeans) matching the given object type (including subclasses), or an empty array if none
- See Also:
-
getBeansOfType
Description copied from interface:ListableBeanFactoryReturn the bean instances that match the given object type (including subclasses), judging from either bean definitions or the value ofgetObjectTypein 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'
beansOfTypeIncludingAncestorsto 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.
- Specified by:
getBeansOfTypein interfaceListableBeanFactory- Parameters:
type- the class or interface to match, ornullfor all concrete beans- Returns:
- a Map with the matching beans, containing the bean names as keys and the corresponding bean instances as values
- Throws:
BeansException- if a bean could not be created- See Also:
-
getBeansOfType
public <T> Map<String,T> getBeansOfType(@Nullable Class<T> type, boolean includeNonSingletons, boolean allowEagerInit) throws BeansException Description copied from interface:ListableBeanFactoryReturn the bean instances that match the given object type (including subclasses), judging from either bean definitions or the value ofgetObjectTypein 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'
beansOfTypeIncludingAncestorsto 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.
- Specified by:
getBeansOfTypein interfaceListableBeanFactory- Parameters:
type- the class or interface to match, ornullfor 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.- Returns:
- a Map with the matching beans, containing the bean names as keys and the corresponding bean instances as values
- Throws:
BeansException- if a bean could not be created- See Also:
-
getBeanNamesForAnnotation
Description copied from interface:ListableBeanFactoryFind all names of beans which are annotated with the suppliedAnnotationtype, without creating corresponding bean instances yet.Note that this method considers objects created by FactoryBeans, which means that FactoryBeans will get initialized in order to determine their object type.
- Specified by:
getBeanNamesForAnnotationin interfaceListableBeanFactory- Parameters:
annotationType- the type of annotation to look for (at class, interface or factory method level of the specified bean)- Returns:
- the names of all matching beans
- See Also:
-
getBeansWithAnnotation
public Map<String,Object> getBeansWithAnnotation(Class<? extends Annotation> annotationType) throws BeansException Description copied from interface:ListableBeanFactoryFind all beans which are annotated with the suppliedAnnotationtype, returning a Map of bean names with corresponding bean instances.Note that this method considers objects created by FactoryBeans, which means that FactoryBeans will get initialized in order to determine their object type.
- Specified by:
getBeansWithAnnotationin interfaceListableBeanFactory- Parameters:
annotationType- the type of annotation to look for (at class, interface or factory method level of the specified bean)- Returns:
- a Map with the matching beans, containing the bean names as keys and the corresponding bean instances as values
- Throws:
BeansException- if a bean could not be created- See Also:
-
findAnnotationOnBean
@Nullable public <A extends Annotation> A findAnnotationOnBean(String beanName, Class<A> annotationType) throws NoSuchBeanDefinitionException Description copied from interface:ListableBeanFactoryFind anAnnotationofannotationTypeon the specified bean, traversing its interfaces and super classes if no annotation can be found on the given class itself, as well as checking the bean's factory method (if any).- Specified by:
findAnnotationOnBeanin interfaceListableBeanFactory- Parameters:
beanName- the name of the bean to look for annotations onannotationType- the type of annotation to look for (at class, interface or factory method level of the specified bean)- Returns:
- the annotation of the given type if found, or
nullotherwise - Throws:
NoSuchBeanDefinitionException- if there is no bean with the given name- See Also:
-
findAnnotationOnBean
@Nullable public <A extends Annotation> A findAnnotationOnBean(String beanName, Class<A> annotationType, boolean allowFactoryBeanInit) throws NoSuchBeanDefinitionException Description copied from interface:ListableBeanFactoryFind anAnnotationofannotationTypeon the specified bean, traversing its interfaces and super classes if no annotation can be found on the given class itself, as well as checking the bean's factory method (if any).- Specified by:
findAnnotationOnBeanin interfaceListableBeanFactory- Parameters:
beanName- the name of the bean to look for annotations onannotationType- the type of annotation to look for (at class, interface or factory method level of the specified bean)allowFactoryBeanInit- whether aFactoryBeanmay get initialized just for the purpose of determining its object type- Returns:
- the annotation of the given type if found, or
nullotherwise - Throws:
NoSuchBeanDefinitionException- if there is no bean with the given name- See Also:
-