Add DateUtils and a formatDuration method. Minor tidying.

Change-Id: I8269aab84413d3865975a6ca15dc656a525895ea
Reviewed-on: http://gerrit.dmdirc.com/1928
Automatic-Compile: DMDirc Local Commits <dmdirc@googlemail.com>
Reviewed-by: Chris Smith <chris@dmdirc.com>

src/com/dmdirc/util/CommandUtils.java

@@ -27,9 +27,15 @@ import java.util.ArrayList;
 import java.util.List;
 
 /**
- * Utilities for manipulating strings
+ * Utilities methods associated with commands.
  */
-public class CommandUtils {
+public final class CommandUtils {
+
+    /** Private contructor to stop instantiation of class. */
+    private CommandUtils() {
+        //Shouldn't be used.
+    }
+
     /**
      * Parses the specified command into an array of arguments. Arguments are
      * separated by spaces. Multi-word arguments may be specified by starting

src/com/dmdirc/util/ConfigFile.java

@@ -34,8 +34,6 @@ import java.util.Map;
 
 /**
  * Reads and writes a standard DMDirc config file.
- *
- * @author chris
  */
 public class ConfigFile extends TextFile {
 

src/com/dmdirc/util/DateUtils.java

@@ -0,0 +1,84 @@
+/*
+ * Copyright (c) 2006-2011 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;
+
+/**
+ * Utility methods associated with dates.
+ */
+public final class DateUtils {
+
+    /** Private contructor to stop instantiation of class. */
+    private DateUtils() {
+        //Shouldn't be used
+    }
+
+    /**
+     * Tests for and adds one component of the duration format.
+     *
+     * @param builder The string builder to append text to
+     * @param current The number of seconds in the duration
+     * @param duration The number of seconds in this component
+     * @param name The name of this component
+     * @return The number of seconds used by this component
+     */
+    private static int doDuration(final StringBuilder builder, final int current,
+            final int duration, final String name) {
+        int res = 0;
+
+        if (current >= duration) {
+            final int units = current / duration;
+            res = units * duration;
+
+            if (builder.length() > 0) {
+                builder.append(", ");
+            }
+
+            builder.append(units);
+            builder.append(' ');
+            builder.append(name);
+            builder.append(units == 1 ? "" : 's');
+        }
+
+        return res;
+    }
+
+    /**
+     * Formats the specified number of seconds as a string containing the
+     * number of days, hours, minutes and seconds.
+     *
+     * @param duration The duration in seconds to be formatted
+     * @return A textual version of the duration
+     */
+    public static String formatDuration(final int duration) {
+        final StringBuilder buff = new StringBuilder();
+
+        int seconds = duration;
+
+        seconds -= doDuration(buff, seconds, 60*60*24, "day");
+        seconds -= doDuration(buff, seconds, 60*60, "hour");
+        seconds -= doDuration(buff, seconds, 60, "minute");
+        seconds -= doDuration(buff, seconds, 1, "second");
+
+        return buff.length() == 0 ? "0 seconds" : buff.toString();
+    }
+}

src/com/dmdirc/util/DownloadListener.java

@@ -25,8 +25,6 @@ package com.dmdirc.util;
 /**
  * Defines the method that objects interested in receiving download progress
  * updates should implement.
- *
- * @author chris
  */
 public interface DownloadListener {
 

src/com/dmdirc/util/Downloader.java

@@ -40,8 +40,6 @@ import java.util.Map;
 
 /**
  * Allows easy downloading of files from HTTP sites.
- *
- * @author Chris
  */
 public final class Downloader {
 

src/com/dmdirc/util/EquatableWeakReference.java

@@ -30,7 +30,6 @@ import java.lang.ref.WeakReference;
  * method.
  *
  * @param <T> The type of object that this reference contains
- * @author chris
  */
 public class EquatableWeakReference<T> extends WeakReference<T> {
 

src/com/dmdirc/util/InvalidConfigFileException.java

@@ -24,7 +24,6 @@ package com.dmdirc.util;
 
 /**
  * Thrown to indicate that a config file is invalid.
- * @author chris
  */
 public class InvalidConfigFileException extends Exception {
 

src/com/dmdirc/util/ListenerList.java

@@ -30,8 +30,6 @@ import java.util.concurrent.CopyOnWriteArrayList;
 /**
  * Represents a list of event listeners, similar to EventListenerList, but
  * not swing specific.
- *
- * @author chris
  */
 public class ListenerList {
 

src/com/dmdirc/util/RollingList.java

@@ -19,7 +19,6 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  */
-
 package com.dmdirc.util;
 
 import java.util.ArrayList;
@@ -30,7 +29,6 @@ import java.util.List;
  * removes the oldest elements from the list to maintain this capacity.
  *
  * @param <T> The type if items that this list contains
- * @author chris
  */
 public class RollingList<T> {
 
@@ -216,5 +214,4 @@ public class RollingList<T> {
     public List<T> getList() {
         return new ArrayList<T>(items);
     }
-
 }

src/com/dmdirc/util/StreamReader.java

@@ -34,13 +34,11 @@ import java.util.List;
 public class StreamReader extends Thread {
 
     /** This is the Input Stream we are reading. */
-    private InputStream stream;
-
+    private final InputStream stream;
     /** List to store output in. */
     private List<String> list = null;
-
     /** StringBuffer to store output in. */
-    private StringBuffer buffer = null;
+    private StringBuffer buffer = null; //NOPMD
 
     /**
      * Create a new Stream Reader that discards output.
@@ -93,7 +91,8 @@ public class StreamReader extends Thread {
      */
     @Override
     public void run() {
-        BufferedReader reader = new BufferedReader(new InputStreamReader(stream));
+        final BufferedReader reader = new BufferedReader(
+                new InputStreamReader(stream));
         try {
             String line;
             while ((line = reader.readLine()) != null) {

src/com/dmdirc/util/StreamUtil.java

@@ -29,7 +29,6 @@ import java.io.IOException;
  * Utilities for dealing with streams.
  *
  * @since 0.6.3m2
- * @author chris
  */
 public final class StreamUtil {
 

src/com/dmdirc/util/TextFile.java

@@ -36,20 +36,15 @@ import java.util.List;
 
 /**
  * Allows reading and writing to a plain text file via a list of lines.
- *
- * @author chris
  */
 public class TextFile {
 
     /** The file we're dealing with. */
     private File file;
-
     /** The input stream we're dealing with. */
     private InputStream is;
-
     /** The lines we've read from the file. */
     private List<String> lines;
-
     /** The charset to use to read the file. */
     private final Charset charset;
 

src/com/dmdirc/util/WeakList.java

@@ -34,7 +34,6 @@ import java.util.ListIterator;
  * garbage collection) are handled transparently.
  *
  * @param <T> The type of object that this list will contain.
- * @author chris
  */
 public class WeakList<T> implements List<T> {
 

src/com/dmdirc/util/WeakMapList.java

@@ -32,7 +32,6 @@ import java.util.List;
  *
  * @param <S> the type of keys maintained by this map
  * @param <T> the type of mapped values
- * @author chris
  */
 public class WeakMapList<S,T> extends MapList<S,T> {
 

test/com/dmdirc/util/DateUtilsTest.java

@@ -0,0 +1,63 @@
+/*
+ * Copyright (c) 2006-2011 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 DateUtilsTest {
+
+    @Test
+    public void testFormatDurationSeconds() {
+        assertEquals("1 second", DateUtils.formatDuration(1));
+        assertEquals("2 seconds", DateUtils.formatDuration(2));
+    }
+
+    @Test
+    public void testFormatDurationMinutes() {
+        assertEquals("1 minute", DateUtils.formatDuration(60));
+        assertEquals("1 minute, 1 second", DateUtils.formatDuration(61));
+        assertEquals("1 minute, 2 seconds", DateUtils.formatDuration(62));
+        assertEquals("2 minutes, 2 seconds", DateUtils.formatDuration(122));
+    }
+
+    @Test
+    public void testFormatDurationHours() {
+        assertEquals("1 hour", DateUtils.formatDuration(3600));
+        assertEquals("1 hour, 1 second", DateUtils.formatDuration(3601));
+        assertEquals("2 hours, 1 minute, 5 seconds", DateUtils.formatDuration(7265));
+    }
+
+    @Test
+    public void testFormatDurationDays() {
+        assertEquals("1 day", DateUtils.formatDuration(86400));
+        assertEquals("1 day, 10 minutes, 1 second", DateUtils.formatDuration(87001));
+    }
+
+    @Test
+    public void testFormatNoSeconds() {
+        assertEquals("0 seconds", DateUtils.formatDuration(0));
+        assertEquals("0 seconds", DateUtils.formatDuration(-100));
+    }
+
+}