Merge pull request #39 from csmith/master

Put MapList to rest.

src/com/dmdirc/util/collections/MapList.java

@@ -1,261 +0,0 @@
-/*
- * Copyright (c) 2006-2015 DMDirc Developers
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in
- * all copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-
-package com.dmdirc.util.collections;
-
-import java.util.ArrayList;
-import java.util.Collection;
-import java.util.Collections;
-import java.util.HashMap;
-import java.util.List;
-import java.util.Map;
-import java.util.Set;
-
-/**
- * Wraps a Map<S, List<T>> with various convenience methods for
- * accessing the data. Implements a Map-like interface for easier transition.
- * <p>
- * <strong>Note that this implementation is not synchronized.</strong> If
- * multiple threads access a <code>MapList</code> instance concurrently, and
- * at least one of the threads modifies the map, it <em>must</em> be
- * synchronized externally.
- * <p>
- * The <code>List</code>s used to back this map are synchronized using the
- * {@link Collections#synchronizedList(List)} method, which requires
- * manual synchronization in any code iterating over the values.
- *
- * @param <S> the type of keys maintained by this map
- * @param <T> the type of mapped values
- */
-public class MapList<S, T> {
-
-    /** Our internal map. */
-    protected final Map<S, List<T>> map;
-
-    /**
-     * Creates a new, empty MapList.
-     */
-    public MapList() {
-        map = new HashMap<>();
-    }
-
-    /**
-     * Creates a new MapList with the values from the specified list.
-     *
-     * @param list The MapList whose values should be used
-     */
-    public MapList(final MapList<S, T> list) {
-        map = list.getMap();
-    }
-
-    /**
-     * Determines if this MapList is empty. An empty MapList is one that either
-     * contains no keys, or contains only keys which have no associated values.
-     *
-     * @return True if this MapList is empty, false otherwise
-     */
-    public boolean isEmpty() {
-        for (List<T> list : map.values()) {
-            if (!list.isEmpty()) {
-                return false;
-            }
-        }
-
-        return true;
-    }
-
-    /**
-     * Determines if this MapList contains the specified key.
-     *
-     * @param key The key to look for
-     * @return True if this MapList contains the specified key, false otherwise
-     */
-    public boolean containsKey(final S key) {
-        return map.containsKey(key);
-    }
-
-    /**
-     * Determines if this MapList contains the specified value as a child of
-     * the specified key.
-     *
-     * @param key The key to search under
-     * @param value The value to look for
-     * @return True if this MapList contains the specified key/value pair,
-     * false otherwise
-     */
-    public boolean containsValue(final S key, final T value) {
-        return map.containsKey(key) && map.get(key).contains(value);
-    }
-
-    /**
-     * Retrieves the list of values associated with the specified key.
-     *
-     * @param key The key whose values are being retrieved
-     * @return The values belonging to the specified key
-     */
-    public List<T> get(final S key) {
-        return map.get(key);
-    }
-
-    /**
-     * Retrieves the value at the specified offset of the specified key.
-     *
-     * @param key The key whose values are being retrieved
-     * @param index The index of the value to retrieve
-     * @return The specified value of the key
-     */
-    public T get(final S key, final int index) {
-        return map.get(key).get(index);
-    }
-
-    /**
-     * Retrieves the list of values associated with the specified key, creating
-     * the key if necessary.
-     *
-     * @param key The key to retrieve
-     * @return A list of the specified key's values
-     */
-    public List<T> safeGet(final S key) {
-        if (!map.containsKey(key)) {
-            map.put(key, Collections.synchronizedList(new ArrayList<>()));
-        }
-
-        return map.get(key);
-    }
-
-    /**
-     * Adds the specified key to the MapList.
-     *
-     * @param key The key to be added
-     */
-    public void add(final S key) {
-        safeGet(key);
-    }
-
-    /**
-     * Adds the specified value as a child of the specified key. If the key
-     * didn't previous exist, it is created.
-     *
-     * @param key The key to which the value is being added
-     * @param value The value to be added
-     */
-    public void add(final S key, final T value) {
-        safeGet(key).add(value);
-    }
-
-    /**
-     * Adds the specified set of values to the specified key. If the key
-     * didn't previous exist, it is created.
-     *
-     * @param key The key to which the value is being added
-     * @param values The values to be added
-     */
-    public void add(final S key, final Collection<T> values) {
-        safeGet(key).addAll(values);
-    }
-
-    /**
-     * Removes the specified key and all of its values.
-     *
-     * @param key The key to remove
-     */
-    public void remove(final S key) {
-        map.remove(key);
-    }
-
-    /**
-     * Removes the specified value from all keys.
-     *
-     * @param value The value to remove
-     */
-    public void removeFromAll(final T value) {
-        for (List<T> list : map.values()) {
-            list.remove(value);
-        }
-    }
-
-    /**
-     * Removes the specified value from the specified key.
-     *
-     * @param key The key whose value is being removed
-     * @param value The value to be removed
-     */
-    public void remove(final S key, final T value) {
-        if (map.containsKey(key)) {
-            map.get(key).remove(value);
-        }
-    }
-
-    /**
-     * Entirely clears this MapList.
-     */
-    public void clear() {
-        map.clear();
-    }
-
-    /**
-     * Clears all values of the specified key.
-     *
-     * @param key The key to be cleared
-     */
-    public void clear(final S key) {
-        safeGet(key).clear();
-    }
-
-    /**
-     * Returns the set of all keys belonging to this MapList.
-     *
-     * @return This MapList's keyset
-     */
-    public Set<S> keySet() {
-        return map.keySet();
-    }
-
-    /**
-     * Returns a collection of all values belonging to the specified key.
-     *
-     * @param key The key whose values are being sought
-     * @return A collection of values belonging to the key
-     */
-    public Collection<T> values(final S key) {
-        return map.get(key);
-    }
-
-    /**
-     * Retrieves the entry set for this MapList.
-     *
-     * @return This MapList's entry set
-     */
-    public Set<Map.Entry<S, List<T>>> entrySet() {
-        return map.entrySet();
-    }
-
-    /**
-     * Retrieves the map behind this maplist.
-     *
-     * @return This MapList's map.
-     */
-    public Map<S, List<T>> getMap() {
-        return new HashMap<>(map);
-    }
-
-}

src/com/dmdirc/util/collections/WeakMapList.java

@@ -1,53 +0,0 @@
-/*
- * Copyright (c) 2006-2015 DMDirc Developers
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in
- * all copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-
-package com.dmdirc.util.collections;
-
-import java.util.List;
-
-/**
- * Wraps a Map<S, List<T>> with various convenience methods for
- * accessing the data. Implements a Map-like interface for easier transition.
- * This implementation uses WeakLists (i.e., lists of weak references) - all
- * references to values are wrapped in WeakReferences.
- *
- * @param <S> the type of keys maintained by this map
- * @param <T> the type of mapped values
- */
-public class WeakMapList<S,T> extends MapList<S, T> {
-
-    /**
-     * Retrieves the list of values associated with the specified key, creating
-     * the key if neccessary.
-     *
-     * @param key The key to retrieve
-     * @return A list of the specified key's values
-     */
-    @Override
-    public List<T> safeGet(final S key) {
-        if (!map.containsKey(key)) {
-            map.put(key, new WeakList<>());
-        }
-
-        return map.get(key);
-    }
-}

src/com/dmdirc/util/io/ConfigFile.java

@@ -22,8 +22,6 @@
 
 package com.dmdirc.util.io;
 
-import com.dmdirc.util.collections.MapList;
-
 import java.io.IOException;
 import java.io.InputStream;
 import java.nio.charset.Charset;
@@ -46,7 +44,7 @@ public class ConfigFile extends TextFile {
     private final Collection<String> domains = new ArrayList<>();
 
     /** The values associated with each flat domain. */
-    private final MapList<String, String> flatdomains = new MapList<>();
+    private final Map<String, List<String>> flatdomains = new HashMap<>();
 
     /** The key/value sets associated with each key domain. */
     private final Map<String, Map<String, String>> keydomains = new HashMap<>();
@@ -117,12 +115,12 @@ public class ConfigFile extends TextFile {
                 domains.add(domain);
 
                 keydomain = keydomains.containsKey(domain)
-                        || flatdomains.containsValue("keysections", domain);
+                        || hasFlatDomainValue("keysections", domain);
 
                 if (keydomain && !keydomains.containsKey(domain)) {
                     keydomains.put(domain, new HashMap<>());
                 } else if (!keydomain && !flatdomains.containsKey(domain)) {
-                    flatdomains.add(domain);
+                    flatdomains.put(domain, new ArrayList<>());
                 }
             } else if (domain != null && keydomain
                     && (offset = findEquals(tline)) != -1) {
@@ -131,7 +129,7 @@ public class ConfigFile extends TextFile {
 
                 keydomains.get(domain).put(key, value);
             } else if (domain != null && !keydomain) {
-                flatdomains.add(domain, unescape(tline));
+                addFlatDomainValue(domain, unescape(tline));
             } else {
                 throw new InvalidConfigFileException("Unknown or unexpected"
                         + " line encountered: " + tline);
@@ -150,7 +148,7 @@ public class ConfigFile extends TextFile {
                     + "that isn't writable");
         }
 
-        final List<String> lines = new ArrayList<>();
+        final Collection<String> lines = new ArrayList<>();
 
         lines.add("# This is a DMDirc configuration file.");
         lines.add("# Written on: " + new GregorianCalendar().getTime());
@@ -275,7 +273,12 @@ public class ConfigFile extends TextFile {
      */
     public void addDomain(final String name, final Collection<String> data) {
         domains.add(name);
-        flatdomains.add(name, data);
+
+        if (flatdomains.containsKey(name)) {
+            flatdomains.get(name).addAll(data);
+        } else {
+            flatdomains.put(name, new ArrayList<>(data));
+        }
     }
 
     /**
@@ -289,6 +292,17 @@ public class ConfigFile extends TextFile {
         keydomains.put(name, data);
     }
 
+    private boolean hasFlatDomainValue(final String domain, final String value) {
+        return flatdomains.containsKey(domain) && flatdomains.get(domain).contains(value);
+    }
+
+    private void addFlatDomainValue(final String domain, final String value) {
+        if (!flatdomains.containsKey(domain)) {
+            flatdomains.put(domain, new ArrayList<>());
+        }
+        flatdomains.get(domain).add(value);
+    }
+
     /**
      * Unescapes any escaped characters in the specified input string.
      *

test/com/dmdirc/util/collections/MapListTest.java

@@ -1,157 +0,0 @@
-/*
- * Copyright (c) 2006-2015 DMDirc Developers
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in
- * all copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-
-package com.dmdirc.util.collections;
-
-import org.junit.Test;
-
-import java.util.ArrayList;
-import java.util.Collection;
-
-import static org.junit.Assert.*;
-
-public class MapListTest {
-
-    @Test
-    public void testIsEmpty() {
-        final MapList<String, String> test = new MapList<>();
-        assertTrue(test.isEmpty());
-
-        test.add("a", "b");
-        assertFalse(test.isEmpty());
-        test.removeFromAll("b");
-        assertTrue(test.isEmpty());
-    }
-
-    @Test
-    public void testAddCollection() {
-        final MapList<String, String> test = new MapList<>();
-        final Collection<String> testList = new ArrayList<>();
-        testList.add("d");
-        testList.add("e");
-        test.add("key", testList);
-
-        assertTrue(test.containsKey("key"));
-        assertTrue(test.containsValue("key", "d"));
-        assertTrue(test.containsValue("key", "e"));
-    }
-
-    @Test
-    public void testClear() {
-        final MapList<String, String> test = new MapList<>();
-        test.add("a", "b");
-        test.add("d", "e");
-        test.clear();
-        assertTrue(test.isEmpty());
-    }
-
-    @Test
-    public void testClearKey() {
-        final MapList<String, String> test = new MapList<>();
-        test.add("a", "b");
-        test.add("d", "e");
-        test.clear("a");
-        assertTrue(test.values("a").isEmpty());
-        assertFalse(test.isEmpty());
-    }
-
-    @Test
-    public void testRemove() {
-        final MapList<String, String> test = new MapList<>();
-        test.add("a", "b");
-        test.add("d", "e");
-        test.remove("z", "b");
-
-        assertEquals(2, test.keySet().size());
-        assertEquals(1, test.values("a").size());
-        assertEquals(1, test.values("d").size());
-
-        test.remove("a", "b");
-        assertEquals(2, test.keySet().size());
-        assertEquals(0, test.values("a").size());
-        assertEquals(1, test.values("d").size());
-    }
-
-    @Test
-    public void testRemoveKey() {
-        final MapList<String, String> instance = new MapList<>();
-        instance.add("a", "b");
-        assertTrue(instance.containsKey("a"));
-        instance.remove("a");
-        assertFalse(instance.containsKey("a"));
-    }
-
-    @Test
-    public void testKeySet() {
-        final MapList<String, String> test = new MapList<>();
-        test.add("a", "b");
-        test.add("d", "e");
-        assertEquals(2, test.keySet().size());
-        assertTrue(test.keySet().contains("a"));
-        assertTrue(test.keySet().contains("d"));
-    }
-
-    @Test
-    public void testContainsKey() {
-        final MapList<String, String> test = new MapList<>();
-        test.add("a", "b");
-        assertTrue(test.containsKey("a"));
-    }
-
-    @Test
-    public void testContainsValue() {
-        final MapList<String, String> test = new MapList<>();
-        test.add("a", "b");
-        assertTrue(test.containsValue("a", "b"));
-    }
-
-    @Test
-    public void testGet() {
-        final MapList<String, String> test = new MapList<>();
-        test.add("a", "b");
-        assertEquals(1, test.get("a").size());
-        assertEquals("b", test.get("a").get(0));
-        assertEquals("b", test.get("a", 0));
-    }
-
-    @Test
-    public void testInherit() {
-        final MapList<String, String> test1 = new MapList<>();
-        test1.add("a", "b");
-
-        final MapList<String, String> test2 = new MapList<>(test1);
-        assertEquals(1, test2.get("a").size());
-        assertEquals("b", test2.get("a").get(0));
-        assertEquals("b", test2.get("a", 0));
-    }
-
-    @Test
-    public void testGetMap() {
-        final MapList<String, String> test1 = new MapList<>();
-        test1.add("a", "b");
-        assertNotSame(test1.getMap(), test1.getMap());
-
-        final MapList<String, String> test2 = new MapList<>(test1);
-        assertEquals(test1.getMap(), test2.getMap());
-    }
-
-}