所有超级接口:
BeanFactory
所有已知子接口:
ApplicationContext, ConfigurableApplicationContext, ConfigurableListableBeanFactory, ConfigurablePortletApplicationContext, ConfigurableWebApplicationContext, WebApplicationContext
所有已知实现类:
AbstractApplicationContext, AbstractRefreshableApplicationContext, AbstractRefreshableConfigApplicationContext, AbstractRefreshablePortletApplicationContext, AbstractRefreshableWebApplicationContext, AbstractXmlApplicationContext, AnnotationConfigApplicationContext, AnnotationConfigWebApplicationContext, ClassPathXmlApplicationContext, DefaultListableBeanFactory, FileSystemXmlApplicationContext, GenericApplicationContext, GenericGroovyApplicationContext, GenericWebApplicationContext, GenericXmlApplicationContext, GroovyWebApplicationContext, ResourceAdapterApplicationContext, StaticApplicationContext, StaticListableBeanFactory, StaticPortletApplicationContext, StaticWebApplicationContext, XmlBeanFactory, XmlPortletApplicationContext, 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 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 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 differentiation.
NOTE: With the exception of getBeanDefinitionCount and containsBeanDefinition, the methods in this interface are not designed for frequent invocation. Implementations may be slow.
从以下版本开始:
16 April 2001
作者:
Rod Johnson, Juergen Hoeller
另请参阅:
HierarchicalBeanFactory, BeanFactoryUtils

字段概要
- 从接口继承的字段 org.springframework.beans.factory.BeanFactory
  FACTORY_BEAN_PREFIX

方法概要

所有方法实例方法抽象方法
修饰符和类型	方法	说明
`boolean`	`containsBeanDefinition(String beanName)`	Check if this bean factory contains a bean definition with the given name.
`<A extends Annotation> A`	`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.
`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 which are annotated with the supplied `Annotation` type, 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 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(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 which are annotated with the supplied `Annotation` type, returning a Map of bean names with corresponding bean instances.

从接口继承的方法 org.springframework.beans.factory.BeanFactory
containsBean, getAliases, getBean, getBean, getBean, getBean, getBean, getType, isPrototype, isSingleton, isTypeMatch, isTypeMatch

- 方法详细资料
  - containsBeanDefinition
```
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.
    参数:
    beanName - the name of the bean to look for
    返回:
    if this bean factory contains a bean definition with the given name
    另请参阅:
    BeanFactory.containsBean(java.lang.String)
  - getBeanDefinitionCount
```
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.
    返回:
    the number of beans defined in the factory
  - getBeanDefinitionNames
```
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.
    返回:
    the names of all beans defined in this factory, or an empty array if none defined
  - getBeanNamesForType
```
String[] getBeanNamesForType(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.
    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.
    参数:
    type - the class or interface to match, or null for all bean names
    返回:
    the names of beans (or objects created by FactoryBeans) matching the given object type (including subclasses), or an empty array if none
    从以下版本开始:
    4.2
    另请参阅:
    BeanFactory.isTypeMatch(String, ResolvableType), FactoryBean.getObjectType(), BeanFactoryUtils.beanNamesForTypeIncludingAncestors(ListableBeanFactory, ResolvableType)
  - getBeanNamesForType
```
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 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.
    参数:
    type - the class or interface to match, or null for all bean names
    返回:
    the names of beans (or objects created by FactoryBeans) matching the given object type (including subclasses), or an empty array if none
    另请参阅:
    FactoryBean.getObjectType(), BeanFactoryUtils.beanNamesForTypeIncludingAncestors(ListableBeanFactory, Class)
  - getBeanNamesForType
```
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.
    参数:
    type - the class or interface to match, or null for all bean names
    includeNonSingletons - 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.
    返回:
    the names of beans (or objects created by FactoryBeans) matching the given object type (including subclasses), or an empty array if none
    另请参阅:
    FactoryBean.getObjectType(), BeanFactoryUtils.beanNamesForTypeIncludingAncestors(ListableBeanFactory, Class, boolean, boolean)
  - getBeansOfType
```
<T> Map<String,T> getBeansOfType(Class<T> 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.
    参数:
    type - the class or interface to match, or null for all concrete beans
    返回:
    a Map with the matching beans, containing the bean names as keys and the corresponding bean instances as values
    抛出:
    BeansException - if a bean could not be created
    从以下版本开始:
    1.1.2
    另请参阅:
    FactoryBean.getObjectType(), BeanFactoryUtils.beansOfTypeIncludingAncestors(ListableBeanFactory, Class)
  - getBeansOfType
```
<T> Map<String,T> getBeansOfType(Class<T> 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.
    参数:
    type - the class or interface to match, or null for all concrete beans
    includeNonSingletons - 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.
    返回:
    a Map with the matching beans, containing the bean names as keys and the corresponding bean instances as values
    抛出:
    BeansException - if a bean could not be created
    另请参阅:
    FactoryBean.getObjectType(), BeanFactoryUtils.beansOfTypeIncludingAncestors(ListableBeanFactory, Class, boolean, boolean)
  - getBeanNamesForAnnotation
```
String[] getBeanNamesForAnnotation(Class<? extends Annotation> annotationType)
```
    Find all names of beans which are annotated with the supplied Annotation type, 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.
    参数:
    annotationType - the type of annotation to look for
    返回:
    the names of all matching beans
    从以下版本开始:
    4.0
    另请参阅:
    findAnnotationOnBean(java.lang.String, java.lang.Class<A>)
  - getBeansWithAnnotation
```
Map<String,Object> getBeansWithAnnotation(Class<? extends Annotation> annotationType)
                                         throws BeansException
```
    Find all beans which are annotated with the supplied Annotation type, 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.
    参数:
    annotationType - the type of annotation to look for
    返回:
    a Map with the matching beans, containing the bean names as keys and the corresponding bean instances as values
    抛出:
    BeansException - if a bean could not be created
    从以下版本开始:
    3.0
    另请参阅:
    findAnnotationOnBean(java.lang.String, java.lang.Class<A>)
  - findAnnotationOnBean
```
<A extends Annotation> A findAnnotationOnBean(String beanName,
                                              Class<A> annotationType)
                                       throws NoSuchBeanDefinitionException
```
    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.
    参数:
    beanName - the name of the bean to look for annotations on
    annotationType - the type of annotation to look for
    返回:
    the annotation of the given type if found, or null otherwise
    抛出:
    NoSuchBeanDefinitionException - if there is no bean with the given name
    从以下版本开始:
    3.0
    另请参阅:
    getBeanNamesForAnnotation(java.lang.Class<? extends java.lang.annotation.Annotation>), getBeansWithAnnotation(java.lang.Class<? extends java.lang.annotation.Annotation>)

接口 ListableBeanFactory

字段概要

从接口继承的字段 org.springframework.beans.factory.BeanFactory

方法概要

从接口继承的方法 org.springframework.beans.factory.BeanFactory

方法详细资料

containsBeanDefinition

getBeanDefinitionCount

getBeanDefinitionNames

getBeanNamesForType

getBeanNamesForType

getBeanNamesForType

getBeansOfType

getBeansOfType

getBeanNamesForAnnotation

getBeansWithAnnotation

findAnnotationOnBean