Save This Page
Home » spring-framework-2.5.5-with-dependencies » org.springframework » beans » factory » [javadoc | source]
org.springframework.beans.factory
public interface: ListableBeanFactory [javadoc | source]

All Implemented Interfaces:
    BeanFactory

All Known Implementing Classes:
    DefaultListableBeanFactory, XmlWebApplicationContext, StaticApplicationContext, ClassPathXmlApplicationContext, GenericApplicationContext, AbstractXmlApplicationContext, GenericWebApplicationContext, ResourceAdapterApplicationContext, AbstractRefreshableWebApplicationContext, ConfigurableApplicationContext, FileSystemXmlApplicationContext, AbstractRefreshableConfigApplicationContext, WebApplicationContext, ConfigurableWebApplicationContext, StaticPortletApplicationContext, XmlBeanFactory, StaticWebApplicationContext, AbstractApplicationContext, AbstractRefreshableApplicationContext, AbstractRefreshablePortletApplicationContext, StaticListableBeanFactory, XmlPortletApplicationContext, ConfigurablePortletApplicationContext, ConfigurableListableBeanFactory, ApplicationContext

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 bean definitions (such as XML-based factories) may implement this interface.

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 org.springframework.beans.factory.config.ConfigurableBeanFactory 's registerSingleton method, with the exception of getBeanNamesOfType and getBeansOfType which will check such manually registered singletons too. Of course, BeanFactory's getBean does allow transparent access to such special beans as well. However, in typical scenarios, all beans will be defined by external bean definitions anyway, so most applications don't need to worry about this differentation.

NOTE: With the exception of getBeanDefinitionCount and containsBeanDefinition, the methods in this interface are not designed for frequent invocation. Implementations may be slow.

Method from org.springframework.beans.factory.ListableBeanFactory Summary:
containsBeanDefinition,   getBeanDefinitionCount,   getBeanDefinitionNames,   getBeanNamesForType,   getBeanNamesForType,   getBeansOfType,   getBeansOfType
Method from org.springframework.beans.factory.ListableBeanFactory Detail:
 public boolean containsBeanDefinition(String beanName)
    Check 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.
 public int getBeanDefinitionCount()
    Return 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.
 public String[] getBeanDefinitionNames()
    Return 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.
 public 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.

    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 getBeanNamesOfType(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.
 public 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.

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

    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.
 public Map getBeansOfType(Class type,
    boolean includeNonSingletons,
    boolean allowEagerInit) 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.

    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.