Remove WeakList et al.

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

@@ -1,65 +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.lang.ref.Reference;
-import java.lang.ref.WeakReference;
-
-/**
- * An extension of WeakReference that implements a sane equals and hashcode
- * method.
- *
- * @param <T> The type of object that this reference contains
- */
-public class EquatableWeakReference<T> extends WeakReference<T> {
-
-    /**
-     * Creates a new instance of EquatableWeakReference.
-     *
-     * @param referent The object that this weak reference should reference.
-     */
-    public EquatableWeakReference(final T referent) {
-        super(referent);
-    }
-
-    @Override
-    public boolean equals(final Object obj) {
-        if (get() == null) {
-            return obj == null;
-        }
-        if (obj instanceof Reference<?>) {
-            return get().equals(((Reference<?>) obj).get());
-        } else {
-            return get().equals(obj);
-        }
-    }
-
-    @Override
-    public int hashCode() {
-        if (get() == null) {
-            return 0;
-        }
-        return get().hashCode();
-    }
-
-}

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

@@ -1,227 +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.lang.ref.WeakReference;
-import java.util.ArrayList;
-import java.util.Collection;
-import java.util.Iterator;
-import java.util.List;
-import java.util.ListIterator;
-import java.util.stream.Collectors;
-
-import javax.annotation.Nonnull;
-
-/**
- * Implements a list of weak references. The weak references (and subsequent
- * garbage collection) are handled transparently.
- *
- * @param <T> The type of object that this list will contain.
- */
-public class WeakList<T> implements List<T> {
-
-    /** The items in this list. */
-    private final List<WeakReference<T>> list = new ArrayList<>();
-
-    /**
-     * Removes any entries from the list that have been GC'd.
-     */
-    private void cleanUp() {
-        for (int i = 0; i < list.size(); i++) {
-            if (list.get(i).get() == null) {
-                list.remove(i--);
-            }
-        }
-    }
-
-    /**
-     * Dereferences the specified list of WeakReferences to get a plain List.
-     *
-     * @param list The list to be dereferenced
-     * @return A list containing the items referenced by the specified list
-     */
-    private List<T> dereferenceList(final List<WeakReference<T>> list) {
-        return list.stream().filter(item -> item.get() != null)
-                .map(WeakReference::get)
-                .collect(Collectors.toList());
-    }
-
-    /**
-     * Creates a new collection of weak references to elements in the specified
-     * collection.
-     *
-     * @param c The collection whose elements should be referenced
-     * @return A copy of the specified collection, with each item wrapped in
-     * a weak reference.
-     */
-    @SuppressWarnings("unchecked")
-    private Collection<WeakReference<T>> referenceCollection(
-            final Collection<?> c) {
-        final Collection<WeakReference<T>> res = new ArrayList<>();
-
-        for (Object item : c) {
-            res.add(new EquatableWeakReference<>((T) item));
-        }
-
-        return res;
-    }
-
-    @Override
-    public int size() {
-        cleanUp();
-
-        return list.size();
-    }
-
-    @Override
-    public boolean isEmpty() {
-        cleanUp();
-
-        return list.isEmpty();
-    }
-
-    @Override
-    @SuppressWarnings("unchecked")
-    public boolean contains(final Object o) {
-        return list.contains(new EquatableWeakReference<>((T) o));
-    }
-
-    @Nonnull
-    @Override
-    public Iterator<T> iterator() {
-        return dereferenceList(list).iterator();
-    }
-
-    @Nonnull
-    @Override
-    public Object[] toArray() {
-        return dereferenceList(list).toArray();
-    }
-
-    @Nonnull
-    @Override
-    public <S> S[] toArray(@Nonnull final S[] a) {
-        return dereferenceList(list).toArray(a);
-    }
-
-    @Override
-    public boolean add(final T e) {
-        return list.add(new EquatableWeakReference<>(e));
-    }
-
-    @Override
-    @SuppressWarnings("unchecked")
-    public boolean remove(final Object o) {
-        return list.remove(new EquatableWeakReference<>((T) o));
-    }
-
-    @Override
-    public boolean containsAll(@Nonnull final Collection<?> c) {
-        return dereferenceList(list).containsAll(c);
-    }
-
-    @Override
-    public boolean addAll(@Nonnull final Collection<? extends T> c) {
-        return list.addAll(referenceCollection(c));
-    }
-
-    @Override
-    public boolean addAll(final int index, @Nonnull final Collection<? extends T> c) {
-        return list.addAll(index, referenceCollection(c));
-    }
-
-    @Override
-    public boolean removeAll(@Nonnull final Collection<?> c) {
-        return list.removeAll(referenceCollection(c));
-    }
-
-    @Override
-    public boolean retainAll(@Nonnull final Collection<?> c) {
-        return list.retainAll(referenceCollection(c));
-    }
-
-    @Override
-    public void clear() {
-        list.clear();
-    }
-
-    @Override
-    public T get(final int index) {
-        cleanUp();
-
-        return list.get(index).get();
-    }
-
-    @Override
-    public T set(final int index, final T element) {
-        list.set(index, new EquatableWeakReference<>(element));
-
-        return element;
-    }
-
-    @Override
-    public void add(final int index, final T element) {
-        list.add(index, new EquatableWeakReference<>(element));
-    }
-
-    @Override
-    public T remove(final int index) {
-        return list.remove(index).get();
-    }
-
-    @Override
-    public int indexOf(final Object o) {
-        cleanUp();
-
-        return dereferenceList(list).indexOf(o);
-    }
-
-    @Override
-    public int lastIndexOf(final Object o) {
-        cleanUp();
-
-        return dereferenceList(list).lastIndexOf(o);
-    }
-
-    @Nonnull
-    @Override
-    public ListIterator<T> listIterator() {
-        cleanUp();
-
-        return dereferenceList(list).listIterator();
-    }
-
-    @Nonnull
-    @Override
-    public ListIterator<T> listIterator(final int index) {
-        cleanUp();
-
-        return dereferenceList(list).listIterator(index);
-    }
-
-    @Nonnull
-    @Override
-    public List<T> subList(final int fromIndex, final int toIndex) {
-        return dereferenceList(list.subList(fromIndex, toIndex));
-    }
-}

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

@@ -1,51 +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.lang.ref.Reference;
-import java.lang.ref.WeakReference;
-import org.junit.Test;
-import static org.junit.Assert.*;
-
-public class EquatableWeakReferenceTest {
-
-    @Test
-    public void testEquals() {
-        final Object myObject = "moo";
-        final Reference<Object> myRef = new WeakReference<>(myObject);
-        final EquatableWeakReference<Object> ewf = new EquatableWeakReference<>(myObject);
-
-        assertTrue(ewf.equals(myObject));
-        assertTrue(ewf.equals(myRef));
-        assertFalse("bar".equals(ewf));
-        assertFalse(ewf.equals(new WeakReference<Object>("bar")));
-    }
-
-    @Test
-    public void testHashCode() {
-        final Object myObject = "moo";
-        final EquatableWeakReference<Object> ewf = new EquatableWeakReference<>(myObject);
-        
-        assertEquals(myObject.hashCode(), ewf.hashCode());
-    }
-
-}

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

@@ -1,283 +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.Iterator;
-import java.util.List;
-import java.util.ListIterator;
-
-import org.junit.Test;
-
-import static org.junit.Assert.*;
-
-public class WeakListTest {
-
-    @Test
-    public void testIsEmpty() {
-        final List<String> instance = new WeakList<>();
-        assertTrue(instance.isEmpty());
-        instance.add("test1");
-        assertFalse(instance.isEmpty());
-    }
-
-    @Test
-    public void testAdd() {
-        final List<String> instance = new WeakList<>();
-        assertTrue(instance.add("test1"));
-        assertFalse(instance.isEmpty());
-    }
-
-    @Test
-    public void testAddInt() {
-        final List<String> instance = new WeakList<>();
-        assertTrue(instance.add("test1"));
-        instance.add(0, "test2");
-        assertEquals("test2", instance.get(0));
-    }
-
-    @Test
-    public void testRemove() {
-        final List<String> instance = new WeakList<>();
-        instance.add("test1");
-        assertFalse(instance.isEmpty());
-        assertTrue(instance.remove("test1"));
-        assertFalse(instance.remove("test1"));
-    }
-
-    @Test
-    public void testRemoveInt() {
-        final List<String> instance = new WeakList<>();
-        assertTrue(instance.isEmpty());
-        instance.add("test1");
-        instance.add("test2");
-        assertEquals(2, instance.size());
-        instance.remove(1);
-        assertTrue(instance.contains("test1"));
-        assertFalse(instance.contains("test2"));
-    }
-
-    @Test
-    public void testGet() {
-        final List<String> instance = new WeakList<>();
-        instance.add("test1");
-        instance.add("test2");
-        assertEquals("test1", instance.get(0));
-        assertEquals("test2", instance.get(1));
-    }
-
-    @Test
-    public void testContains() {
-        final List<String> instance = new WeakList<>();
-        assertFalse(instance.contains("test1"));
-        instance.add("test1");
-        assertTrue(instance.contains("test1"));
-    }
-
-    /**
-     * Test of toArray method, of class WeakList.
-     */
-    @Test
-    public void testToArray0args() {
-        final List<String> instance = new WeakList<>();
-        assertEquals(0, instance.toArray().length);
-        instance.add("test1");
-        instance.add("test2");
-        final Object[] result = instance.toArray();
-        assertEquals(2, result.length);
-        assertEquals("test1", result[0]);
-        assertEquals("test2", result[1]);
-    }
-
-    /**
-     * Test of toArray method, of class WeakList.
-     */
-    @Test
-    public void testToArrayGenericType() {
-        final List<String> instance = new WeakList<>();
-        assertEquals(0, instance.toArray(new String[instance.size()]).length);
-        instance.add("test1");
-        instance.add("test2");
-        final Object[] result = instance.toArray(new String[2]);
-        assertEquals(2, result.length);
-        assertEquals("test1", result[0]);
-        assertEquals("test2", result[1]);
-    }
-
-    /**
-     * Test of containsAll method, of class WeakList.
-     */
-    @Test
-    public void testContainsAllAddAll() {
-        final Collection<String> list = new ArrayList<>();
-        list.add("test1");
-        list.add("test2");
-        final List<String> instance = new WeakList<>();
-        assertFalse(instance.containsAll(list));
-        instance.addAll(list);
-        assertTrue(instance.contains("test1"));
-        assertTrue(instance.contains("test2"));
-        assertTrue(instance.containsAll(list));
-    }
-
-    @Test
-    public void testAddAllIntCollection() {
-        final Collection<String> list = new ArrayList<>();
-        list.add("test1");
-        list.add("test2");
-        final List<String> instance = new WeakList<>();
-        instance.add("test3");
-        assertEquals("test3", instance.get(0));
-        assertFalse(instance.containsAll(list));
-        instance.addAll(0, list);
-        assertEquals("test1", instance.get(0));
-        assertEquals("test2", instance.get(1));
-    }
-
-    @Test
-    public void testIndexOf() {
-        final String one = "test1";
-        final List<String> instance = new WeakList<>();
-        instance.add(one);
-        final String two = "test2";
-        instance.add(two);
-        assertEquals(2, instance.size());
-        assertEquals(0, instance.indexOf(one));
-        assertEquals(1, instance.indexOf(two));
-    }
-
-    @Test
-    public void testLastIndexOf() {
-        final String one = "test1";
-        final List<String> instance = new WeakList<>();
-        instance.add(one);
-        final String two = "test2";
-        instance.add(two);
-        instance.add(one);
-        assertEquals(3, instance.size());
-        assertEquals(2, instance.lastIndexOf(one));
-    }
-
-    @Test
-    public void testRemoveAll() {
-        final Collection<String> list = new ArrayList<>();
-        list.add("test1");
-        list.add("test2");
-        final List<String> instance = new WeakList<>();
-        instance.addAll(list);
-        assertFalse(instance.isEmpty());
-        instance.removeAll(list);
-        assertTrue(instance.isEmpty());
-    }
-
-    @Test
-    public void testRetainAll() {
-        final Collection<String> list = new ArrayList<>();
-        list.add("test1");
-        list.add("test2");
-        final List<String> instance = new WeakList<>();
-        instance.addAll(list);
-        instance.add("test3");
-        instance.add("test4");
-        assertFalse(list.size() == instance.size());
-        instance.retainAll(list);
-        assertTrue(list.size() == instance.size());
-    }
-
-    @Test
-    public void testClear() {
-        final Collection<String> list = new ArrayList<>();
-        list.add("test1");
-        list.add("test2");
-        final List<String> instance = new WeakList<>();
-        instance.addAll(list);
-        assertFalse(instance.isEmpty());
-        instance.clear();
-        assertTrue(instance.isEmpty());
-    }
-
-    @Test
-    public void testSet() {
-        final List<String> instance = new WeakList<>();
-        instance.add("test1");
-        assertEquals("test1", instance.get(0));
-        instance.set(0, "test2");
-        assertEquals("test2", instance.get(0));
-    }
-
-    @Test
-    public void testIterator() {
-        final List<String> instance = new WeakList<>();
-        Iterator<String> result = instance.iterator();
-        assertFalse(result.hasNext());
-        instance.add("test1");
-        instance.add("test2");
-        result = instance.iterator();
-        assertEquals("test1", result.next());
-        assertEquals("test2", result.next());
-        assertFalse(result.hasNext());
-    }
-
-    @Test
-    public void testListIterator0args() {
-        final List<String> instance = new WeakList<>();
-        Iterator<String> result = instance.listIterator();
-        assertFalse(result.hasNext());
-        instance.add("test1");
-        instance.add("test2");
-        result = instance.listIterator();
-        assertEquals("test1", result.next());
-        assertEquals("test2", result.next());
-        assertFalse(result.hasNext());
-    }
-
-    @Test(expected=IndexOutOfBoundsException.class)
-    public void testListIteratorInt() {
-        final List<String> instance = new WeakList<>();
-        ListIterator<String> result = instance.listIterator(1);
-        assertFalse(result.hasNext());
-        instance.add("test1");
-        instance.add("test2");
-        instance.add("text3");
-        result = instance.listIterator(1);
-        assertEquals("test1", result.previous());
-        assertEquals("test2", result.next());
-        assertEquals("test3", result.next());
-        assertFalse(result.hasNext());
-    }
-
-    @Test
-    public void testSubList() {
-        final List<String> instance = new WeakList<>();
-        instance.add("test1");
-        instance.add("test2");
-        instance.add("test3");
-        instance.add("test4");
-        final List<String> result = instance.subList(1, 3);
-        assertEquals(2, result.size());
-        assertTrue(result.contains("test2"));
-        assertTrue(result.contains("test3"));
-    }
-
-}