Class DefaultBeanFactory

java.lang.Object
org.apache.commons.configuration2.beanutils.DefaultBeanFactory
All Implemented Interfaces:
BeanFactory

public class DefaultBeanFactory extends Object implements BeanFactory

The default implementation of the BeanFactory interface.

This class creates beans of arbitrary types using reflection. Each time the createBean() method is invoked, a new bean instance is created. A default bean class is not supported.

For data type conversions (which may be needed before invoking methods through reflection to ensure that the current parameters match their declared types) a ConversionHandler object is used. An instance of this class can be passed to the constructor. Alternatively, a default ConversionHandler instance is used.

An instance of this factory class will be set as the default bean factory for the BeanHelper class. This means that if not bean factory is specified in a BeanDeclaration, this default instance will be used.

Since:
1.3
  • Field Details

    • INSTANCE

      public static final DefaultBeanFactory INSTANCE
      Stores the default instance of this class.
    • FMT_CTOR_ERROR

      private static final String FMT_CTOR_ERROR
      A format string for generating error messages for constructor matching.
      See Also:
    • conversionHandler

      private final ConversionHandler conversionHandler
      The conversion handler used by this instance.
  • Constructor Details

    • DefaultBeanFactory

      public DefaultBeanFactory()
      Constructs a new instance of DefaultBeanFactory using a default ConversionHandler.
    • DefaultBeanFactory

      public DefaultBeanFactory(ConversionHandler convHandler)
      Constructs a new instance of DefaultBeanFactory using the specified ConversionHandler for data type conversions.
      Parameters:
      convHandler - the ConversionHandler; can be null, then a default handler is used
      Since:
      2.0
  • Method Details

    • getConversionHandler

      public ConversionHandler getConversionHandler()
      Gets the ConversionHandler used by this object.
      Returns:
      the ConversionHandler
      Since:
      2.0
    • createBean

      public Object createBean(BeanCreationContext bcc) throws Exception
      Creates a new bean instance. This implementation delegates to the protected methods createBeanInstance() and initBeanInstance() for creating and initializing the bean. This makes it easier for derived classes that need to change specific functionality of the base class.
      Specified by:
      createBean in interface BeanFactory
      Parameters:
      bcc - the context object defining the bean to be created
      Returns:
      the new bean instance
      Throws:
      Exception - if an error occurs
    • getDefaultBeanClass

      public Class<?> getDefaultBeanClass()
      Gets the default bean class used by this factory. This is always null for this implementation.
      Specified by:
      getDefaultBeanClass in interface BeanFactory
      Returns:
      the default bean class
    • createBeanInstance

      protected Object createBeanInstance(BeanCreationContext bcc) throws Exception
      Creates the bean instance. This method is called by createBean(). It uses reflection to create a new instance of the specified class.
      Parameters:
      bcc - the context object defining the bean to be created
      Returns:
      the new bean instance
      Throws:
      Exception - if an error occurs
    • initBeanInstance

      protected void initBeanInstance(Object bean, BeanCreationContext bcc) throws Exception
      Initializes the newly created bean instance. This method is called by createBean(). It calls the initBean() method of the context object for performing the initialization.
      Parameters:
      bean - the newly created bean instance
      bcc - the context object defining the bean to be created
      Throws:
      Exception - if an error occurs
    • findMatchingConstructor

      protected static <T> Constructor<T> findMatchingConstructor(Class<T> beanClass, BeanDeclaration data)
      Evaluates constructor arguments in the specified BeanDeclaration and tries to find a unique matching constructor. If this is not possible, an exception is thrown. Note: This method is intended to be used by concrete BeanFactory implementations and not by client code.
      Type Parameters:
      T - the type of the bean to be created
      Parameters:
      beanClass - the class of the bean to be created
      data - the current BeanDeclaration
      Returns:
      the single matching constructor
      Throws:
      ConfigurationRuntimeException - if no single matching constructor can be found
      NullPointerException - if the bean class or bean declaration are null
    • fetchConstructorArgs

      private Object[] fetchConstructorArgs(Constructor<?> ctor, BeanCreationContext bcc)
      Obtains the arguments for a constructor call to create a bean. This method resolves nested bean declarations and performs necessary type conversions.
      Parameters:
      ctor - the constructor to be invoked
      bcc - the context object defining the bean to be created
      Returns:
      an array with constructor arguments
    • nullSafeConstructorArgs

      private static Collection<ConstructorArg> nullSafeConstructorArgs(BeanDeclaration data)
      Fetches constructor arguments from the given bean declaration. Handles null values safely.
      Parameters:
      data - the bean declaration
      Returns:
      the collection with constructor arguments (never null)
    • findMatchingConstructors

      private static <T> List<Constructor<T>> findMatchingConstructors(Class<T> beanClass, BeanDeclaration data)
      Returns a list with all constructors which are compatible with the constructor arguments specified by the given BeanDeclaration.
      Parameters:
      beanClass - the bean class to be instantiated
      data - the current BeanDeclaration
      Returns:
      a list with all matching constructors
    • matchesConstructor

      private static boolean matchesConstructor(Constructor<?> ctor, Collection<ConstructorArg> args)
      Checks whether the given constructor is compatible with the given list of arguments.
      Parameters:
      ctor - the constructor to be checked
      args - the collection of constructor arguments
      Returns:
      a flag whether this constructor is compatible with the given arguments
    • getConstructorArgs

      private static Collection<ConstructorArg> getConstructorArgs(BeanDeclaration data)
      Gets constructor arguments from a bean declaration. Deals with null values.
      Parameters:
      data - the bean declaration
      Returns:
      the collection with constructor arguments (never null)
    • checkSingleMatchingConstructor

      private static <T> void checkSingleMatchingConstructor(Class<T> beanClass, BeanDeclaration data, List<Constructor<T>> matchingConstructors)
      Checks whether exactly one matching constructor was found. Throws a meaningful exception if there is not a single matching constructor.
      Parameters:
      beanClass - the bean class
      data - the bean declaration
      matchingConstructors - the list with matching constructors
      Throws:
      ConfigurationRuntimeException - if there is not exactly one match
    • constructorMatchingException

      private static ConfigurationRuntimeException constructorMatchingException(Class<?> beanClass, BeanDeclaration data, String msg)
      Constructs an exception if no single matching constructor was found with a meaningful error message.
      Parameters:
      beanClass - the affected bean class
      data - the bean declaration
      msg - an error message
      Returns:
      the exception with the error message