Interface BeanRegistry

All Known Implementing Classes:
BeanRegistryAdapter
public interface BeanRegistry
Used in BeanRegistrar.register(BeanRegistry, Environment) to expose programmatic bean registration capabilities.
Since:
7.0
Author:
Sebastien Deleuze

  • Method Details

    • register

      void register(BeanRegistrar registrar)
      Register beans using the given BeanRegistrar.
      Parameters:
      registrar - the bean registrar that will be called to register additional beans

    • registerAlias

      void registerAlias(String name, String alias)
      Given a name, register an alias for it.
      Parameters:
      name - the canonical name
      alias - the alias to be registered
      Throws:
      IllegalStateException - if the alias is already in use and may not be overridden

    • registerBean

      <T> String registerBean(Class<T> beanClass)
      Register a bean from the given class, which will be instantiated using the related resolvable constructor if any.

      For registering a bean with a generic type, consider registerBean(ParameterizedTypeReference).

      Parameters:
      beanClass - the class of the bean
      Returns:
      the generated bean name
      See Also:

    • registerBean

      <T> String registerBean(ParameterizedTypeReference<T> beanType)
      Register a bean from the given generics-containing type, which will be instantiated using the related resolvable constructor if any.
      Parameters:
      beanType - the generics-containing type of the bean
      Returns:
      the generated bean name

    • registerBean

      <T> String registerBean(Class<T> beanClass, Consumer<BeanRegistry.Spec<T>> customizer)
      Register a bean from the given class, customizing it with the customizer callback. The bean will be instantiated using the supplier that can be configured in the customizer callback, or will be tentatively instantiated with its resolvable constructor otherwise.

      For registering a bean with a generic type, consider registerBean(ParameterizedTypeReference, Consumer).

      Parameters:
      beanClass - the class of the bean
      customizer - the callback to customize other bean properties than the name
      Returns:
      the generated bean name

    • registerBean

      <T> String registerBean(ParameterizedTypeReference<T> beanType, Consumer<BeanRegistry.Spec<T>> customizer)
      Register a bean from the given generics-containing type, customizing it with the customizer callback. The bean will be instantiated using the supplier that can be configured in the customizer callback, or will be tentatively instantiated with its resolvable constructor otherwise.
      Parameters:
      beanType - the generics-containing type of the bean
      customizer - the callback to customize other bean properties than the name
      Returns:
      the generated bean name

    • registerBean

      <T> void registerBean(String name, Class<T> beanClass)
      Register a bean from the given class, which will be instantiated using the related resolvable constructor if any.

      For registering a bean with a generic type, consider registerBean(String, ParameterizedTypeReference).

      Parameters:
      name - the name of the bean
      beanClass - the class of the bean

    • registerBean

      <T> void registerBean(String name, ParameterizedTypeReference<T> beanType)
      Register a bean from the given generics-containing type, which will be instantiated using the related resolvable constructor if any.
      Parameters:
      name - the name of the bean
      beanType - the generics-containing type of the bean

    • registerBean

      <T> void registerBean(String name, Class<T> beanClass, Consumer<BeanRegistry.Spec<T>> customizer)
      Register a bean from the given class, customizing it with the customizer callback. The bean will be instantiated using the supplier that can be configured in the customizer callback, or will be tentatively instantiated with its resolvable constructor otherwise.

      For registering a bean with a generic type, consider registerBean(String, ParameterizedTypeReference, Consumer).

      Parameters:
      name - the name of the bean
      beanClass - the class of the bean
      customizer - the callback to customize other bean properties than the name

    • registerBean

      <T> void registerBean(String name, ParameterizedTypeReference<T> beanType, Consumer<BeanRegistry.Spec<T>> customizer)
      Register a bean from the given generics-containing type, customizing it with the customizer callback. The bean will be instantiated using the supplier that can be configured in the customizer callback, or will be tentatively instantiated with its resolvable constructor otherwise.
      Parameters:
      name - the name of the bean
      beanType - the generics-containing type of the bean
      customizer - the callback to customize other bean properties than the name