Spring Framework

org.springframework.beans.factory.support
Interface BeanDefinitionRegistry

All Superinterfaces:
AliasRegistry
All Known Implementing Classes:
AnnotationConfigApplicationContext, DefaultListableBeanFactory, GenericApplicationContext, GenericWebApplicationContext, GenericXmlApplicationContext, ResourceAdapterApplicationContext, SimpleBeanDefinitionRegistry, StaticApplicationContext, StaticPortletApplicationContext, StaticWebApplicationContext, XmlBeanFactory

public interface BeanDefinitionRegistry
extends AliasRegistry

Interface for registries that hold bean definitions, for example RootBeanDefinition and ChildBeanDefinition instances. Typically implemented by BeanFactories that internally work with the AbstractBeanDefinition hierarchy.

This is the only interface in Spring's bean factory packages that encapsulates registration of bean definitions. The standard BeanFactory interfaces only cover access to a fully configured factory instance.

Spring's bean definition readers expect to work on an implementation of this interface. Known implementors within the Spring core are DefaultListableBeanFactory and GenericApplicationContext.

Since:
26.11.2003
Author:
Juergen Hoeller
See Also:
BeanDefinition, AbstractBeanDefinition, RootBeanDefinition, ChildBeanDefinition, DefaultListableBeanFactory, GenericApplicationContext, XmlBeanDefinitionReader, PropertiesBeanDefinitionReader

Method Summary
 boolean containsBeanDefinition(java.lang.String beanName)
          Check if this registry contains a bean definition with the given name.
 BeanDefinition getBeanDefinition(java.lang.String beanName)
          Return the BeanDefinition for the given bean name.
 int getBeanDefinitionCount()
          Return the number of beans defined in the registry.
 java.lang.String[] getBeanDefinitionNames()
          Return the names of all beans defined in this registry.
 boolean isBeanNameInUse(java.lang.String beanName)
          Determine whether the given bean name is already in use within this registry, i.e.
 void registerBeanDefinition(java.lang.String beanName, BeanDefinition beanDefinition)
          Register a new bean definition with this registry.
 void removeBeanDefinition(java.lang.String beanName)
          Remove the BeanDefinition for the given name.
 
Methods inherited from interface org.springframework.core.AliasRegistry
getAliases, isAlias, registerAlias, removeAlias
 

Method Detail

registerBeanDefinition

void registerBeanDefinition(java.lang.String beanName,
                            BeanDefinition beanDefinition)
                            throws BeanDefinitionStoreException
Register a new bean definition with this registry. Must support RootBeanDefinition and ChildBeanDefinition.

Parameters:
beanName - the name of the bean instance to register
beanDefinition - definition of the bean instance to register
Throws:
BeanDefinitionStoreException - if the BeanDefinition is invalid or if there is already a BeanDefinition for the specified bean name (and we are not allowed to override it)
See Also:
RootBeanDefinition, ChildBeanDefinition

removeBeanDefinition

void removeBeanDefinition(java.lang.String beanName)
                          throws NoSuchBeanDefinitionException
Remove the BeanDefinition for the given name.

Parameters:
beanName - the name of the bean instance to register
Throws:
NoSuchBeanDefinitionException - if there is no such bean definition

getBeanDefinition

BeanDefinition getBeanDefinition(java.lang.String beanName)
                                 throws NoSuchBeanDefinitionException
Return the BeanDefinition for the given bean name.

Parameters:
beanName - name of the bean to find a definition for
Returns:
the BeanDefinition for the given name (never null)
Throws:
NoSuchBeanDefinitionException - if there is no such bean definition

containsBeanDefinition

boolean containsBeanDefinition(java.lang.String beanName)
Check if this registry contains a bean definition with the given name.

Parameters:
beanName - the name of the bean to look for
Returns:
if this registry contains a bean definition with the given name

getBeanDefinitionNames

java.lang.String[] getBeanDefinitionNames()
Return the names of all beans defined in this registry.

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

getBeanDefinitionCount

int getBeanDefinitionCount()
Return the number of beans defined in the registry.

Returns:
the number of beans defined in the registry

isBeanNameInUse

boolean isBeanNameInUse(java.lang.String beanName)
Determine whether the given bean name is already in use within this registry, i.e. whether there is a local bean or alias registered under this name.

Parameters:
beanName - the name to check
Returns:
whether the given bean name is already in use

Spring Framework