Add and use

ConfigurationRuntimeException.ConfigurationRuntimeException(Throwable,
String, Object...)

Author: garydgregory

src/changes/changes.xml

@@ -33,6 +33,7 @@
       <action type="add" dev="ggregory" due-to="Gary Gregory">Add ConfigurationException.ConfigurationException(Throwable, String, Object...).</action>
       <action type="add" dev="ggregory" due-to="Gary Gregory">Add ConversionException.ConversionException(String, Object...).</action>
       <action type="add" dev="ggregory" due-to="Gary Gregory">Add ConversionException.ConversionException(Throwable, String, Object...).</action>
+      <action type="add" dev="ggregory" due-to="Gary Gregory">Add ConfigurationRuntimeException.ConfigurationRuntimeException(Throwable, String, Object...).</action>
       <!-- UPDATE -->
       <action type="update" dev="ggregory" due-to="Gary Gregory">Bump org.apache.commons:commons-parent from 92 to 97.</action>
       <action type="update" dev="ggregory" due-to="Gary Gregory">Bump org.apache.commons:commons-text from 1.14.0 to 1.15.0.</action>

src/main/java/org/apache/commons/configuration2/ConfigurationUtils.java

@@ -446,8 +446,8 @@ public static Class<?> loadClass(final String clsName) throws ClassNotFoundExcep
     public static Class<?> loadClassNoEx(final String clsName) {
         try {
             return loadClass(clsName);
-        } catch (final ClassNotFoundException cnfex) {
-            throw new ConfigurationRuntimeException("Cannot load class " + clsName, cnfex);
+        } catch (final ClassNotFoundException e) {
+            throw new ConfigurationRuntimeException(e, "Cannot load class %s", clsName);
         }
     }
 

src/main/java/org/apache/commons/configuration2/PropertiesConfiguration.java

@@ -1181,8 +1181,8 @@ protected static String unescapeJava(final String str, final boolean jupCompatib
                         unicode.setLength(0);
                         inUnicode = false;
                         hadSlash = false;
-                    } catch (final NumberFormatException nfe) {
-                        throw new ConfigurationRuntimeException("Unable to parse unicode value: " + unicode, nfe);
+                    } catch (final NumberFormatException e) {
+                        throw new ConfigurationRuntimeException(e, "Unable to parse unicode value: %s", unicode);
                     }
                 }
                 continue;

src/main/java/org/apache/commons/configuration2/ex/ConfigurationRuntimeException.java

@@ -45,11 +45,10 @@ public ConfigurationRuntimeException(final String message) {
     }
 
     /**
-     * Constructs a new {@code ConfigurationRuntimeException} with specified detail message using
-     * {@link String#format(String,Object...)}.
+     * Constructs a new {@code ConfigurationRuntimeException} with specified detail message using {@link String#format(String,Object...)}.
      *
      * @param message the error message
-     * @param args arguments to the error message
+     * @param args    arguments to the error message
      * @see String#format(String,Object...)
      */
     public ConfigurationRuntimeException(final String message, final Object... args) {
@@ -60,7 +59,7 @@ public ConfigurationRuntimeException(final String message, final Object... args)
      * Constructs a new {@code ConfigurationRuntimeException} with specified detail message and nested {@code Throwable}.
      *
      * @param message the error message
-     * @param cause the exception or error that caused this exception to be thrown
+     * @param cause   the exception or error that caused this exception to be thrown
      */
     public ConfigurationRuntimeException(final String message, final Throwable cause) {
         super(message, cause);
@@ -74,4 +73,17 @@ public ConfigurationRuntimeException(final String message, final Throwable cause
     public ConfigurationRuntimeException(final Throwable cause) {
         super(cause);
     }
+
+    /**
+     * Constructs a new {@code ConfigurationRuntimeException} with specified detail message.
+     *
+     * @param format the error message for for {@link String#format(String, Object...)}.
+     * @param params the error parameters for for {@link String#format(String, Object...)}.
+     * @param cause  the cause (which is saved for later retrieval by the {@link #getCause()} method). (A {@code null} value is permitted, and indicates that
+     *               the cause is nonexistent or unknown.)
+     * @since 2.14.0
+     */
+    public ConfigurationRuntimeException(final Throwable cause, final String format, final Object... params) {
+        super(String.format(format, params), cause);
+    }
 }

src/main/java/org/apache/commons/configuration2/ex/ConversionException.java

@@ -84,6 +84,6 @@ public ConversionException(final Throwable cause) {
      * @since 2.14.0
      */
     public ConversionException(final Throwable cause, final String format, final Object... params) {
-        super(String.format(format, params), cause);
+        super(cause, format, params);
     }
 }

src/main/java/org/apache/commons/configuration2/interpol/ExprLookup.java

@@ -140,7 +140,7 @@ public void setValue(final Object value) throws ConfigurationRuntimeException {
                     this.value = clazz;
                 }
             } catch (final Exception e) {
-                throw new ConfigurationRuntimeException("Unable to create " + value, e);
+                throw new ConfigurationRuntimeException(e, "Unable to create %s", value);
             }
 
         }

src/main/java/org/apache/commons/configuration2/io/VFSFileSystem.java

@@ -222,8 +222,8 @@ public URL getURL(final String basePath, final String file) throws MalformedURLE
 
             final URLStreamHandler handler = new VFSURLStreamHandler();
             return new URL(null, path.getURI(), handler);
-        } catch (final FileSystemException fse) {
-            throw new ConfigurationRuntimeException("Could not parse basePath: " + basePath + " and fileName: " + file, fse);
+        } catch (final FileSystemException e) {
+            throw new ConfigurationRuntimeException(e, "Could not parse basePath: %s and fileName: %s", basePath, file);
         }
     }
 

src/main/java/org/apache/commons/configuration2/reloading/VFSFileHandlerReloadingDetector.java

@@ -93,10 +93,10 @@ protected FileObject getFileObject() {
                 throw new ConfigurationRuntimeException("Unable to determine file to monitor");
             }
             return fsManager.resolveFile(uri);
-        } catch (final FileSystemException fse) {
+        } catch (final FileSystemException e) {
             final String msg = "Unable to monitor " + getFileHandler().getURL().toString();
             log.error(msg);
-            throw new ConfigurationRuntimeException(msg, fse);
+            throw new ConfigurationRuntimeException(msg, e);
         }
     }
 

src/test/java/org/apache/commons/configuration2/DatabaseConfigurationTestHelper.java

@@ -106,8 +106,8 @@ public DataSource getDataSource() {
         if (dataSource == null) {
             try {
                 dataSource = setUpDataSource();
-            } catch (final Exception ex) {
-                throw new ConfigurationRuntimeException("Could not create data source", ex);
+            } catch (final Exception e) {
+                throw new ConfigurationRuntimeException("Could not create data source", e);
             }
         }
         return dataSource;