org.springframework.beans.factory
Interface ListableBeanFactory

All Superinterfaces:

BeanFactory

All Known Subinterfaces:

ApplicationContext, ConfigurableApplicationContext, ConfigurableListableBeanFactory, ConfigurableWebApplicationContext, WebApplicationContext

All Known Implementing Classes:

AbstractApplicationContext, DefaultListableBeanFactory, StaticListableBeanFactory, StaticWebApplicationContext, XmlWebApplicationContext

public interface ListableBeanFactory

extends BeanFactory

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 get all beans.

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. Use BeanFactory's methods to access such beans. In typical scenarios, all beans will be defined by bean definitions anyway.

With the exception of getBeanDefinitionCount(), the methods in this interface are not designed for frequent invocation. Implementations may be slow.

Since:

16 April 2001

Author:

Rod Johnson, Juergen Hoeller

See Also:

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 name) 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.
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

getBeanDefinitionCount

public int getBeanDefinitionCount()

Return the number of beans defined in the factory. Does not consider any hierarchy this factory may participate in.

Note: Ignores any singleton beans that have been registered by other means than bean definitions.

Returns:

the number of beans defined in the factory

See Also:

BeanFactoryUtils.countBeansIncludingAncestors(org.springframework.beans.factory.ListableBeanFactory)

getBeanDefinitionNames

public String[] getBeanDefinitionNames()

Return the names of all beans defined in this factory. Does not consider any hierarchy this factory may participate in.

Note: Ignores any singleton beans that have been registered by other means than bean definitions.

Returns:

the names of all beans defined in this factory, or an empty array if none defined

See Also:

BeanFactoryUtils.beanNamesIncludingAncestors(ListableBeanFactory)

getBeanDefinitionNames

public String[] getBeanDefinitionNames(Class type)

Return the names of beans matching the given type (including subclasses), judging from the bean definitions. Will not consider FactoryBeans, as the type of their created objects is not known before instantiation. Does not consider any hierarchy this factory may participate in.

Note: Ignores any singleton beans that have been registered by other means than bean definitions.

Parameters:

type - the class or interface to match, or null for all bean names

Returns:

the names of beans matching the given object type (including subclasses), or an empty array if none

See Also:

BeanFactoryUtils.beanNamesIncludingAncestors(ListableBeanFactory, Class)

containsBeanDefinition

public boolean containsBeanDefinition(String name)

Check if this bean factory contains a bean definition with the given name. Does not consider any hierarchy this factory may participate in.

Note: Ignores any singleton beans that have been registered by other means than bean definitions.

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:

BeanFactory.containsBean(java.lang.String)

getBeansOfType

public Map getBeansOfType(Class type)
                   throws BeansException

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. Does not consider any hierarchy this factory may participate in.

If FactoryBean's getObjectType() returns null and the bean is a singleton, the type of the actually created objects should be evaluated. Prototypes without explicit object type specification should be ignored.

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).

Parameters:

type - the class or interface to match, or null for 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 the beans could not be created

Since:

1.1.2

See Also:

FactoryBean.getObjectType(), BeanFactoryUtils.beansOfTypeIncludingAncestors(ListableBeanFactory, Class)

getBeansOfType

public Map getBeansOfType(Class type,
                          boolean includePrototypes,
                          boolean includeFactoryBeans)
                   throws BeansException

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. Does not consider any hierarchy this factory may participate in.

If FactoryBean's getObjectType() returns null and the bean is a singleton, the type of the actually created objects should be evaluated. Prototypes without explicit object type specification should be ignored.

Note: Does not ignore singleton beans that have been registered by other means than bean definitions.

Parameters:

type - the class or interface to match, or null for all concrete beans

includePrototypes - whether to include prototype beans too or just singletons (also applies to FactoryBeans)

includeFactoryBeans - whether to include FactoryBeans too or just conventional beans

Returns:

a Map with the matching beans, containing the bean names as keys and the corresponding bean instances as values

Throws:

BeansException - if the beans could not be created

See Also:

FactoryBean.getObjectType(), BeanFactoryUtils.beansOfTypeIncludingAncestors(ListableBeanFactory, Class, boolean, boolean)