Merge pull request #10 from greboid/tidying

Tidying

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

 import java.util.List;
 import java.util.Map;
 import java.util.Set;
+import java.util.stream.Collectors;
+
+import javax.annotation.Nonnull;
 
 /**
  * An object that maps keys to values, and values back to keys. Currently
 public class DoubleMap<A,B> implements Map<A, B> {
 
     /** The keys in this map. */
-    protected final List<A> keys = new ArrayList<>();
+    private final List<A> keys = new ArrayList<>();
     /** The values in this map. */
-    protected final List<B> values = new ArrayList<>();
+    private final List<B> values = new ArrayList<>();
 
     /**
      * Retrieves the value associated with the specified key.
         return value;
     }
 
+    @Nonnull
     @Override
     public Set<A> keySet() {
         return new HashSet<>(keys);
     }
 
     @Override
-    @SuppressWarnings("unchecked")
     public boolean containsKey(final Object key) {
         return keys.contains(key);
     }
 
     @Override
-    @SuppressWarnings("unchecked")
     public boolean containsValue(final Object value) {
         return values.contains(value);
     }
     }
 
     @Override
-    public void putAll(final Map<? extends A, ? extends B> m) {
+    public void putAll(@Nonnull final Map<? extends A, ? extends B> m) {
         for (Entry<? extends A, ? extends B> entry : m.entrySet()) {
             put(entry.getKey(), entry.getValue());
         }
         values.clear();
     }
 
+    @Nonnull
     @Override
     public Collection<B> values() {
         return new ArrayList<>(values);
     }
 
+    @Nonnull
     @Override
     public Set<Entry<A, B>> entrySet() {
-        final Set<Entry<A, B>> set = new HashSet<>();
-        for (A key : keys) {
-            set.add(new SimpleEntry<>(key, getValue(key)));
-        }
-        return set;
+        return keys.stream()
+                .map(key -> new SimpleEntry<>(key, getValue(key)))
+                .collect(Collectors.toSet());
     }
 }

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

 
     @Override
     public boolean equals(final Object obj) {
+        if (get() == null) {
+            return obj == null;
+        }
         if (obj instanceof Reference<?>) {
             return get().equals(((Reference<?>) obj).get());
         } else {
 
     @Override
     public int hashCode() {
+        if (get() == null) {
+            return 0;
+        }
         return get().hashCode();
     }
 

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

      * @param listenerType The type of listener to be called
      * @return A proxy instance that can be used to call methods
      */
-    @SuppressWarnings({"unchecked", "rawtypes"})
+    @SuppressWarnings("unchecked")
     public <T> T getCallable(final Class<T> listenerType) {
         return (T) Proxy.newProxyInstance(listenerType.getClassLoader(),
                 new Class[] { listenerType }, new CallHandler<>(listenerType));

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

      */
     public List<T> safeGet(final S key) {
         if (!map.containsKey(key)) {
-            map.put(key, Collections.synchronizedList(new ArrayList<T>()));
+            map.put(key, Collections.synchronizedList(new ArrayList<>()));
         }
 
         return map.get(key);

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

 import java.util.List;
 import java.util.ListIterator;
 
+import javax.annotation.Nonnull;
+
 /**
  * Decorates a {@link List} to add observable functionality.
  *
      *
      * @param list The list to be decorated
      */
+    @SuppressWarnings("AssignmentToCollectionOrArrayFieldFromParameter")
     public ObservableListDecorator(final List<T> list) {
         this.list = list;
     }
         return list.contains(o);
     }
 
+    @Nonnull
     @Override
     public Iterator<T> iterator() {
         return list.iterator();
     }
 
+    @Nonnull
     @Override
     public Object[] toArray() {
         return list.toArray();
     }
 
+    @Nonnull
     @Override
-    public <S> S[] toArray(final S[] a) {
+    public <S> S[] toArray(@Nonnull final S[] a) {
         return list.toArray(a);
     }
 
     }
 
     @Override
-    public boolean containsAll(final Collection<?> c) {
+    public boolean containsAll(@Nonnull final Collection<?> c) {
         return list.containsAll(c);
     }
 
     @Override
-    public boolean addAll(final Collection<? extends T> c) {
+    public boolean addAll(@Nonnull final Collection<? extends T> c) {
         if (list.addAll(c)) {
             listeners.getCallable(ListObserver.class).onItemsAdded(this,
                     list.size() - c.size(), list.size() - 1);
     }
 
     @Override
-    public boolean addAll(final int index, final Collection<? extends T> c) {
+    public boolean addAll(final int index, @Nonnull final Collection<? extends T> c) {
         if (list.addAll(index, c)) {
             listeners.getCallable(ListObserver.class).onItemsAdded(this,
                     index, index + c.size());
     }
 
     @Override
-    public boolean removeAll(final Collection<?> c) {
+    public boolean removeAll(@Nonnull final Collection<?> c) {
         final int length = list.size();
 
         if (list.removeAll(c)) {
     }
 
     @Override
-    public boolean retainAll(final Collection<?> c) {
+    public boolean retainAll(@Nonnull final Collection<?> c) {
         final int length = list.size();
 
         if (list.retainAll(c)) {
         return list.lastIndexOf(o);
     }
 
+    @Nonnull
     @Override
     public ListIterator<T> listIterator() {
         return list.listIterator();
     }
 
+    @Nonnull
     @Override
     public ListIterator<T> listIterator(final int index) {
         return list.listIterator(index);
     }
 
+    @Nonnull
     @Override
     public List<T> subList(final int fromIndex, final int toIndex) {
         return list.subList(fromIndex, toIndex);

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

 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
      * @return A list containing the items referenced by the specified list
      */
     private List<T> dereferenceList(final List<WeakReference<T>> list) {
-        final List<T> res = new ArrayList<>();
-
-        for (WeakReference<T> item : list) {
-            if (item.get() != null) {
-                res.add(item.get());
-            }
-        }
-
-        return res;
+        return list.stream().filter(item -> item.get() != null)
+                .map(WeakReference::get)
+                .collect(Collectors.toList());
     }
 
     /**
      * @return A copy of the specified collection, with each item wrapped in
      * a weak reference.
      */
-    @SuppressWarnings({"unchecked", "rawtypes"})
+    @SuppressWarnings("unchecked")
     private Collection<WeakReference<T>> referenceCollection(
             final Collection<?> c) {
         final Collection<WeakReference<T>> res = new ArrayList<>();
     }
 
     @Override
-    @SuppressWarnings({"unchecked", "rawtypes"})
+    @SuppressWarnings("unchecked")
     public boolean contains(final Object o) {
         return list.contains(new EquatableWeakReference(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(final S[] a) {
+    public <S> S[] toArray(@Nonnull final S[] a) {
         return dereferenceList(list).toArray(a);
     }
 
     }
 
     @Override
-    @SuppressWarnings({"unchecked", "rawtypes"})
+    @SuppressWarnings("unchecked")
     public boolean remove(final Object o) {
         return list.remove(new EquatableWeakReference(o));
     }
 
     @Override
-    public boolean containsAll(final Collection<?> c) {
+    public boolean containsAll(@Nonnull final Collection<?> c) {
         return dereferenceList(list).containsAll(c);
     }
 
     @Override
-    public boolean addAll(final Collection<? extends T> c) {
+    public boolean addAll(@Nonnull final Collection<? extends T> c) {
         return list.addAll(referenceCollection(c));
     }
 
     @Override
-    public boolean addAll(final int index, final Collection<? extends T> c) {
+    public boolean addAll(final int index, @Nonnull final Collection<? extends T> c) {
         return list.addAll(index, referenceCollection(c));
     }
 
     @Override
-    public boolean removeAll(final Collection<?> c) {
+    public boolean removeAll(@Nonnull final Collection<?> c) {
         return list.removeAll(referenceCollection(c));
     }
 
     @Override
-    public boolean retainAll(final Collection<?> c) {
+    public boolean retainAll(@Nonnull final Collection<?> c) {
         return list.retainAll(referenceCollection(c));
     }
 
         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));

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

     @Override
     public List<T> safeGet(final S key) {
         if (!map.containsKey(key)) {
-            map.put(key, new WeakList<T>());
+            map.put(key, new WeakList<>());
         }
 
         return map.get(key);

src/com/dmdirc/util/colours/Colour.java

 
         final Colour other = (Colour) obj;
 
-        return this.red == other.getRed() && this.green == other.getGreen()
-                && this.blue == other.getBlue();
+        return red == other.getRed() && green == other.getGreen()
+                && blue == other.getBlue();
     }
 
     @Override
     public int hashCode() {
         int hash = 7;
-        hash = 37 * hash + this.red;
-        hash = 37 * hash + this.green;
-        hash = 37 * hash + this.blue;
+        hash = 37 * hash + red;
+        hash = 37 * hash + green;
+        hash = 37 * hash + blue;
         return hash;
     }
 

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

 import java.nio.file.Path;
 import java.util.ArrayList;
 import java.util.Collection;
+import java.util.Collections;
 import java.util.GregorianCalendar;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
+import java.util.stream.Collectors;
 
 /**
  * Reads and writes a standard DMDirc config file.
                         || flatdomains.containsValue("keysections", domain);
 
                 if (keydomain && !keydomains.containsKey(domain)) {
-                    keydomains.put(domain, new HashMap<String, String>());
+                    keydomains.put(domain, new HashMap<>());
                 } else if (!keydomain && !flatdomains.containsKey(domain)) {
                     flatdomains.add(domain);
                 }
             lines.add(escape(domain) + ':');
 
             if (flatdomains.containsKey(domain)) {
-                for (String entry : flatdomains.get(domain)) {
-                    lines.add("  " + escape(entry));
-                }
+                lines.addAll(flatdomains.get(domain).stream()
+                        .map(entry -> "  " + escape(entry))
+                        .collect(Collectors.toList()));
             } else {
-                for (Map.Entry<String, String> entry : keydomains.get(domain)
-                        .entrySet()) {
-                    lines.add("  " + escape(entry.getKey()) + '='
-                            + escape(entry.getValue()));
-                }
+                lines.addAll(keydomains.get(domain).entrySet().stream()
+                        .map(entry -> "  " + escape(entry.getKey()) + '=' + escape(entry.getValue()))
+                        .collect(Collectors.toList()));
             }
         }
 
         lines.add("# any sections that take key/values.");
         lines.add("keysections:");
 
-        for (String domain : domains) {
-            if (!"keysections".equals(domain) && keydomains.containsKey(domain)) {
-                lines.add("  " + domain);
-            }
-        }
+        lines.addAll(domains.stream()
+                .filter(domain -> !"keysections".equals(domain) && keydomains.containsKey(domain))
+                .map(domain -> "  " + domain)
+                .collect(Collectors.toList()));
     }
 
     /**
      * @return This config file's key domains
      */
     public Map<String, Map<String, String>> getKeyDomains() {
-        return keydomains;
+        return Collections.unmodifiableMap(keydomains);
     }
 
     /**
     public Map<String, String> getKeyDomain(final String domain) {
         if (automake && !isKeyDomain(domain)) {
             domains.add(domain);
-            keydomains.put(domain, new HashMap<String, String>());
+            keydomains.put(domain, new HashMap<>());
         }
 
         return keydomains.get(domain);
      * @param input The string to be searched
      * @return The offset of the first non-escaped instance of '=', or -1.
      */
-    protected static int findEquals(final CharSequence input) {
+    private static int findEquals(final CharSequence input) {
         boolean escaped = false;
 
         for (int i = 0; i < input.length(); i++) {

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

      *
      * @since 0.6
      */
+    @SuppressWarnings("BooleanParameter")
     void setIndeterminate(final boolean indeterminate);
 }

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

      * @param stream The stream to read
      * @param list The list to store the output from the stream in
      */
+    @SuppressWarnings("AssignmentToCollectionOrArrayFieldFromParameter")
     StreamReader(final InputStream stream, final List<String> list) {
         super("StreamReader");
 
      *
      * @return The output list
      */
+    @SuppressWarnings("ReturnOfCollectionOrArrayField")
     List<String> getList() {
         return list;
     }

src/com/dmdirc/util/validators/OptionalValidator.java

     @Override
     public ValidationResponse validate(final String object) {
         if (object == null) {
-            return validator.validate(object);
+            return validator.validate(null);
         }
 
         final int colonIndex = object.indexOf(':');

src/com/dmdirc/util/validators/ServerNameValidator.java

         if (object == null || object.isEmpty()) {
             return new ValidationResponse("Server name is required.");
         }
-        if (!object.matches(".*://")) {
-            return super.validate("irc://" + object);
-        } else {
+        if (object.matches(".*://")) {
             return super.validate(object);
+        } else {
+            return super.validate("irc://" + object);
         }
     }
 }

src/com/dmdirc/util/validators/ValidatorChain.java

      * @param validators The validators to be used in this chain.
      * @deprecated Use a builder or pass a list to avoid unchecked warnings.
      */
-    @SuppressWarnings({"unchecked", "varargs"})
+    @SuppressWarnings("unchecked")
     @Deprecated
     public ValidatorChain(final Validator<A>... validators) {
         validatorList = Arrays.asList(validators);

test/com/dmdirc/util/collections/InvalidConfigFileExceptionTest.java → test/com/dmdirc/util/io/InvalidConfigFileExceptionTest.java

  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  */
-package com.dmdirc.util.collections;
+package com.dmdirc.util.io;
 
-import com.dmdirc.util.io.InvalidConfigFileException;
 import org.junit.Test;
-import static org.junit.Assert.*;
+
+import static org.junit.Assert.assertEquals;
 
 public class InvalidConfigFileExceptionTest {
 

test/com/dmdirc/util/io/ReverseFileReaderTest.java

 
     @Test
     public void testIndividual() throws IOException, URISyntaxException {
-        final ReverseFileReader reader = new ReverseFileReader(
-                Paths.get(getClass().getResource("test1.txt").toURI()));
-        assertEquals("Line 7", reader.getNextLine());
-        assertEquals("Line 6", reader.getNextLine());
-        assertEquals("Line 5", reader.getNextLine());
-        assertEquals("Line 4", reader.getNextLine());
-        assertEquals("Line 3", reader.getNextLine());
-        assertEquals("Line 2", reader.getNextLine());
-        assertEquals("Line 1", reader.getNextLine());
-        reader.close();
+        try (ReverseFileReader reader = new ReverseFileReader(
+                Paths.get(getClass().getResource("test1.txt").toURI()))) {
+            assertEquals("Line 7", reader.getNextLine());
+            assertEquals("Line 6", reader.getNextLine());
+            assertEquals("Line 5", reader.getNextLine());
+            assertEquals("Line 4", reader.getNextLine());
+            assertEquals("Line 3", reader.getNextLine());
+            assertEquals("Line 2", reader.getNextLine());
+            assertEquals("Line 1", reader.getNextLine());
+        }
     }
 
     @Test
     public void testCarriageReturn() throws IOException, URISyntaxException {
-        final ReverseFileReader reader = new ReverseFileReader(
-                Paths.get((getClass().getResource("test4.txt").toURI())));
-        reader.getNextLine();
-        assertEquals("Normal line", reader.getNextLine());
-        reader.close();
+        try (ReverseFileReader reader = new ReverseFileReader(
+                Paths.get(getClass().getResource("test4.txt").toURI()))) {
+            reader.getNextLine();
+            assertEquals("Normal line", reader.getNextLine());
+        }
     }
 
     @Test
     public void testLongLine() throws IOException, URISyntaxException {
-        final ReverseFileReader reader = new ReverseFileReader(
-                Paths.get((getClass().getResource("test4.txt").toURI())));
-        assertEquals("This is a line that is longer than 50 characters, so " +
-                "should cause the reader to have to scan back multiple times.",
-                reader.getNextLine());
-        reader.close();
+        try (ReverseFileReader reader = new ReverseFileReader(
+                Paths.get(getClass().getResource("test4.txt").toURI()))) {
+            assertEquals("This is a line that is longer than 50 characters, so " +
+                            "should cause the reader to have to scan back multiple times.",
+                    reader.getNextLine());
+        }
     }
 
     @Test
     public void testStack() throws IOException, URISyntaxException {
-        final ReverseFileReader reader = new ReverseFileReader(
-                Paths.get((getClass().getResource("test1.txt").toURI())));
-        final Stack<String> lines = reader.getLines(10);
-
-        assertEquals(7, lines.size());
-        assertEquals("Line 1", lines.pop());
-        assertEquals("Line 2", lines.pop());
-        assertEquals("Line 3", lines.pop());
-        assertEquals("Line 4", lines.pop());
-        assertEquals("Line 5", lines.pop());
-        assertEquals("Line 6", lines.pop());
-        assertEquals("Line 7", lines.pop());
-        reader.close();
+        try (ReverseFileReader reader = new ReverseFileReader(
+                Paths.get(getClass().getResource("test1.txt").toURI()))) {
+            final Stack<String> lines = reader.getLines(10);
+
+            assertEquals(7, lines.size());
+            assertEquals("Line 1", lines.pop());
+            assertEquals("Line 2", lines.pop());
+            assertEquals("Line 3", lines.pop());
+            assertEquals("Line 4", lines.pop());
+            assertEquals("Line 5", lines.pop());
+            assertEquals("Line 6", lines.pop());
+            assertEquals("Line 7", lines.pop());
+        }
     }
 
     @Test
     public void testSmallStack() throws IOException, URISyntaxException {
-        final ReverseFileReader reader = new ReverseFileReader(
-                Paths.get((getClass().getResource("test1.txt").toURI())));
-        final Stack<String> lines = reader.getLines(3);
-
-        assertEquals(3, lines.size());
-        assertEquals("Line 5", lines.pop());
-        assertEquals("Line 6", lines.pop());
-        assertEquals("Line 7", lines.pop());
-        reader.close();
+        try (ReverseFileReader reader = new ReverseFileReader(
+                Paths.get(getClass().getResource("test1.txt").toURI()))) {
+            final Stack<String> lines = reader.getLines(3);
+            assertEquals(3, lines.size());
+            assertEquals("Line 5", lines.pop());
+            assertEquals("Line 6", lines.pop());
+            assertEquals("Line 7", lines.pop());
+        }
     }
 
     @Test
     public void testgetLinesAsString() throws IOException, URISyntaxException {
-        final ReverseFileReader reader = new ReverseFileReader(
-                Paths.get((getClass().getResource("test5.txt").toURI())));
-        final String lines = reader.getLinesAsString(3);
-        assertEquals("Line 1\nLine 2\nLine 3\n", lines);
-        reader.close();
+        try (ReverseFileReader reader = new ReverseFileReader(
+                Paths.get(getClass().getResource("test5.txt").toURI()))) {
+            final String lines = reader.getLinesAsString(3);
+            assertEquals("Line 1\nLine 2\nLine 3\n", lines);
+        }
     }
 
     @Test
     public void testgetLinesAsStringLeadingNewline() throws IOException, URISyntaxException {
-        final ReverseFileReader reader = new ReverseFileReader(
-                Paths.get((getClass().getResource("test5.txt").toURI())));
-        final String lines = reader.getLinesAsString(4);
-        assertEquals("Line 1\nLine 2\nLine 3\n", lines);
-        reader.close();
+        try (ReverseFileReader reader = new ReverseFileReader(
+                Paths.get(getClass().getResource("test5.txt").toURI()))) {
+            final String lines = reader.getLinesAsString(4);
+            assertEquals("Line 1\nLine 2\nLine 3\n", lines);
+        }
     }
 
     @Test
 
     @Test
     public void testReset() throws IOException, URISyntaxException {
-        final ReverseFileReader reader = new ReverseFileReader(
-                Paths.get((getClass().getResource("test1.txt").toURI())));
-        assertEquals("Line 7", reader.getNextLine());
-        assertEquals("Line 6", reader.getNextLine());
-        reader.reset();
-        assertEquals("Line 7", reader.getNextLine());
-        assertEquals("Line 6", reader.getNextLine());
-        assertEquals("Line 5", reader.getNextLine());
-        reader.close();
+        try (ReverseFileReader reader = new ReverseFileReader(
+                Paths.get(getClass().getResource("test1.txt").toURI()))) {
+            assertEquals("Line 7", reader.getNextLine());
+            assertEquals("Line 6", reader.getNextLine());
+            reader.reset();
+            assertEquals("Line 7", reader.getNextLine());
+            assertEquals("Line 6", reader.getNextLine());
+            assertEquals("Line 5", reader.getNextLine());
+        }
     }
 
     public void testCloseIsIdempotent() throws URISyntaxException, IOException {
         final ReverseFileReader reader = new ReverseFileReader(
-                Paths.get((getClass().getResource("test1.txt").toURI())));
+                Paths.get(getClass().getResource("test1.txt").toURI()));
         reader.close();
         reader.close();
     }
     @Test(expected=IOException.class)
     public void testIllegalReset() throws URISyntaxException, IOException {
         final ReverseFileReader reader = new ReverseFileReader(
-                Paths.get((getClass().getResource("test1.txt").toURI())));
+                Paths.get(getClass().getResource("test1.txt").toURI()));
         reader.close();
         reader.reset();
     }
     @Test(expected=IOException.class)
     public void testIllegalGetNextLine() throws URISyntaxException, IOException {
         final ReverseFileReader reader = new ReverseFileReader(
-                Paths.get((getClass().getResource("test1.txt").toURI())));
+                Paths.get(getClass().getResource("test1.txt").toURI()));
         reader.close();
         reader.getNextLine();
     }
 
     @Test
     public void testSeekLength() throws IOException, URISyntaxException {
-        final ReverseFileReader reader = new ReverseFileReader(
-                Paths.get((getClass().getResource("test1.txt").toURI())));
-        reader.setSeekLength((byte) 100);
-        assertEquals((byte) 100, reader.getSeekLength());
+        try (ReverseFileReader reader = new ReverseFileReader(
+                Paths.get(getClass().getResource("test1.txt").toURI()))) {
+            reader.setSeekLength((byte) 100);
+            assertEquals((byte) 100, reader.getSeekLength());
+        }
     }
 
 }

test/com/dmdirc/util/validators/ValidatorChainTest.java

 
     @Test
     public void testValidate() {
-        final Validator<String> chain = new ValidatorChain<>(
-                new NotEmptyValidator(), new RegexStringValidator("[a-z]*", "abc"));
+        final Validator<String> chain = new ValidatorChainBuilder<String>()
+                .addValidator(new NotEmptyValidator())
+                .addValidator(new RegexStringValidator("[a-z]*", "abc"))
+                .build();
         
         assertTrue(chain.validate("").isFailure());
         assertTrue(chain.validate("__").isFailure());