You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by oh...@apache.org on 2012/11/16 22:05:30 UTC
svn commit: r1410567 - in /commons/proper/configuration/trunk/src:
main/java/org/apache/commons/configuration/builder/BasicConfigurationBuilder.java
test/java/org/apache/commons/configuration/builder/TestBasicConfigurationBuilder.java
Author: oheger
Date: Fri Nov 16 21:05:28 2012
New Revision: 1410567
URL: http://svn.apache.org/viewvc?rev=1410567&view=rev
Log:
Added support for ignoring exceptions when initializing a new Configuration object to BasicConfigurationBuilder.
Modified:
commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration/builder/BasicConfigurationBuilder.java
commons/proper/configuration/trunk/src/test/java/org/apache/commons/configuration/builder/TestBasicConfigurationBuilder.java
Modified: commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration/builder/BasicConfigurationBuilder.java
URL: http://svn.apache.org/viewvc/commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration/builder/BasicConfigurationBuilder.java?rev=1410567&r1=1410566&r2=1410567&view=diff
==============================================================================
--- commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration/builder/BasicConfigurationBuilder.java (original)
+++ commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration/builder/BasicConfigurationBuilder.java Fri Nov 16 21:05:28 2012
@@ -70,6 +70,19 @@ import org.apache.commons.lang3.event.Ev
* </ul>
* </p>
* <p>
+ * A builder instance can be constructed with an <em>allowFailOnInit</em>
+ * flag. If set to <strong>true</strong>, exceptions during initialization
+ * of the configuration are ignored; in such a case an empty configuration
+ * object is returned. A use case for this flag is a scenario in which a
+ * configuration is optional and created on demand the first time configuration
+ * data is to be stored. Consider an application that stores user-specific
+ * configuration data in the user's home directory: When started for the first
+ * time by a new user there is no configuration file; so it makes sense to
+ * start with an empty configuration object. On application exit, settings
+ * can be stored in this object and written to the associated file. Then they
+ * are available on next application start.
+ * </p>
+ * <p>
* This class is thread-safe. Multiple threads can modify initialization
* properties and call {@code getConfiguration()}. However, the intended use
* case is that the builder is configured by a single thread first. Then
@@ -140,6 +153,9 @@ public class BasicConfigurationBuilder<T
/** An object managing the builder listeners registered at this builder. */
private final EventListenerSupport<BuilderListener> builderListeners;
+ /** A flag whether exceptions on initializing configurations are allowed. */
+ private final boolean allowFailOnInit;
+
/** The map with current initialization parameters. */
private Map<String, Object> parameters;
@@ -165,8 +181,8 @@ public class BasicConfigurationBuilder<T
/**
* Creates a new instance of {@code BasicConfigurationBuilder} and
* initializes it with the given result class and an initial set of builder
- * parameters. The map with parameters may be <b>null</b>, in this case no
- * initialization parameters are set.
+ * parameters. The <em>allowFailOnInit</em> flag is set to
+ * <strong>false</strong>.
*
* @param resCls the result class (must not be <b>null</b>
* @param params a map with initialization parameters
@@ -174,12 +190,32 @@ public class BasicConfigurationBuilder<T
*/
public BasicConfigurationBuilder(Class<T> resCls, Map<String, Object> params)
{
+ this(resCls, params, false);
+ }
+
+ /**
+ * Creates a new instance of {@code BasicConfigurationBuilder} and
+ * initializes it with the given result class, an initial set of builder
+ * parameters, and the <em>allowFailOnInit</em> flag. The map with
+ * parameters may be <b>null</b>, in this case no initialization parameters
+ * are set.
+ *
+ * @param resCls the result class (must not be <b>null</b>
+ * @param params a map with initialization parameters
+ * @param allowFailOnInit a flag whether exceptions on initializing a newly
+ * created {@code Configuration} object are allowed
+ * @throws IllegalArgumentException if the result class is <b>null</b>
+ */
+ public BasicConfigurationBuilder(Class<T> resCls,
+ Map<String, Object> params, boolean allowFailOnInit)
+ {
if (resCls == null)
{
throw new IllegalArgumentException("Result class must not be null!");
}
resultClass = resCls;
+ this.allowFailOnInit = allowFailOnInit;
configListeners = new ArrayList<ConfigurationListener>();
errorListeners = new ArrayList<ConfigurationErrorListener>();
builderListeners = EventListenerSupport.create(BuilderListener.class);
@@ -198,6 +234,17 @@ public class BasicConfigurationBuilder<T
}
/**
+ * Returns the <em>allowFailOnInit</em> flag. See the header comment for
+ * information about this flag.
+ *
+ * @return the <em>allowFailOnInit</em> flag
+ */
+ public boolean isAllowFailOnInit()
+ {
+ return allowFailOnInit;
+ }
+
+ /**
* Sets the initialization parameters of this builder. Already existing
* parameters are replaced by the content of the given map.
*
@@ -410,6 +457,9 @@ public class BasicConfigurationBuilder<T
* <li>{@code initResultInstance()} is called to process all initialization
* parameters.</li>
* </ul>
+ * It also evaluates the <em>allowFailOnInit</em> flag, i.e. if
+ * initialization causes an exception and this flag is set, the exception is
+ * ignored, and the newly created, uninitialized configuration is returned.
* Note that this method is called in a synchronized block.
*
* @return the newly created result object
@@ -418,7 +468,19 @@ public class BasicConfigurationBuilder<T
protected T createResult() throws ConfigurationException
{
T resObj = createResultInstance();
- initResultInstance(resObj);
+
+ try
+ {
+ initResultInstance(resObj);
+ }
+ catch (ConfigurationException cex)
+ {
+ if (!isAllowFailOnInit())
+ {
+ throw cex;
+ }
+ }
+
return resObj;
}
Modified: commons/proper/configuration/trunk/src/test/java/org/apache/commons/configuration/builder/TestBasicConfigurationBuilder.java
URL: http://svn.apache.org/viewvc/commons/proper/configuration/trunk/src/test/java/org/apache/commons/configuration/builder/TestBasicConfigurationBuilder.java?rev=1410567&r1=1410566&r2=1410567&view=diff
==============================================================================
--- commons/proper/configuration/trunk/src/test/java/org/apache/commons/configuration/builder/TestBasicConfigurationBuilder.java (original)
+++ commons/proper/configuration/trunk/src/test/java/org/apache/commons/configuration/builder/TestBasicConfigurationBuilder.java Fri Nov 16 21:05:28 2012
@@ -461,6 +461,32 @@ public class TestBasicConfigurationBuild
}
/**
+ * Tests an exception during configuration initialization if the
+ * allowFailOnInit flag is false.
+ */
+ @Test(expected = ConfigurationException.class)
+ public void testInitializationErrorNotAllowed()
+ throws ConfigurationException
+ {
+ BasicConfigurationBuilderInitFailImpl builder =
+ new BasicConfigurationBuilderInitFailImpl(false);
+ builder.getConfiguration();
+ }
+
+ /**
+ * Tests an exception during configuration initialization if the
+ * allowFailOnInit flag is true.
+ */
+ @Test
+ public void testInitializationErrorAllowed() throws ConfigurationException
+ {
+ BasicConfigurationBuilderInitFailImpl builder =
+ new BasicConfigurationBuilderInitFailImpl(true);
+ PropertiesConfiguration config = builder.getConfiguration();
+ assertTrue("Got data", config.isEmpty());
+ }
+
+ /**
* A test thread class for testing whether the builder's result object can
* be requested concurrently.
*/
@@ -511,4 +537,27 @@ public class TestBasicConfigurationBuild
}
}
}
+
+ /**
+ * A builder test implementation which allows checking exception handling
+ * when creating new configuration objects.
+ */
+ private static class BasicConfigurationBuilderInitFailImpl extends
+ BasicConfigurationBuilder<PropertiesConfiguration>
+ {
+ public BasicConfigurationBuilderInitFailImpl(boolean allowFailOnInit)
+ {
+ super(PropertiesConfiguration.class, null, allowFailOnInit);
+ }
+
+ /**
+ * {@inheritDoc} This implementation only throws an exception.
+ */
+ @Override
+ protected void initResultInstance(PropertiesConfiguration obj)
+ throws ConfigurationException
+ {
+ throw new ConfigurationException("Initialization test exception!");
+ }
+ }
}