Added EquatableWeakReference to make up for Sun's crap (Weak)Reference implementation

Added unit tests for MapList and WeakList

git-svn-id: http://svn.dmdirc.com/trunk@2872 00569f92-eb28-0410-84fd-f71c24880f

src/com/dmdirc/util/EquatableWeakReference.java

@@ -0,0 +1,56 @@
+/*
+ * Copyright (c) 2006-2007 Chris Smith, Shane Mc Cormack, Gregory Holmes
+ *
+ * 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;
+
+import java.lang.ref.Reference;
+import java.lang.ref.WeakReference;
+
+/**
+ * An extension of WeakReference that implements a sane equals and hashcode
+ * method.
+ * 
+ * @author chris
+ */
+public class EquatableWeakReference<T> extends WeakReference<T> {
+    
+    public EquatableWeakReference(T referent) {
+        super(referent);
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public boolean equals(Object obj) {
+        if (obj instanceof Reference) {
+            return get().equals(((Reference) obj).get());
+        } else {
+            return get().equals(obj);
+        }
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public int hashCode() {
+        return get().hashCode();
+    }
+    
+}

src/com/dmdirc/util/WeakList.java

@@ -67,7 +67,7 @@ public class WeakList<T> implements List<T> {
         final Collection<WeakReference<T>> res = new ArrayList<WeakReference<T>>();
 
         for (Object item : c) {
-            res.add(new WeakReference(item));
+            res.add(new EquatableWeakReference(item));
         }
 
         return res;
@@ -90,9 +90,9 @@ public class WeakList<T> implements List<T> {
     }
 
     /** {@inheritDoc} */
-    @Override @SuppressWarnings(value = "unchecked")
+    @Override @SuppressWarnings("unchecked")
     public boolean contains(Object o) {
-        return list.contains(new WeakReference(o));
+        return list.contains(new EquatableWeakReference(o));
     }
 
     /** {@inheritDoc} */
@@ -116,13 +116,13 @@ public class WeakList<T> implements List<T> {
     /** {@inheritDoc} */
     @Override
     public boolean add(T e) {
-        return list.add(new WeakReference<T>(e));
+        return list.add(new EquatableWeakReference<T>(e));
     }
 
     /** {@inheritDoc} */
     @Override @SuppressWarnings(value = "unchecked")
     public boolean remove(Object o) {
-        return list.remove(new WeakReference(o));
+        return list.remove(new EquatableWeakReference(o));
     }
 
     /** {@inheritDoc} */
@@ -172,7 +172,7 @@ public class WeakList<T> implements List<T> {
     /** {@inheritDoc} */
     @Override
     public T set(int index, T element) {
-        list.set(index, new WeakReference<T>(element));
+        list.set(index, new EquatableWeakReference<T>(element));
 
         return element;
     }
@@ -180,7 +180,7 @@ public class WeakList<T> implements List<T> {
     /** {@inheritDoc} */
     @Override
     public void add(int index, T element) {
-        list.add(index, new WeakReference<T>(element));
+        list.add(index, new EquatableWeakReference<T>(element));
     }
 
     /** {@inheritDoc} */
@@ -194,7 +194,7 @@ public class WeakList<T> implements List<T> {
     public int indexOf(Object o) {
         cleanUp();
 
-        return list.indexOf(new WeakReference(o));
+        return list.indexOf(o);
     }
 
     /** {@inheritDoc} */
@@ -202,7 +202,7 @@ public class WeakList<T> implements List<T> {
     public int lastIndexOf(Object o) {
         cleanUp();
 
-        return list.lastIndexOf(new WeakReference(o));
+        return list.lastIndexOf(o);
     }
 
     /** {@inheritDoc} */

test/com/dmdirc/util/MapListTest.java

@@ -0,0 +1,63 @@
+/*
+ * Copyright (c) 2006-2007 Chris Smith, Shane Mc Cormack, Gregory Holmes
+ *
+ * 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;
+
+import org.junit.Test;
+import static org.junit.Assert.*;
+
+public class MapListTest extends junit.framework.TestCase {
+
+    @Test
+    public void testIsEmpty() {
+        final MapList<String, String> test = new MapList<String, String>();
+        assertTrue(test.isEmpty());
+
+        test.add("a", "b");
+        test.removeFromAll("b");
+        assertTrue(test.isEmpty());
+    }
+
+    @Test
+    public void testContainsKey() {
+        final MapList<String, String> test = new MapList<String, String>();
+        test.add("a", "b");
+        assertTrue(test.containsKey("a"));
+    }
+
+    @Test
+    public void testContainsValue() {
+        final MapList<String, String> test = new MapList<String, String>();
+        test.add("a", "b");
+        assertTrue(test.containsValue("a", "b"));
+    }
+
+    @Test
+    public void testGet() {
+        final MapList<String, String> test = new MapList<String, String>();
+        test.add("a", "b");
+        assertTrue(test.get("a").size() == 1);
+        assertTrue(test.get("a").get(0).equals("b"));
+        assertTrue(test.get("a", 0).equals("b"));
+    }
+
+}

test/com/dmdirc/util/WeakListTest.java

@@ -0,0 +1,50 @@
+/*
+ * Copyright (c) 2006-2007 Chris Smith, Shane Mc Cormack, Gregory Holmes
+ *
+ * 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;
+
+import org.junit.Test;
+import static org.junit.Assert.*;
+
+public class WeakListTest extends junit.framework.TestCase {
+
+    @Test
+    public void testBasics() {
+        final WeakList<String> test = new WeakList<String>();
+        assertTrue(test.isEmpty());
+        
+        test.add("abcdef");
+        test.add("123");
+        
+        assertEquals(2, test.size());
+        assertTrue(test.get(0).equals("abcdef"));
+        assertTrue(test.contains("123"));
+        assertFalse(test.isEmpty());
+        
+        test.remove("abcdef");
+        assertFalse(test.contains("abcdef"));
+        
+        test.remove("123");
+        assertTrue(test.isEmpty());
+    }
+
+}