Add support for comma-delimited entries in configuration

Author: arteymix

src/ubic/basecode/util/ConfigUtils.java

@@ -22,6 +22,8 @@
 import org.apache.commons.configuration2.PropertiesConfiguration;
 import org.apache.commons.configuration2.builder.FileBasedBuilderParametersImpl;
 import org.apache.commons.configuration2.builder.FileBasedConfigurationBuilder;
+import org.apache.commons.configuration2.convert.DefaultListDelimiterHandler;
+import org.apache.commons.configuration2.convert.ListDelimiterHandler;
 import org.apache.commons.configuration2.ex.ConfigurationException;
 import org.apache.commons.configuration2.io.FileHandler;
 import org.apache.commons.configuration2.io.FileLocator;
@@ -36,6 +38,8 @@
  */
 public class ConfigUtils {
 
+    private static final ListDelimiterHandler LIST_DELIMITER_HANDLER = new DefaultListDelimiterHandler( ',' );
+
     /**
      * @param file
      * @return
@@ -51,7 +55,7 @@ public static FileBasedConfigurationBuilder<PropertiesConfiguration> getConfigBu
         }
         FileBasedConfigurationBuilder<PropertiesConfiguration> builder = new FileBasedConfigurationBuilder<PropertiesConfiguration>(
                 PropertiesConfiguration.class );
-        builder.configure( new FileBasedBuilderParametersImpl().setFile( file ) );
+        builder.configure( new FileBasedBuilderParametersImpl().setFile( file ).setListDelimiterHandler( LIST_DELIMITER_HANDLER ) );
         return builder;
     }
 
@@ -96,7 +100,7 @@ public static PropertiesConfiguration loadClasspathConfig( String name ) throws
             throw new ConfigurationException( "Couldn't locate: " + name );
         }
 
-        PropertiesConfiguration pc = new PropertiesConfiguration();
+        PropertiesConfiguration pc = createConfiguration();
         FileHandler handler = new FileHandler( pc );
         handler.setURL( url );
         handler.load();
@@ -116,7 +120,7 @@ public static PropertiesConfiguration loadConfig( File file ) throws Configurati
                 throw new ConfigurationException( "Couldn't create the file: " + e.getMessage() );
             }
         }
-        PropertiesConfiguration pc = new PropertiesConfiguration();
+        PropertiesConfiguration pc = createConfiguration();
         FileHandler handler = new FileHandler( pc );
         handler.setFile( file );
         handler.load();
@@ -187,4 +191,10 @@ public static URL locate( String name ) {
         FileLocator fl = FileLocatorUtils.fileLocator().fileName( name ).create();
         return FileLocatorUtils.locate( fl );
     }
+
+    private static PropertiesConfiguration createConfiguration() {
+        PropertiesConfiguration pc = new PropertiesConfiguration();
+        pc.setListDelimiterHandler( LIST_DELIMITER_HANDLER );
+        return pc;
+    }
 }

test/data/test.properties

@@ -1,3 +1,4 @@
 foo=bar
 ack=yup
 tek=6
+list=1,2 ,3

test/ubic/basecode/util/ConfigUtilsTest.java

@@ -14,10 +14,6 @@
  */
 package ubic.basecode.util;
 
-import static org.junit.Assert.assertEquals;
-import static org.junit.Assert.assertNotNull;
-import static org.junit.Assert.assertTrue;
-
 import java.io.File;
 
 import org.apache.commons.configuration2.PropertiesConfiguration;
@@ -27,6 +23,8 @@
 import org.junit.Before;
 import org.junit.Test;
 
+import static org.junit.Assert.*;
+
 /**
  * @author Paul
  *
@@ -58,6 +56,7 @@ public void testGetConfigBuilderFile() throws Exception {
                 testConfigPath ) );
         assertNotNull( config );
         assertEquals( "bar", config.getConfiguration().getProperty( "foo" ) );
+        assertArrayEquals( new String[] { "1", "2", "3" }, config.getConfiguration().getStringArray( "list" ) );
     }
 
     @Test