Merge pull request #26 from brianjmiller/dacdave_map_improvements

Add iterator class in LanguageMap and a few convenience methods

Author: bscSCORM

src/main/java/com/rusticisoftware/tincan/LanguageMap.java

@@ -21,6 +21,7 @@
 import java.util.HashMap;
 import java.util.Iterator;
 import java.util.Map;
+import java.util.Map.Entry;
 
 import com.rusticisoftware.tincan.json.JSONBase;
 import com.rusticisoftware.tincan.json.Mapper;
@@ -29,9 +30,31 @@
  * Language map
  */
 @NoArgsConstructor
-public class LanguageMap extends JSONBase {
+public class LanguageMap extends JSONBase implements Iterable<Map.Entry<String, String>> {
     private final HashMap<String,String> _map = new HashMap<String, String>();
 
+    private class LanguageMapIterator implements Iterator<Map.Entry<String, String>> {
+        private Iterator<Map.Entry<String, String>> iterator;
+
+        public LanguageMapIterator() {
+            iterator = _map.entrySet().iterator();
+        }
+        @Override
+        public boolean hasNext() {
+            return iterator.hasNext();
+        }
+
+        @Override
+        public Entry<String, String> next() {
+            return iterator.next();
+        }
+
+        @Override
+        public void remove() throws UnsupportedOperationException {
+            throw new UnsupportedOperationException(
+                "LanguageMap iterator does not implement the remove method");
+        }
+    }
     public LanguageMap(JsonNode jsonNode) {
         this();
 
@@ -56,8 +79,38 @@ public ObjectNode toJSONNode(TCAPIVersion version) {
     public String put(String key, String val) {
         return this._map.put(key, val);
     }
+    
+    public String put(Map.Entry<String, String> entry) {
+        return this.put(entry.getKey(), entry.getValue());
+    }
 
     public String get(String key) {
         return this._map.get(key);
     }
+
+    public boolean containsKey(String key) {
+        return this._map.containsKey(key);
+    }
+
+    public boolean containsValue(String value) {
+        return this._map.containsValue(value);
+    }
+
+    public Map.Entry<String, String> findFirstValue(String value) {
+        Map.Entry<String, String> retVal = null;
+        Iterator<Map.Entry<String,String>> it = this.iterator();
+        while (it.hasNext()) {
+            Map.Entry<String, String> n = it.next();
+            if (n.getValue().equalsIgnoreCase(value)) {
+                retVal = n;
+                break;
+            }
+        }
+        return retVal;
+    }
+
+    @Override
+    public Iterator<Entry<String, String>> iterator() {
+        return new LanguageMapIterator();
+    }
 }

src/test/java/com/rusticisoftware/tincan/LanguageMapTest.java

@@ -16,6 +16,11 @@
 package com.rusticisoftware.tincan;
 
 import static com.rusticisoftware.tincan.TestUtils.assertSerializeDeserialize;
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertTrue;
+
+import java.io.IOException;
+import java.util.Map;
 
 import org.junit.Test;
 
@@ -31,4 +36,39 @@ public void serializeDeserialize() throws Exception {
         lm.put("es-ES", "Some espanol");
         assertSerializeDeserialize(lm);
     }
+
+    @Test
+    public void fillAndIterate() {
+        LanguageMap lm = new LanguageMap();
+        LanguageMap lmCopy = new LanguageMap();
+        lm.put("und", "Some text");
+        lm.put("en-US", "Some english");
+        lm.put("es-ES", "Some espanol");
+
+        for (Map.Entry<String, String> entry : lm) {
+            lmCopy.put(entry);
+        }
+
+        String lmContent = "";
+        try {
+            lmContent = lm.toJSON();
+        } catch (IOException e) {
+            lmContent = "";
+        }
+        String lmCopyContent = "";
+        try {
+            lmCopyContent = lmCopy.toJSON();
+        } catch (IOException e) {
+            lmCopyContent = ""; 
+            }
+        assertEquals(lmContent, lmCopyContent);
+
+        boolean hasKey = lm.containsKey("und");
+        boolean hasValue = lm.containsValue("Some english");
+        Map.Entry<String, String> entry = lm.findFirstValue("Some espanol");
+
+        assertTrue(hasKey);
+        assertTrue(hasValue);
+        assertEquals(entry.getKey(), "es-ES");
+    }
 }