Spring Beans 6.1.4 · org.springframework.beans.factory.BeanFactory

The root interface for accessing a Spring bean container.

This is the basic client view of a bean container; further interfaces such as ListableBeanFactory and org.springframework.beans.factory.config.ConfigurableBeanFactory are available for specific purposes.

This interface is implemented by objects that hold a number of bean definitions, each uniquely identified by a String name. Depending on the bean definition, the factory will return either an independent instance of a contained object (the Prototype design pattern), or a single shared instance (a superior alternative to the Singleton design pattern, in which the instance is a singleton in the scope of the factory). Which type of instance will be returned depends on the bean factory configuration: the API is the same. Since Spring 2.0, further scopes are available depending on the concrete application context (e.g. "request" and "session" scopes in a web environment).

The point of this approach is that the BeanFactory is a central registry of application components, and centralizes configuration of application components (no more do individual objects need to read properties files, for example). See chapters 4 and 11 of "Expert One-on-One J2EE Design and Development" for a discussion of the benefits of this approach.

Note that it is generally better to rely on Dependency Injection ("push" configuration) to configure application objects through setters or constructors, rather than use any form of "pull" configuration like a BeanFactory lookup. Spring's Dependency Injection functionality is implemented using this BeanFactory interface and its subinterfaces.

Normally a BeanFactory will load bean definitions stored in a configuration source (such as an XML document), and use the org.springframework.beans package to configure the beans. However, an implementation could simply return Java objects it creates as necessary directly in Java code. There are no constraints on how the definitions could be stored: LDAP, RDBMS, XML, properties file, etc. Implementations are encouraged to support references amongst beans (Dependency Injection).

In contrast to the methods in ListableBeanFactory, all of the operations in this interface will also check parent factories if this is a HierarchicalBeanFactory. If a bean is not found in this factory instance, the immediate parent factory will be asked. Beans in this factory instance are supposed to override beans of the same name in any parent factory.

Bean factory implementations should support the standard bean lifecycle interfaces as far as possible. The full set of initialization methods and their standard order is:

BeanNameAware's setBeanName
BeanClassLoaderAware's setBeanClassLoader
BeanFactoryAware's setBeanFactory
EnvironmentAware's setEnvironment
EmbeddedValueResolverAware's setEmbeddedValueResolver
ResourceLoaderAware's setResourceLoader (only applicable when running in an application context)
ApplicationEventPublisherAware's setApplicationEventPublisher (only applicable when running in an application context)
MessageSourceAware's setMessageSource (only applicable when running in an application context)
ApplicationContextAware's setApplicationContext (only applicable when running in an application context)
ServletContextAware's setServletContext (only applicable when running in a web application context)
postProcessBeforeInitialization methods of BeanPostProcessors
InitializingBean's afterPropertiesSet
a custom init-method definition
postProcessAfterInitialization methods of BeanPostProcessors

On shutdown of a bean factory, the following lifecycle methods apply:

postProcessBeforeDestruction methods of DestructionAwareBeanPostProcessors
DisposableBean's destroy
a custom destroy-method definition

Field Summary

Modifier and Type	Field and Description
public static final String	FACTORY_BEAN_PREFIX Used to dereference a `FactoryBean` instance and distinguish it from beans created by the FactoryBean.

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: whether a bean with the given name is present containsBean(String the name of the bean to query name) Does this bean factory contain a bean definition or externally registered singleton instance with the given name?
public String[]	Returns: the aliases, or an empty array if none getAliases(String the bean name to check for aliases name) Return the aliases for the given bean name, if any.
public Object	Returns: an instance of the bean. Note that the return value will never be `null` but possibly a stub for `null` returned from a factory method, to be checked via `equals(null)`. Consider using `getBeanProvider(Class)` for resolving optional dependencies. getBean(String the name of the bean to retrieve name) Return an instance, which may be shared or independent, of the specified bean.
public <T> T	Returns: an instance of the bean. Note that the return value will never be `null`. In case of a stub for `null` from a factory method having been resolved for the requested bean, a `BeanNotOfRequiredTypeException` against the NullBean stub will be raised. Consider using `getBeanProvider(Class)` for resolving optional dependencies. getBean(String the name of the bean to retrieve name, Class<T> type the bean must match; can be an interface or superclass requiredType) Return an instance, which may be shared or independent, of the specified bean.
public Object	Returns: an instance of the bean getBean(String the name of the bean to retrieve name, Object... 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) args) Return an instance, which may be shared or independent, of the specified bean.
public <T> T	Returns: an instance of the single bean matching the required type getBean(Class<T> type the bean must match; can be an interface or superclass requiredType) Return the bean instance that uniquely matches the given object type, if any.
public <T> T	Returns: an instance of the bean getBean(Class<T> type the bean must match; can be an interface or superclass requiredType, Object... 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) args) Return an instance, which may be shared or independent, of the specified bean.
public <T> ObjectProvider<T>	Returns: a corresponding provider handle getBeanProvider(Class<T> type the bean must match; can be an interface or superclass requiredType) Return a provider for the specified bean, allowing for lazy on-demand retrieval of instances, including availability and uniqueness options.
public <T> ObjectProvider<T>	Returns: a corresponding provider handle getBeanProvider(ResolvableType type the bean must match; can be a generic type declaration requiredType) Return a provider for the specified bean, allowing for lazy on-demand retrieval of instances, including availability and uniqueness options.
public Class<?>	Returns: the type of the bean, or `null` if not determinable getType(String the name of the bean to query name) Determine the type of the bean with the given name.
public Class<?>	Returns: the type of the bean, or `null` if not determinable getType(String the name of the bean to query name, boolean whether a `FactoryBean` may get initialized just for the purpose of determining its object type allowFactoryBeanInit) Determine the type of the bean with the given name.
public boolean	Returns: whether this bean will always deliver independent instances isPrototype(String the name of the bean to query name) Is this bean a prototype?
public boolean	Returns: whether this bean corresponds to a singleton instance isSingleton(String the name of the bean to query name) Is this bean a shared singleton?
public boolean	Returns: `true` if the bean type matches, `false` if it doesn't match or cannot be determined yet isTypeMatch(String the name of the bean to query name, ResolvableType the type to match against (as a `ResolvableType`) typeToMatch) Check whether the bean with the given name matches the specified type.
public boolean	Returns: `true` if the bean type matches, `false` if it doesn't match or cannot be determined yet isTypeMatch(String the name of the bean to query name, Class<?> the type to match against (as a `Class`) typeToMatch) Check whether the bean with the given name matches the specified type.

Field Detail

FACTORY_BEAN_PREFIX	back to summary
public static final 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.

Method Detail

containsBean back to summary

containsBean	back to summary
public boolean containsBean(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` will be able to obtain an instance for the same name. Parameters name:String the name of the bean to query Returns:boolean whether a bean with the given name is present

public boolean containsBean(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 will be able to obtain an instance for the same name.

Parameters

name:String: the name of the bean to query

Returns:boolean

whether a bean with the given name is present

getAliases back to summary

getAliases	back to summary
public String[] getAliases(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` 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:String the bean name to check for aliases Returns:String[] the aliases, or an empty array if none See Also `getBean`

public String[] getAliases(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 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:String: the bean name to check for aliases

Returns:String[]

the aliases, or an empty array if none

See Also

getBean

getBean back to summary

getBean	back to summary
public Object getBean(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:String the name of the bean to retrieve Returns:Object an instance of the bean. Note that the return value will never be `null` but possibly a stub for `null` returned from a factory method, to be checked via `equals(null)`. Consider using `getBeanProvider(Class)` for resolving optional dependencies. Exceptions BeansException: if the bean could not be obtained NoSuchBeanDefinitionException: if there is no bean with the specified name

public Object getBean(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:String: the name of the bean to retrieve

Returns:Object

an instance of the bean. Note that the return value will never be null but possibly a stub for null returned from a factory method, to be checked via equals(null). Consider using getBeanProvider(Class) for resolving optional dependencies.

Exceptions

BeansException:: if the bean could not be obtained
NoSuchBeanDefinitionException:: if there is no bean with the specified name

getBean back to summary

getBean	back to summary
public <T> T getBean(String name, 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:String the name of the bean to retrieve requiredType:Class<T> type the bean must match; can be an interface or superclass Returns:T an instance of the bean. Note that the return value will never be `null`. In case of a stub for `null` from a factory method having been resolved for the requested bean, a `BeanNotOfRequiredTypeException` against the NullBean stub will be raised. Consider using `getBeanProvider(Class)` for resolving optional dependencies. Exceptions BeansException: if the bean could not be created NoSuchBeanDefinitionException: if there is no such bean definition BeanNotOfRequiredTypeException: if the bean is not of the required type

public <T> T getBean(String name, 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:String: the name of the bean to retrieve
requiredType:Class<T>: type the bean must match; can be an interface or superclass

Returns:T

an instance of the bean. Note that the return value will never be null. In case of a stub for null from a factory method having been resolved for the requested bean, a BeanNotOfRequiredTypeException against the NullBean stub will be raised. Consider using getBeanProvider(Class) for resolving optional dependencies.

Exceptions

BeansException:: if the bean could not be created
NoSuchBeanDefinitionException:: if there is no such bean definition
BeanNotOfRequiredTypeException:: if the bean is not of the required type

getBean	back to summary
public Object getBean(String name, 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. Note that the provided arguments need to match a specific candidate constructor / factory method in the order of declared parameters. Parameters name:String the name of the bean to retrieve args:Object[] 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:Object an instance of the bean Exceptions BeansException: if the bean could not be created NoSuchBeanDefinitionException: if there is no such bean definition BeanDefinitionStoreException: if arguments have been given but the affected bean isn't a prototype Since 2.5

getBean

back to summary

public Object getBean(String name, 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. Note that the provided arguments need to match a specific candidate constructor / factory method in the order of declared parameters.

Parameters

name:String: the name of the bean to retrieve
args:Object[]: 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:Object

an instance of the bean

Exceptions

BeansException:: if the bean could not be created
NoSuchBeanDefinitionException:: if there is no such bean definition
BeanDefinitionStoreException:: if arguments have been given but the affected bean isn't a prototype

Since

2.5

getBean back to summary

getBean	back to summary
public <T> T getBean(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:Class<T> type the bean must match; can be an interface or superclass Returns:T an instance of the single bean matching the required type Exceptions BeansException: if the bean could not be created NoSuchBeanDefinitionException: if no bean of the given type was found NoUniqueBeanDefinitionException: if more than one bean of the given type was found Since 3.0 See Also `ListableBeanFactory`

public <T> T getBean(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:Class<T>: type the bean must match; can be an interface or superclass

Returns:T

an instance of the single bean matching the required type

Exceptions

BeansException:: if the bean could not be created
NoSuchBeanDefinitionException:: if no bean of the given type was found
NoUniqueBeanDefinitionException:: if more than one bean of the given type was found

Since

3.0

See Also

ListableBeanFactory

getBean back to summary

getBean	back to summary
public <T> T getBean(Class<T> requiredType, 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. Note that the provided arguments need to match a specific candidate constructor / factory method in the order of declared parameters. 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:Class<T> type the bean must match; can be an interface or superclass args:Object[] 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:T an instance of the bean Exceptions BeansException: if the bean could not be created NoSuchBeanDefinitionException: if there is no such bean definition BeanDefinitionStoreException: if arguments have been given but the affected bean isn't a prototype Since 4.1

public <T> T getBean(Class<T> requiredType, Object... args) throws BeansException

Return an instance, which may be shared or independent, of the specified bean.

Parameters

requiredType:Class<T>: type the bean must match; can be an interface or superclass
args:Object[]: 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:T

an instance of the bean

Exceptions

BeansException:: if the bean could not be created
NoSuchBeanDefinitionException:: if there is no such bean definition
BeanDefinitionStoreException:: if arguments have been given but the affected bean isn't a prototype

Since

4.1

getBeanProvider back to summary

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

public <T> ObjectProvider<T> getBeanProvider(Class<T> requiredType)

Return a provider for the specified bean, allowing for lazy on-demand retrieval of instances, including availability and uniqueness options.

For matching a generic type, consider getBeanProvider(ResolvableType).

Parameters

requiredType:Class<T>: type the bean must match; can be an interface or superclass

Returns:ObjectProvider<T>

a corresponding provider handle

Since

5.1

See Also

getBeanProvider(ResolvableType)

getBeanProvider back to summary

getBeanProvider	back to summary
public <T> ObjectProvider<T> getBeanProvider(ResolvableType requiredType) Return a provider for the specified bean, allowing for lazy on-demand retrieval of instances, including availability and uniqueness options. This variant allows for specifying a generic type to match, similar to reflective injection points with generic type declarations in method/constructor parameters. Note that collections of beans 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#orderedStream()` or its lazy streaming/iteration options. Also, generics matching is strict here, as per the Java assignment rules. For lenient fallback matching with unchecked semantics (similar to the ´unchecked´ Java compiler warning), consider calling `getBeanProvider(Class)` with the raw type as a second step if no full generic match is `available` with this variant. Parameters requiredType:ResolvableType type the bean must match; can be a generic type declaration Returns:ObjectProvider<T> a corresponding provider handle Since 5.1 See Also `ObjectProvider#iterator()`, `ObjectProvider#stream()`, `ObjectProvider#orderedStream()`

public <T> ObjectProvider<T> getBeanProvider(ResolvableType requiredType)

Return a provider for the specified bean, allowing for lazy on-demand retrieval of instances, including availability and uniqueness options. This variant allows for specifying a generic type to match, similar to reflective injection points with generic type declarations in method/constructor parameters.

Note that collections of beans 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#orderedStream() or its lazy streaming/iteration options.

Also, generics matching is strict here, as per the Java assignment rules. For lenient fallback matching with unchecked semantics (similar to the ´unchecked´ Java compiler warning), consider calling getBeanProvider(Class) with the raw type as a second step if no full generic match is available with this variant.

Parameters

requiredType:ResolvableType: type the bean must match; can be a generic type declaration

Returns:ObjectProvider<T>

a corresponding provider handle

Since

5.1

getType back to summary

getType	back to summary
public Class<?> getType(String name) throws NoSuchBeanDefinitionException Determine the type of the bean with the given name. More specifically, determine the type of object that `getBean` would return for the given name. For a `FactoryBean`, return the type of object that the FactoryBean creates, as exposed by `FactoryBean#getObjectType()`. This may lead to the initialization of a previously uninitialized `FactoryBean` (see `getType(String, boolean)`). 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:String the name of the bean to query Returns:Class<?> the type of the bean, or `null` if not determinable Annotations @Nullable Exceptions NoSuchBeanDefinitionException: if there is no bean with the given name Since 1.1.2 See Also `getBean`, `isTypeMatch`

public Class<?> getType(String name) throws NoSuchBeanDefinitionException

Determine the type of the bean with the given name. More specifically, determine the type of object that getBean would return for the given name.

For a FactoryBean, return the type of object that the FactoryBean creates, as exposed by FactoryBean#getObjectType(). This may lead to the initialization of a previously uninitialized FactoryBean (see getType(String, boolean)).

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:String: the name of the bean to query

Returns:Class<?>

the type of the bean, or null if not determinable

Annotations

@Nullable

Exceptions

NoSuchBeanDefinitionException:: if there is no bean with the given name

Since

1.1.2

See Also

getBean, isTypeMatch

getType back to summary

getType	back to summary
public Class<?> getType(String name, boolean allowFactoryBeanInit) throws NoSuchBeanDefinitionException Determine the type of the bean with the given name. More specifically, determine the type of object that `getBean` would return for the given name. For a `FactoryBean`, return the type of object that the FactoryBean creates, as exposed by `FactoryBean#getObjectType()`. Depending on the `allowFactoryBeanInit` flag, this may lead to the initialization of a previously uninitialized `FactoryBean` if no early type information is available. 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:String the name of the bean to query allowFactoryBeanInit:boolean whether a `FactoryBean` may get initialized just for the purpose of determining its object type Returns:Class<?> the type of the bean, or `null` if not determinable Annotations @Nullable Exceptions NoSuchBeanDefinitionException: if there is no bean with the given name Since 5.2 See Also `getBean`, `isTypeMatch`

public Class<?> getType(String name, boolean allowFactoryBeanInit) throws NoSuchBeanDefinitionException

Determine the type of the bean with the given name. More specifically, determine the type of object that getBean would return for the given name.

For a FactoryBean, return the type of object that the FactoryBean creates, as exposed by FactoryBean#getObjectType(). Depending on the allowFactoryBeanInit flag, this may lead to the initialization of a previously uninitialized FactoryBean if no early type information is available.

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:String: the name of the bean to query
allowFactoryBeanInit:boolean: whether a FactoryBean may get initialized just for the purpose of determining its object type

Returns:Class<?>

the type of the bean, or null if not determinable

Annotations

@Nullable

Exceptions

NoSuchBeanDefinitionException:: if there is no bean with the given name

Since

5.2

See Also

getBean, isTypeMatch

isPrototype back to summary

isPrototype	back to summary
public boolean isPrototype(String name) throws NoSuchBeanDefinitionException Is this bean a prototype? That is, will `getBean` 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` 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:String the name of the bean to query Returns:boolean whether this bean will always deliver independent instances Exceptions NoSuchBeanDefinitionException: if there is no bean with the given name Since 2.0.3 See Also `getBean`, `isSingleton`

public boolean isPrototype(String name) throws NoSuchBeanDefinitionException

Is this bean a prototype? That is, will getBean 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 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:String: the name of the bean to query

Returns:boolean

whether this bean will always deliver independent instances

Exceptions

NoSuchBeanDefinitionException:: if there is no bean with the given name

Since

2.0.3

See Also

getBean, isSingleton

isSingleton back to summary

isSingleton	back to summary
public boolean isSingleton(String name) throws NoSuchBeanDefinitionException Is this bean a shared singleton? That is, will `getBean` 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` 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:String the name of the bean to query Returns:boolean whether this bean corresponds to a singleton instance Exceptions NoSuchBeanDefinitionException: if there is no bean with the given name See Also `getBean`, `isPrototype`

public boolean isSingleton(String name) throws NoSuchBeanDefinitionException

Is this bean a shared singleton? That is, will getBean 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 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:String: the name of the bean to query

Returns:boolean

whether this bean corresponds to a singleton instance

Exceptions

NoSuchBeanDefinitionException:: if there is no bean with the given name

See Also

getBean, isPrototype

isTypeMatch back to summary

isTypeMatch	back to summary
public boolean isTypeMatch(String name, ResolvableType typeToMatch) throws NoSuchBeanDefinitionException Check whether the bean with the given name matches the specified type. More specifically, check whether a `getBean` 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:String the name of the bean to query typeToMatch:ResolvableType the type to match against (as a `ResolvableType`) Returns:boolean `true` if the bean type matches, `false` if it doesn't match or cannot be determined yet Exceptions NoSuchBeanDefinitionException: if there is no bean with the given name Since 4.2 See Also `getBean`, `getType`

public boolean isTypeMatch(String name, ResolvableType typeToMatch) throws NoSuchBeanDefinitionException

Check whether the bean with the given name matches the specified type. More specifically, check whether a getBean 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:String: the name of the bean to query
typeToMatch:ResolvableType: the type to match against (as a ResolvableType)

Returns:boolean

true if the bean type matches, false if it doesn't match or cannot be determined yet

Exceptions

NoSuchBeanDefinitionException:: if there is no bean with the given name

Since

4.2

See Also

getBean, getType

isTypeMatch back to summary

isTypeMatch	back to summary
public boolean isTypeMatch(String name, Class<?> typeToMatch) throws NoSuchBeanDefinitionException Check whether the bean with the given name matches the specified type. More specifically, check whether a `getBean` 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:String the name of the bean to query typeToMatch:Class<?> the type to match against (as a `Class`) Returns:boolean `true` if the bean type matches, `false` if it doesn't match or cannot be determined yet Exceptions NoSuchBeanDefinitionException: if there is no bean with the given name Since 2.0.1 See Also `getBean`, `getType`

public boolean isTypeMatch(String name, Class<?> typeToMatch) throws NoSuchBeanDefinitionException

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:String: the name of the bean to query
typeToMatch:Class<?>: the type to match against (as a Class)

Returns:boolean

true if the bean type matches, false if it doesn't match or cannot be determined yet

Exceptions

NoSuchBeanDefinitionException:: if there is no bean with the given name

Since

2.0.1

See Also

getBean, getType

public Interface BeanFactory

Field Summary

Method Summary

Field Detail

Method Detail