org.springframework.beans.factory

Interface BeanFactory

    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String FACTORY_BEAN_PREFIX
      Used to dereference a FactoryBean instance and distinguish it from beans created by the FactoryBean.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method and Description
      boolean containsBean(java.lang.String name)
      Does this bean factory contain a bean definition or externally registered singleton instance with the given name?
      java.lang.String[] getAliases(java.lang.String name)
      Return the aliases for the given bean name, if any.
      <T> T getBean(java.lang.Class<T> requiredType)
      Return the bean instance that uniquely matches the given object type, if any.
      <T> T getBean(java.lang.Class<T> requiredType, java.lang.Object... args)
      Return an instance, which may be shared or independent, of the specified bean.
      java.lang.Object getBean(java.lang.String name)
      Return an instance, which may be shared or independent, of the specified bean.
      <T> T getBean(java.lang.String name, java.lang.Class<T> requiredType)
      Return an instance, which may be shared or independent, of the specified bean.
      java.lang.Object getBean(java.lang.String name, java.lang.Object... args)
      Return an instance, which may be shared or independent, of the specified bean.
      <T> ObjectProvider<T> getBeanProvider(java.lang.Class<T> requiredType)
      Return an provider for the specified bean, allowing for lazy on-demand retrieval of instances, including availability and uniqueness options.
      <T> ObjectProvider<T> getBeanProvider(ResolvableType requiredType)
      Return an provider for the specified bean, allowing for lazy on-demand retrieval of instances, including availability and uniqueness options.
      java.lang.Class<?> getType(java.lang.String name)
      Determine the type of the bean with the given name.
      boolean isPrototype(java.lang.String name)
      Is this bean a prototype? That is, will getBean(java.lang.String) always return independent instances?
      boolean isSingleton(java.lang.String name)
      Is this bean a shared singleton? That is, will getBean(java.lang.String) always return the same instance?
      boolean isTypeMatch(java.lang.String name, java.lang.Class<?> typeToMatch)
      Check whether the bean with the given name matches the specified type.
      boolean isTypeMatch(java.lang.String name, ResolvableType typeToMatch)
      Check whether the bean with the given name matches the specified type.
    • Field Detail

      • FACTORY_BEAN_PREFIX

        static final java.lang.String FACTORY_BEAN_PREFIX
        Used to dereference a FactoryBean instance and distinguish it from beans created by the FactoryBean. For example, if the bean named myJndiObject is a FactoryBean, getting &myJndiObject will return the factory, not the instance returned by the factory.
        See Also:
        Constant Field Values
    • Method Detail

      • getBean

        java.lang.Object getBean(java.lang.String name)
                          throws BeansException
        Return an instance, which may be shared or independent, of the specified bean.

        This method allows a Spring BeanFactory to be used as a replacement for the Singleton or Prototype design pattern. Callers may retain references to returned objects in the case of Singleton beans.

        Translates aliases back to the corresponding canonical bean name. Will ask the parent factory if the bean cannot be found in this factory instance.

        Parameters:
        name - the name of the bean to retrieve
        Returns:
        an instance of the bean
        Throws:
        NoSuchBeanDefinitionException - if there is no bean definition with the specified name
        BeansException - if the bean could not be obtained
      • getBean

        <T> T getBean(java.lang.String name,
                      java.lang.Class<T> requiredType)
               throws BeansException
        Return an instance, which may be shared or independent, of the specified bean.

        Behaves the same as getBean(String), but provides a measure of type safety by throwing a BeanNotOfRequiredTypeException if the bean is not of the required type. This means that ClassCastException can't be thrown on casting the result correctly, as can happen with getBean(String).

        Translates aliases back to the corresponding canonical bean name. Will ask the parent factory if the bean cannot be found in this factory instance.

        Parameters:
        name - the name of the bean to retrieve
        requiredType - type the bean must match; can be an interface or superclass
        Returns:
        an instance of the bean
        Throws:
        NoSuchBeanDefinitionException - if there is no such bean definition
        BeanNotOfRequiredTypeException - if the bean is not of the required type
        BeansException - if the bean could not be created
      • getBean

        java.lang.Object getBean(java.lang.String name,
                                 java.lang.Object... args)
                          throws BeansException
        Return an instance, which may be shared or independent, of the specified bean.

        Allows for specifying explicit constructor arguments / factory method arguments, overriding the specified default arguments (if any) in the bean definition.

        Parameters:
        name - the name of the bean to retrieve
        args - arguments to use when creating a bean instance using explicit arguments (only applied when creating a new instance as opposed to retrieving an existing one)
        Returns:
        an instance of the bean
        Throws:
        NoSuchBeanDefinitionException - if there is no such bean definition
        BeanDefinitionStoreException - if arguments have been given but the affected bean isn't a prototype
        BeansException - if the bean could not be created
        Since:
        2.5
      • getBean

        <T> T getBean(java.lang.Class<T> requiredType)
               throws BeansException
        Return the bean instance that uniquely matches the given object type, if any.

        This method goes into ListableBeanFactory by-type lookup territory but may also be translated into a conventional by-name lookup based on the name of the given type. For more extensive retrieval operations across sets of beans, use ListableBeanFactory and/or BeanFactoryUtils.

        Parameters:
        requiredType - type the bean must match; can be an interface or superclass
        Returns:
        an instance of the single bean matching the required type
        Throws:
        NoSuchBeanDefinitionException - if no bean of the given type was found
        NoUniqueBeanDefinitionException - if more than one bean of the given type was found
        BeansException - if the bean could not be created
        Since:
        3.0
        See Also:
        ListableBeanFactory
      • getBean

        <T> T getBean(java.lang.Class<T> requiredType,
                      java.lang.Object... args)
               throws BeansException
        Return an instance, which may be shared or independent, of the specified bean.

        Allows for specifying explicit constructor arguments / factory method arguments, overriding the specified default arguments (if any) in the bean definition.

        This method goes into ListableBeanFactory by-type lookup territory but may also be translated into a conventional by-name lookup based on the name of the given type. For more extensive retrieval operations across sets of beans, use ListableBeanFactory and/or BeanFactoryUtils.

        Parameters:
        requiredType - type the bean must match; can be an interface or superclass
        args - arguments to use when creating a bean instance using explicit arguments (only applied when creating a new instance as opposed to retrieving an existing one)
        Returns:
        an instance of the bean
        Throws:
        NoSuchBeanDefinitionException - if there is no such bean definition
        BeanDefinitionStoreException - if arguments have been given but the affected bean isn't a prototype
        BeansException - if the bean could not be created
        Since:
        4.1
      • getBeanProvider

        <T> ObjectProvider<T> getBeanProvider(java.lang.Class<T> requiredType)
        Return an provider for the specified bean, allowing for lazy on-demand retrieval of instances, including availability and uniqueness options.
        Parameters:
        requiredType - type the bean must match; can be an interface or superclass
        Returns:
        a corresponding provider handle
        Since:
        5.1
        See Also:
        getBeanProvider(ResolvableType)
      • getBeanProvider

        <T> ObjectProvider<T> getBeanProvider(ResolvableType requiredType)
        Return an provider for the specified bean, allowing for lazy on-demand retrieval of instances, including availability and uniqueness options.
        Parameters:
        requiredType - type the bean must match; can be a generic type declaration. Note that collection types are not supported here, in contrast to reflective injection points. For programmatically retrieving a list of beans matching a specific type, specify the actual bean type as an argument here and subsequently use ObjectProvider#toList() or its lazy streaming/iteration options.
        Returns:
        a corresponding provider handle
        Since:
        5.1
        See Also:
        ObjectProvider.stream(), ObjectProvider.iterator(), ObjectProvider#toList()
      • containsBean

        boolean containsBean(java.lang.String name)
        Does this bean factory contain a bean definition or externally registered singleton instance with the given name?

        If the given name is an alias, it will be translated back to the corresponding canonical bean name.

        If this factory is hierarchical, will ask any parent factory if the bean cannot be found in this factory instance.

        If a bean definition or singleton instance matching the given name is found, this method will return true whether the named bean definition is concrete or abstract, lazy or eager, in scope or not. Therefore, note that a true return value from this method does not necessarily indicate that getBean(java.lang.String) will be able to obtain an instance for the same name.

        Parameters:
        name - the name of the bean to query
        Returns:
        whether a bean with the given name is present
      • isSingleton

        boolean isSingleton(java.lang.String name)
                     throws NoSuchBeanDefinitionException
        Is this bean a shared singleton? That is, will getBean(java.lang.String) always return the same instance?

        Note: This method returning false does not clearly indicate independent instances. It indicates non-singleton instances, which may correspond to a scoped bean as well. Use the isPrototype(java.lang.String) operation to explicitly check for independent instances.

        Translates aliases back to the corresponding canonical bean name. Will ask the parent factory if the bean cannot be found in this factory instance.

        Parameters:
        name - the name of the bean to query
        Returns:
        whether this bean corresponds to a singleton instance
        Throws:
        NoSuchBeanDefinitionException - if there is no bean with the given name
        See Also:
        getBean(java.lang.String), isPrototype(java.lang.String)
      • isPrototype

        boolean isPrototype(java.lang.String name)
                     throws NoSuchBeanDefinitionException
        Is this bean a prototype? That is, will getBean(java.lang.String) always return independent instances?

        Note: This method returning false does not clearly indicate a singleton object. It indicates non-independent instances, which may correspond to a scoped bean as well. Use the isSingleton(java.lang.String) operation to explicitly check for a shared singleton instance.

        Translates aliases back to the corresponding canonical bean name. Will ask the parent factory if the bean cannot be found in this factory instance.

        Parameters:
        name - the name of the bean to query
        Returns:
        whether this bean will always deliver independent instances
        Throws:
        NoSuchBeanDefinitionException - if there is no bean with the given name
        Since:
        2.0.3
        See Also:
        getBean(java.lang.String), isSingleton(java.lang.String)
      • isTypeMatch

        boolean isTypeMatch(java.lang.String name,
                            ResolvableType typeToMatch)
                     throws NoSuchBeanDefinitionException
        Check whether the bean with the given name matches the specified type. More specifically, check whether a getBean(java.lang.String) call for the given name would return an object that is assignable to the specified target type.

        Translates aliases back to the corresponding canonical bean name. Will ask the parent factory if the bean cannot be found in this factory instance.

        Parameters:
        name - the name of the bean to query
        typeToMatch - the type to match against (as a ResolvableType)
        Returns:
        true if the bean type matches, false if it doesn't match or cannot be determined yet
        Throws:
        NoSuchBeanDefinitionException - if there is no bean with the given name
        Since:
        4.2
        See Also:
        getBean(java.lang.String), getType(java.lang.String)
      • isTypeMatch

        boolean isTypeMatch(java.lang.String name,
                            java.lang.Class<?> typeToMatch)
                     throws NoSuchBeanDefinitionException
        Check whether the bean with the given name matches the specified type. More specifically, check whether a getBean(java.lang.String) call for the given name would return an object that is assignable to the specified target type.

        Translates aliases back to the corresponding canonical bean name. Will ask the parent factory if the bean cannot be found in this factory instance.

        Parameters:
        name - the name of the bean to query
        typeToMatch - the type to match against (as a Class)
        Returns:
        true if the bean type matches, false if it doesn't match or cannot be determined yet
        Throws:
        NoSuchBeanDefinitionException - if there is no bean with the given name
        Since:
        2.0.1
        See Also:
        getBean(java.lang.String), getType(java.lang.String)
      • getAliases

        java.lang.String[] getAliases(java.lang.String name)
        Return the aliases for the given bean name, if any. All of those aliases point to the same bean when used in a getBean(java.lang.String) call.

        If the given name is an alias, the corresponding original bean name and other aliases (if any) will be returned, with the original bean name being the first element in the array.

        Will ask the parent factory if the bean cannot be found in this factory instance.

        Parameters:
        name - the bean name to check for aliases
        Returns:
        the aliases, or an empty array if none
        See Also:
        getBean(java.lang.String)