|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Extension of the BeanFactory interface to be implemented by bean factories that can enumerate all their bean instances, rather than attempting bean lookup by name one by one as requested by clients. BeanFactory implementations that preload all their beans (for example, DOM-based XML factories) may implement this interface. This interface is discussed in "Expert One-on-One J2EE Design and Development", by Rod Johnson.
If this is a HierarchicalBeanFactory, the return values will not take any BeanFactory hierarchy into account, but will relate only to the beans defined in the current factory. Use the BeanFactoryUtils helper class to consider beans in ancestor factories too.
The methods in this interface will just respect bean definitions of this factory.
They will ignore any singleton beans that have been registered by other means like
ConfigurableBeanFactory's registerSingleton
method, with the exception
of getBeansOfType
which will match such manually registered singletons
too. Of course, BeanFactory's methods do allow access to such special beans too.
In typical scenarios, all beans will be defined by bean definitions anyway.
With the exception of getBeanDefinitionCount
and
containsBeanDefinition
, the methods in this interface are
not designed for frequent invocation. Implementations may be slow.
HierarchicalBeanFactory
,
BeanFactoryUtils
,
ConfigurableBeanFactory.registerSingleton(java.lang.String, java.lang.Object)
Field Summary |
Fields inherited from interface org.springframework.beans.factory.BeanFactory |
FACTORY_BEAN_PREFIX |
Method Summary | |
boolean |
containsBeanDefinition(String beanName)
Check if this bean factory contains a bean definition with the given name. |
int |
getBeanDefinitionCount()
Return the number of beans defined in the factory. |
String[] |
getBeanDefinitionNames()
Return the names of all beans defined in this factory. |
String[] |
getBeanDefinitionNames(Class type)
Return the names of beans matching the given type (including subclasses), judging from the bean definitions. |
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.
|
Map |
getBeansOfType(Class 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.
|
Map |
getBeansOfType(Class type,
boolean includePrototypes,
boolean includeFactoryBeans)
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.
|
Methods inherited from interface org.springframework.beans.factory.BeanFactory |
containsBean, getAliases, getBean, getBean, getType, isSingleton |
Method Detail |
public boolean containsBeanDefinition(String beanName)
Does not consider any hierarchy this factory may participate in.
Use containsBean
to check ancestor factories too.
Note: Ignores any singleton beans that have been registered by other means than bean definitions.
beanName
- the name of the bean to look for
BeanFactory.containsBean(java.lang.String)
public int getBeanDefinitionCount()
Does not consider any hierarchy this factory may participate in.
Use BeanFactoryUtils' countBeansIncludingAncestors
to include beans in ancestor factories too.
Note: Ignores any singleton beans that have been registered by other means than bean definitions.
BeanFactoryUtils.countBeansIncludingAncestors(org.springframework.beans.factory.ListableBeanFactory)
public String[] getBeanDefinitionNames()
Does not consider any hierarchy this factory may participate in.
Use BeanFactoryUtils' beanNamesIncludingAncestors
to include beans in ancestor factories too.
Note: Ignores any singleton beans that have been registered by other means than bean definitions.
BeanFactoryUtils.beanNamesIncludingAncestors(ListableBeanFactory)
public String[] getBeanDefinitionNames(Class type)
Does not consider objects created by FactoryBeans but rather the
FactoryBean classes themselves, avoiding instantiation of any beans. Use
getBeanNamesForType
to match objects created by FactoryBeans.
Does not consider any hierarchy this factory may participate in.
Use BeanFactoryUtils' beanNamesIncludingAncestors
to include beans in ancestor factories too.
Note: Ignores any singleton beans that have been registered by other means than bean definitions.
type
- the class or interface to match, or null for all bean names
getBeanNamesForType(java.lang.Class)
,
BeanFactoryUtils.beanNamesIncludingAncestors(ListableBeanFactory, Class)
public String[] getBeanNamesForType(Class type)
getObjectType
in the case of FactoryBeans.
Does consider objects created by FactoryBeans but rather the FactoryBean classes themselves, which means that FactoryBeans will get instantiated.
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.
type
- the class or interface to match, or null for all bean names
FactoryBean.getObjectType()
,
BeanFactoryUtils.beanNamesForTypeIncludingAncestors(ListableBeanFactory, Class)
public Map getBeansOfType(Class type) throws BeansException
getObjectType
in the case of FactoryBeans.
Does consider objects created by FactoryBeans but rather the FactoryBean classes themselves, which means that FactoryBeans will get instantiated.
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)
.
type
- the class or interface to match, or null for all concrete beans
BeansException
- if a bean could not be createdFactoryBean.getObjectType()
,
BeanFactoryUtils.beansOfTypeIncludingAncestors(ListableBeanFactory, Class)
public Map getBeansOfType(Class type, boolean includePrototypes, boolean includeFactoryBeans) throws BeansException
getObjectType
in the case of FactoryBeans.
Does consider objects created by FactoryBeans but rather the FactoryBean classes themselves, which means that FactoryBeans will get instantiated.
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.
type
- the class or interface to match, or null for all concrete beansincludePrototypes
- whether to include prototype beans too
or just singletons (also applies to FactoryBeans)includeFactoryBeans
- whether to include FactoryBeans too
or just conventional beans
BeansException
- if a bean could not be createdFactoryBean.getObjectType()
,
BeanFactoryUtils.beansOfTypeIncludingAncestors(ListableBeanFactory, Class, boolean, boolean)
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |