public class

StaticListableBeanFactory

extends Object
implements ListableBeanFactory
java.lang.Object
   ↳ org.springframework.beans.factory.support.StaticListableBeanFactory

Class Overview

Static BeanFactory implementation which allows to register existing singleton instances programmatically. Does not have support for prototype beans or aliases.

Serves as example for a simple implementation of the ListableBeanFactory interface, managing existing bean instances rather than creating new ones based on bean definitions, and not implementing any extended SPI interfaces (such as ConfigurableBeanFactory).

For a full-fledged factory based on bean definitions, have a look at DefaultListableBeanFactory.

See Also

Summary

[Expand]
Inherited Constants
From interface org.springframework.beans.factory.BeanFactory
Public Constructors
StaticListableBeanFactory()
Public Methods
void addBean(String name, Object bean)
Add a new singleton bean.
boolean containsBean(String name)
Does this bean factory contain a bean with the given name? More specifically, is getBean(Class) able to obtain a bean instance for the given name?

Translates aliases back to the corresponding canonical bean name.

boolean containsBeanDefinition(String name)
Check if this bean factory contains a bean definition with the given name.
<A extends Annotation> A findAnnotationOnBean(String beanName, Class<A> annotationType)
Find a Annotation of annotationType on the specified bean, traversing its interfaces and super classes if no annotation can be found on the given class itself.
String[] getAliases(String name)
Return the aliases for the given bean name, if any.
Object getBean(String name)
Return an instance, which may be shared or independent, of the specified bean.
Object getBean(String name, Object... args)
Return an instance, which may be shared or independent, of the specified bean.
<T> T getBean(Class<T> requiredType)
Return the bean instance that uniquely matches the given object type, if any.
<T> T getBean(String name, Class<T> requiredType)
Return an instance, which may be shared or independent, of the specified bean.
int getBeanDefinitionCount()
Return the number of beans defined in the factory.
String[] getBeanDefinitionNames()
Return the names of all beans defined in this factory.
String[] getBeanNamesForType(Class type)
String[] getBeanNamesForType(Class type, boolean includeNonSingletons, boolean includeFactoryBeans)
<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 includeFactoryBeans)
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 whose Class has the supplied Annotation type.
Class<?> getType(String name)
Determine the type of the bean with the given name.
boolean isPrototype(String name)
Is this bean a prototype? That is, will getBean(Class) always return independent instances?

Note: This method returning false does not clearly indicate a singleton object.

boolean isSingleton(String name)
Is this bean a shared singleton? That is, will getBean(Class) always return the same instance?

Note: This method returning false does not clearly indicate independent instances.

boolean isTypeMatch(String name, Class targetType)
[Expand]
Inherited Methods
From class java.lang.Object
From interface org.springframework.beans.factory.BeanFactory
From interface org.springframework.beans.factory.ListableBeanFactory

Public Constructors

public StaticListableBeanFactory ()

Also: SpringBeans

Public Methods

public void addBean (String name, Object bean)

Also: SpringBeans

Add a new singleton bean. Will overwrite any existing instance for the given name.

Parameters
name the name of the bean
bean the bean instance

public boolean containsBean (String name)

Also: SpringBeans

Does this bean factory contain a bean with the given name? More specifically, is getBean(Class) able to obtain a bean instance for the given name?

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 a bean with the given name is defined

public boolean containsBeanDefinition (String name)

Also: SpringBeans

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
name the name of the bean to look for
Returns
  • if this bean factory contains a bean definition with the given name

public A findAnnotationOnBean (String beanName, Class<A> annotationType)

Also: SpringBeans

Find a 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 found, or null

public String[] getAliases (String name)

Also: SpringBeans

Return the aliases for the given bean name, if any. All of those aliases point to the same bean when used in a getBean(Class) 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

public Object getBean (String name)

Also: SpringBeans

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
BeansException

public Object getBean (String name, Object... args)

Also: SpringBeans

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 if creating a prototype using explicit arguments to a static factory method. It is invalid to use a non-null args value in any other case.
Returns
  • an instance of the bean
Throws
BeansException

public T getBean (Class<T> requiredType)

Also: SpringBeans

Return the bean instance that uniquely matches the given object type, if any.

Parameters
requiredType type the bean must match; can be an interface or superclass. null is disallowed.

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.
Returns
  • an instance of the single bean matching the required type
Throws
BeansException

public T getBean (String name, Class<T> requiredType)

Also: SpringBeans

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 of the actual class, or null for any match. For example, if the value is Object.class, this method will succeed whatever the class of the returned instance.
Returns
  • an instance of the bean
Throws
BeansException

public int getBeanDefinitionCount ()

Also: SpringBeans

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

public String[] getBeanDefinitionNames ()

Also: SpringBeans

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

public String[] getBeanNamesForType (Class type)

Also: SpringBeans

public String[] getBeanNamesForType (Class type, boolean includeNonSingletons, boolean includeFactoryBeans)

Also: SpringBeans

public Map<String, T> getBeansOfType (Class<T> type)

Also: SpringBeans

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

public Map<String, T> getBeansOfType (Class<T> type, boolean includeNonSingletons, boolean includeFactoryBeans)

Also: SpringBeans

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)
includeFactoryBeans 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

public Map<String, Object> getBeansWithAnnotation (Class<? extends Annotation> annotationType)

Also: SpringBeans

Find all beans whose Class has the supplied Annotation type.

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

public Class<?> getType (String name)

Also: SpringBeans

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

For a FactoryBean, return the type of object that the FactoryBean creates, as exposed by getObjectType().

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
  • the type of the bean, or null if not determinable
Throws
NoSuchBeanDefinitionException

public boolean isPrototype (String name)

Also: SpringBeans

Is this bean a prototype? That is, will getBean(Class) 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(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

public boolean isSingleton (String name)

Also: SpringBeans

Is this bean a shared singleton? That is, will getBean(Class) 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(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

public boolean isTypeMatch (String name, Class targetType)

Also: SpringBeans

Throws
NoSuchBeanDefinitionException