[CSV-105] Add Map conversion API to CSVRecord.

git-svn-id: https://svn.apache.org/repos/asf/commons/proper/csv/trunk@1559905 13f79535-47bb-0310-9956-ffa450edef68

Author: garydgregory

src/main/java/org/apache/commons/csv/CSVRecord.java

@@ -19,8 +19,10 @@
 
 import java.io.Serializable;
 import java.util.Arrays;
+import java.util.HashMap;
 import java.util.Iterator;
 import java.util.Map;
+import java.util.Map.Entry;
 
 /**
  * A CSV record parsed from a CSV file.
@@ -167,6 +169,19 @@ public Iterator<String> iterator() {
         return Arrays.asList(values).iterator();
     }
 
+    /**
+     * Puts all values of this record into the given Map.
+     * 
+     * @param map The Map to populate.
+     * @return the given map.
+     */
+    public Map<String, String> putIn(Map<String, String> map) {
+        for (Entry<String, Integer> entry : mapping.entrySet()) {
+            map.put(entry.getKey(), values[entry.getValue().intValue()]);
+        }
+        return map;
+    }
+
     /**
      * Returns the number of values in this record.
      *
@@ -176,6 +191,15 @@ public int size() {
         return values.length;
     }
 
+    /**
+     * Converts this record into a Map.
+     * 
+     * @return A new Map. The map is empty if the record has no headers.
+     */
+    public Map<String, String> toMap() {
+        return putIn(new HashMap<String, String>(values.length));
+    }
+
     @Override
     public String toString() {
         return Arrays.toString(values);

src/test/java/org/apache/commons/csv/CSVRecordTest.java

@@ -23,6 +23,7 @@
 
 import java.util.HashMap;
 import java.util.Map;
+import java.util.concurrent.ConcurrentHashMap;
 
 import org.junit.Before;
 import org.junit.Test;
@@ -37,7 +38,7 @@ private enum EnumFixture { UNKNOWN_COLUMN }
 
     @Before
     public void setUp() throws Exception {
-        values = new String[] { "first", "second", "third" };
+        values = new String[] { "A", "B", "C" };
         record = new CSVRecord(values, null, null, 0);
         header = new HashMap<String, Integer>();
         header.put("first", Integer.valueOf(0));
@@ -123,4 +124,31 @@ public void testIterator() {
         }
     }
 
+    @Test
+    public void testPutInMap() {
+        Map<String, String> map = new ConcurrentHashMap<String, String>();
+        this.recordWithHeader.putIn(map);
+        this.validateMap(map, false);
+    }
+
+    @Test
+    public void testToMap() {
+        Map<String, String> map = this.recordWithHeader.toMap();
+        this.validateMap(map, true);
+    }
+
+    private void validateMap(Map<String, String> map, boolean allowsNulls) {
+        assertTrue(map.containsKey("first"));
+        assertTrue(map.containsKey("second"));
+        assertTrue(map.containsKey("third"));
+        assertFalse(map.containsKey("fourth"));
+        if (allowsNulls) {
+            assertFalse(map.containsKey(null));
+        }
+        assertEquals("A", map.get("first"));
+        assertEquals("B", map.get("second"));
+        assertEquals("C", map.get("third"));
+        assertEquals(null, map.get("fourth"));
+    }
+
 }