commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ohe...@apache.org
Subject svn commit: r1638379 - in /commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2: AbstractConfiguration.java ImmutableConfiguration.java
Date Tue, 11 Nov 2014 20:44:46 GMT
Author: oheger
Date: Tue Nov 11 20:44:46 2014
New Revision: 1638379

URL: http://svn.apache.org/r1638379
Log:
Added methods for querying encoded strings to ImmutableConfiguration.

With these methods it is possible to query the values of configuration
properties stored in encoded form. Before they are handed to the calling
application, the values are passed to a ConfigurationDecoder.

Modified:
    commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/AbstractConfiguration.java
    commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/ImmutableConfiguration.java

Modified: commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/AbstractConfiguration.java
URL: http://svn.apache.org/viewvc/commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/AbstractConfiguration.java?rev=1638379&r1=1638378&r2=1638379&view=diff
==============================================================================
--- commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/AbstractConfiguration.java
(original)
+++ commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/AbstractConfiguration.java
Tue Nov 11 20:44:46 2014
@@ -1288,6 +1288,18 @@ public abstract class AbstractConfigurat
         return (result != null) ? result : interpolate(defaultValue);
     }
 
+    @Override
+    public String getEncodedString(String key, ConfigurationDecoder decoder) {
+        //TODO implementation
+        throw new UnsupportedOperationException("Not yet implemented!");
+    }
+
+    @Override
+    public String getEncodedString(String key) {
+        //TODO implementation
+        throw new UnsupportedOperationException("Not yet implemented!");
+    }
+
     /**
      * Get an array of strings associated with the given configuration key.
      * If the key doesn't map to an existing object, an empty array is returned.

Modified: commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/ImmutableConfiguration.java
URL: http://svn.apache.org/viewvc/commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/ImmutableConfiguration.java?rev=1638379&r1=1638378&r2=1638379&view=diff
==============================================================================
--- commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/ImmutableConfiguration.java
(original)
+++ commons/proper/configuration/trunk/src/main/java/org/apache/commons/configuration2/ImmutableConfiguration.java
Tue Nov 11 20:44:46 2014
@@ -483,6 +483,36 @@ public interface ImmutableConfiguration
     String getString(String key, String defaultValue);
 
     /**
+     * Get the value of a string property that is stored in encoded form in this
+     * configuration. This method obtains the value of the string property
+     * identified by the given key. This value is then passed to the provided
+     * {@code ConfigurationDecoder}. The value returned by the
+     * {@code ConfigurationDecoder} is passed to the caller. If the key is not
+     * associated with a value, the decoder is not invoked; depending on this
+     * configuration's settings either <b>null</b> is returned or an exception
+     * is thrown.
+     *
+     * @param key the configuration key
+     * @param decoder the {@code ConfigurationDecoder} (must not be <b>null</b>)
+     * @return the plain string value of the specified encoded property
+     * @throws IllegalArgumentException if a <b>null</b> decoder is passed
+     */
+    String getEncodedString(String key, ConfigurationDecoder decoder);
+
+    /**
+     * Get the value of a string property that is stored in encoded form in this
+     * configuration using a default {@code ConfigurationDecoder}. This method
+     * works like the method with the same name, but it uses a default
+     * {@code ConfigurationDecoder} associated with this configuration. It
+     * depends on a specific implementation how this default decoder is
+     * obtained.
+     *
+     * @param key the configuration key
+     * @return the plain string value of the specified encoded property
+     */
+    String getEncodedString(String key);
+
+    /**
      * Get an array of strings associated with the given configuration key.
      * If the key doesn't map to an existing object an empty array is returned
      *



Mime
View raw message