You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@commons.apache.org by oh...@apache.org on 2006/02/24 10:54:08 UTC

svn commit: r380634 - in /jakarta/commons/proper/configuration/trunk/src: java/org/apache/commons/configuration/beanutils/ test/org/apache/commons/configuration/beanutils/

Author: oheger
Date: Fri Feb 24 01:53:54 2006
New Revision: 380634

URL: http://svn.apache.org/viewcvs?rev=380634&view=rev
Log:
Added support for an additional parameter to BeanFactory

Modified:
    jakarta/commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/beanutils/BeanFactory.java
    jakarta/commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/beanutils/BeanHelper.java
    jakarta/commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/beanutils/DefaultBeanFactory.java
    jakarta/commons/proper/configuration/trunk/src/test/org/apache/commons/configuration/beanutils/TestBeanHelper.java
    jakarta/commons/proper/configuration/trunk/src/test/org/apache/commons/configuration/beanutils/TestDefaultBeanFactory.java
    jakarta/commons/proper/configuration/trunk/src/test/org/apache/commons/configuration/beanutils/TestXMLBeanDeclaration.java

Modified: jakarta/commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/beanutils/BeanFactory.java
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/beanutils/BeanFactory.java?rev=380634&r1=380633&r2=380634&view=diff
==============================================================================
--- jakarta/commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/beanutils/BeanFactory.java (original)
+++ jakarta/commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/beanutils/BeanFactory.java Fri Feb 24 01:53:54 2006
@@ -37,7 +37,7 @@
  * creates. Then it is not necessary to specify a bean class in the bean
  * declaration.
  * </p>
- * 
+ *
  * @since 1.3
  * @author Oliver Heger
  * @version $Id$
@@ -48,23 +48,26 @@
      * Returns a bean instance for the given class. The bean will be initialized
      * from the specified bean declaration object. It is up to a concrete
      * implementation how the bean will be created and initialized.
-     * 
+     *
      * @param beanClass the class for the bean
      * @param data the bean declaration object containing all data about the
      * bean to be created
+     * @param param an additional parameter that may be passed by calling code;
+     * it is up to a concrete implementation how this parameter is evaluated
      * @return the new bean instance (should not be <b>null</b>)
      * @throws Exception if an error occurs (the helper classes for creating
      * beans will catch this unspecific exception and wrap it in a configuration
      * exception)
      */
-    Object createBean(Class beanClass, BeanDeclaration data) throws Exception;
+    Object createBean(Class beanClass, BeanDeclaration data, Object param)
+            throws Exception;
 
     /**
      * Returns the default bean class of this bean factory. If an implementation
      * here returns a non <b>null</b> value, bean declarations using this
      * factory do not need to provide the name of the bean class. In such a case
      * an instance of the default class will be created.
-     * 
+     *
      * @return the default class of this factory or <b>null</b> if there is
      * none
      */

Modified: jakarta/commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/beanutils/BeanHelper.java
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/beanutils/BeanHelper.java?rev=380634&r1=380633&r2=380634&view=diff
==============================================================================
--- jakarta/commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/beanutils/BeanHelper.java (original)
+++ jakarta/commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/beanutils/BeanHelper.java Fri Feb 24 01:53:54 2006
@@ -221,11 +221,14 @@
      *
      * @param data the bean declaration
      * @param defaultClass the default class to use
+     * @param param an additional parameter that will be passed to the bean
+     * factory; some factories may support parameters and behave different
+     * depending on the value passed in here
      * @return the new bean
      * @throws ConfigurationRuntimeException if an error occurs
      */
-    public static Object createBean(BeanDeclaration data, Class defaultClass)
-            throws ConfigurationRuntimeException
+    public static Object createBean(BeanDeclaration data, Class defaultClass,
+            Object param) throws ConfigurationRuntimeException
     {
         if (data == null)
         {
@@ -237,12 +240,26 @@
         try
         {
             return factory.createBean(fetchBeanClass(data, defaultClass,
-                    factory), data);
+                    factory), data, param);
         }
         catch (Exception ex)
         {
             throw new ConfigurationRuntimeException(ex);
         }
+    }
+
+    /**
+     * Returns a bean instance for the specified declaration. This method is a
+     * short cut for <code>createBean(data, null, null);</code>.
+     *
+     * @param data the bean declaration
+     * @return the new bean
+     * @throws ConfigurationRuntimeException if an error occurs
+     */
+    public static Object createBean(BeanDeclaration data, Class defaultClass)
+            throws ConfigurationRuntimeException
+    {
+        return createBean(data, defaultClass, null);
     }
 
     /**

Modified: jakarta/commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/beanutils/DefaultBeanFactory.java
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/beanutils/DefaultBeanFactory.java?rev=380634&r1=380633&r2=380634&view=diff
==============================================================================
--- jakarta/commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/beanutils/DefaultBeanFactory.java (original)
+++ jakarta/commons/proper/configuration/trunk/src/java/org/apache/commons/configuration/beanutils/DefaultBeanFactory.java Fri Feb 24 01:53:54 2006
@@ -50,11 +50,12 @@
      * @param beanClass the class of the bean, from which an instance is to be
      * created
      * @param data the bean declaration object
+     * @param param an additional parameter (ignored by this implementation)
      * @return the new bean instance
      * @throws Exception if an error occurs
      */
-    public Object createBean(Class beanClass, BeanDeclaration data)
-            throws Exception
+    public Object createBean(Class beanClass, BeanDeclaration data,
+            Object parameter) throws Exception
     {
         Object result = createBeanInstance(beanClass, data);
         initBeanInstance(result, data);

Modified: jakarta/commons/proper/configuration/trunk/src/test/org/apache/commons/configuration/beanutils/TestBeanHelper.java
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/configuration/trunk/src/test/org/apache/commons/configuration/beanutils/TestBeanHelper.java?rev=380634&r1=380633&r2=380634&view=diff
==============================================================================
--- jakarta/commons/proper/configuration/trunk/src/test/org/apache/commons/configuration/beanutils/TestBeanHelper.java (original)
+++ jakarta/commons/proper/configuration/trunk/src/test/org/apache/commons/configuration/beanutils/TestBeanHelper.java Fri Feb 24 01:53:54 2006
@@ -205,11 +205,13 @@
      */
     public void testCreateBean()
     {
-        BeanHelper.registerBeanFactory(TEST_FACTORY, new TestBeanFactory());
+        TestBeanFactory factory = new TestBeanFactory();
+        BeanHelper.registerBeanFactory(TEST_FACTORY, factory);
         TestBeanDeclaration data = setUpBeanDeclaration();
         data.setBeanFactoryName(TEST_FACTORY);
         data.setBeanClassName(TestBean.class.getName());
         checkBean((TestBean) BeanHelper.createBean(data, null));
+        assertNull("A parameter was passed", factory.parameter);
     }
 
     /**
@@ -347,6 +349,21 @@
     }
 
     /**
+     * Tests if a parameter is correctly passed to the bean factory.
+     */
+    public void testCreateBeanWithParameter()
+    {
+        Object param = new Integer(42);
+        TestBeanFactory factory = new TestBeanFactory();
+        BeanHelper.registerBeanFactory(TEST_FACTORY, factory);
+        TestBeanDeclaration data = setUpBeanDeclaration();
+        data.setBeanFactoryName(TEST_FACTORY);
+        data.setBeanClassName(TestBean.class.getName());
+        checkBean((TestBean) BeanHelper.createBean(data, null, param));
+        assertSame("Wrong parameter", param, factory.parameter);
+    }
+
+    /**
      * Returns an initialized bean declaration.
      *
      * @return the bean declaration
@@ -441,11 +458,14 @@
      */
     static class TestBeanFactory implements BeanFactory
     {
+        Object parameter;
+
         boolean supportsDefaultClass;
 
-        public Object createBean(Class beanClass, BeanDeclaration data)
+        public Object createBean(Class beanClass, BeanDeclaration data, Object param)
                 throws Exception
         {
+            parameter = param;
             if (TestBean.class.equals(beanClass))
             {
                 TestBean bean = new TestBean();

Modified: jakarta/commons/proper/configuration/trunk/src/test/org/apache/commons/configuration/beanutils/TestDefaultBeanFactory.java
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/configuration/trunk/src/test/org/apache/commons/configuration/beanutils/TestDefaultBeanFactory.java?rev=380634&r1=380633&r2=380634&view=diff
==============================================================================
--- jakarta/commons/proper/configuration/trunk/src/test/org/apache/commons/configuration/beanutils/TestDefaultBeanFactory.java (original)
+++ jakarta/commons/proper/configuration/trunk/src/test/org/apache/commons/configuration/beanutils/TestDefaultBeanFactory.java Fri Feb 24 01:53:54 2006
@@ -54,7 +54,7 @@
     public void testCreateBean() throws Exception
     {
         Object bean = factory.createBean(PropertiesConfiguration.class,
-                new TestBeanDeclaration());
+                new TestBeanDeclaration(), null);
         assertNotNull("New bean is null", bean);
         assertEquals("Bean is of wrong class", PropertiesConfiguration.class,
                 bean.getClass());

Modified: jakarta/commons/proper/configuration/trunk/src/test/org/apache/commons/configuration/beanutils/TestXMLBeanDeclaration.java
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/configuration/trunk/src/test/org/apache/commons/configuration/beanutils/TestXMLBeanDeclaration.java?rev=380634&r1=380633&r2=380634&view=diff
==============================================================================
--- jakarta/commons/proper/configuration/trunk/src/test/org/apache/commons/configuration/beanutils/TestXMLBeanDeclaration.java (original)
+++ jakarta/commons/proper/configuration/trunk/src/test/org/apache/commons/configuration/beanutils/TestXMLBeanDeclaration.java Fri Feb 24 01:53:54 2006
@@ -122,6 +122,24 @@
     }
 
     /**
+     * Tests creating a declaration from a null configuration with a node. This
+     * should cause an exception.
+     */
+    public void testInitFromNullConfigurationAndNode()
+    {
+        try
+        {
+            decl = new XMLBeanDeclaration(null, new HierarchicalConfiguration()
+                    .getRoot());
+            fail("Could init declaration with null configuration and node!");
+        }
+        catch (IllegalArgumentException iex)
+        {
+            // ok
+        }
+    }
+
+    /**
      * Tests fetching the bean's class name.
      */
     public void testGetBeanClassName()



---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org