org.springframework.beans.factory

Interface ListableBeanFactory

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method and Description
      boolean containsBeanDefinition(java.lang.String beanName)
      Check if this bean factory contains a bean definition with the given name.
      <A extends java.lang.annotation.Annotation>
      A
      findAnnotationOnBean(java.lang.String beanName, java.lang.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.
      java.lang.String[] getBeanDefinitionNames()
      Return the names of all beans defined in this factory.
      java.lang.String[] getBeanNamesForAnnotation(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType)
      Find all names of beans whose Class has the supplied Annotation type, without creating any bean instances yet.
      java.lang.String[] getBeanNamesForType(java.lang.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.
      java.lang.String[] getBeanNamesForType(java.lang.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.
      java.lang.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> java.util.Map<java.lang.String,T> getBeansOfType(java.lang.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> java.util.Map<java.lang.String,T> getBeansOfType(java.lang.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.
      java.util.Map<java.lang.String,java.lang.Object> getBeansWithAnnotation(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType)
      Find all beans whose Class has the supplied Annotation type, returning a Map of bean names with corresponding bean instances.
    • Method Detail

      • containsBeanDefinition

        boolean containsBeanDefinition(java.lang.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.

        Parameters:
        beanName - 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)
      • 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.

        Returns:
        the number of beans defined in the factory
      • getBeanDefinitionNames

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

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

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

        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
        Since:
        4.2
        See Also:
        BeanFactory.isTypeMatch(String, ResolvableType), FactoryBean.getObjectType(), BeanFactoryUtils.beanNamesForTypeIncludingAncestors(ListableBeanFactory, ResolvableType)
      • getBeanNamesForType

        java.lang.String[] getBeanNamesForType(@Nullable
                                               java.lang.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.

        Parameters:
        type - the class or interface to match, or null for 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:
        FactoryBean.getObjectType(), BeanFactoryUtils.beanNamesForTypeIncludingAncestors(ListableBeanFactory, Class)
      • getBeanNamesForType

        java.lang.String[] getBeanNamesForType(@Nullable
                                               java.lang.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.

        Parameters:
        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.
        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:
        FactoryBean.getObjectType(), BeanFactoryUtils.beanNamesForTypeIncludingAncestors(ListableBeanFactory, Class, boolean, boolean)
      • getBeansOfType

        <T> java.util.Map<java.lang.String,T> getBeansOfType(@Nullable
                                                             java.lang.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.

        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 a bean could not be created
        Since:
        1.1.2
        See Also:
        FactoryBean.getObjectType(), BeanFactoryUtils.beansOfTypeIncludingAncestors(ListableBeanFactory, Class)
      • getBeansOfType

        <T> java.util.Map<java.lang.String,T> getBeansOfType(@Nullable
                                                             java.lang.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.

        Parameters:
        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.
        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:
        FactoryBean.getObjectType(), BeanFactoryUtils.beansOfTypeIncludingAncestors(ListableBeanFactory, Class, boolean, boolean)
      • getBeanNamesForAnnotation

        java.lang.String[] getBeanNamesForAnnotation(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType)
        Find all names of beans whose Class has the supplied Annotation type, without creating any bean instances yet.
        Parameters:
        annotationType - the type of annotation to look for
        Returns:
        the names of all matching beans
        Since:
        4.0
      • getBeansWithAnnotation

        java.util.Map<java.lang.String,java.lang.Object> getBeansWithAnnotation(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType)
                                                                         throws BeansException
        Find all beans whose Class has the supplied Annotation type, returning a Map of bean names with corresponding bean instances.
        Parameters:
        annotationType - the type of annotation to look for
        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
        Since:
        3.0
      • findAnnotationOnBean

        @Nullable
        <A extends java.lang.annotation.Annotation> A findAnnotationOnBean(java.lang.String beanName,
                                                                                     java.lang.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.
        Parameters:
        beanName - the name of the bean to look for annotations on
        annotationType - the annotation class to look for
        Returns:
        the annotation of the given type if found, or null otherwise
        Throws:
        NoSuchBeanDefinitionException - if there is no bean with the given name
        Since:
        3.0