Merge pull request #130 from csmith/master

Make QueueItem an autovalue.

irc/src/com/dmdirc/parser/irc/outputqueue/OutputQueue.java

@@ -205,7 +205,7 @@ public abstract class OutputQueue {
      * @param priority The priority at which the line should be sent.
      */
     protected void enqueue(final String line, final QueuePriority priority) {
-        queue.add(new QueueItem(line, priority));
+        queue.add(QueueItem.create(line, priority));
     }
 
     /**

irc/src/com/dmdirc/parser/irc/outputqueue/QueueItem.java

@@ -24,89 +24,78 @@ package com.dmdirc.parser.irc.outputqueue;
 
 import com.dmdirc.parser.common.QueuePriority;
 
+import com.google.auto.value.AutoValue;
+
 import java.time.Clock;
 import java.time.LocalDateTime;
+import java.util.concurrent.atomic.AtomicLong;
 
 /**
  * Queued Item.
  */
-public class QueueItem {
+@AutoValue
+public abstract class QueueItem {
 
-    /** Global Item Number. */
-    private static long number;
-    /** Line to send. */
-    private final String line;
-    /** Time this line was added. */
-    private final LocalDateTime time;
-    /** Item Number. */
-    private final long itemNumber;
-    /** What is the priority of this line? */
-    private final QueuePriority priority;
+    /** Static counter to assign IDs to items. */
+    // TODO: Move this into OutputQueue or somewhere not static.
+    private static final AtomicLong itemCounter = new AtomicLong(0);
 
     /**
-     * Create a new QueueItem.
+     * Get the line that is to be sent to the server.
      *
-     * @param line Line to send
-     * @param priority Priority for the queue item
+     * @return the line to be sent.
      */
-    public QueueItem(final String line, final QueuePriority priority) {
-        this(Clock.systemDefaultZone(), line, priority);
-    }
+    public abstract String getLine();
 
     /**
-     * Create a new QueueItem.
+     * Gets the time at which this item was queued.
      *
-     * @param line Line to send
-     * @param priority Priority for the queue item
+     * @return the time this item was queued.
      */
-    public QueueItem(final Clock clock, final String line,
-            final QueuePriority priority) {
-        this.line = line;
-        this.priority = priority;
-
-        this.time = LocalDateTime.now(clock);
-        this.itemNumber = number++;
-    }
+    public abstract LocalDateTime getTime();
 
     /**
-     * Get the value of line.
+     * Get the number of this item.
      *
-     * @return the value of line
+     * @return the number of this item (representing the order it was queued in).
      */
-    public String getLine() {
-        return line;
-    }
+    public abstract long getItemNumber();
 
     /**
-     * Gets the time at which this item was queued.
+     * Get the priority of this item.
      *
-     * @return the time this item was queued.
+     * @return the item priority
      */
-    public LocalDateTime getTime() {
-        return time;
+    public abstract QueuePriority getPriority();
+
+    @Override
+    public String toString() {
+        return String.format("[%s %s] %s", getPriority(), getTime(), getLine());
     }
 
     /**
-     * Get the number of this item.
+     * Creates a new {@link QueueItem}.
      *
-     * @return the value of itemNumber
+     * @param line The line to be sent to the server.
+     * @param priority The priority of the line.
+     * @return A new item to be submitted to the queue.
      */
-    public long getItemNumber() {
-        return itemNumber;
+    public static QueueItem create(final String line, final QueuePriority priority) {
+        return create(Clock.systemDefaultZone(), line, priority);
     }
 
     /**
-     * Get the value of priority.
+     * Creates a new {@link QueueItem}.
      *
-     * @return the value of priority
+     * @param clock The clock to use to get the current time.
+     * @param line The line to be sent to the server.
+     * @param priority The priority of the line.
+     * @return A new item to be submitted to the queue.
      */
-    public QueuePriority getPriority() {
-        return priority;
-    }
-
-    @Override
-    public String toString() {
-        return String.format("[%s %s] %s", priority, time, line);
+    public static QueueItem create(
+            final Clock clock, final String line, final QueuePriority priority) {
+        return new AutoValue_QueueItem(line, LocalDateTime.now(clock),
+                itemCounter.getAndIncrement(), priority);
     }
 
 }

irc/test/com/dmdirc/parser/irc/outputqueue/QueueComparatorsTest.java

@@ -45,20 +45,20 @@ public class QueueComparatorsTest {
     private static final Clock NOW_MINUS_TEN = Clock.fixed(Instant.ofEpochMilli(90 * 1000),
             ZoneId.systemDefault());
 
-    private final QueueItem currentLowPriority1 = new QueueItem(NOW_MINUS_FIVE,
-            "", QueuePriority.LOW);
+    private final QueueItem currentLowPriority1 = QueueItem.create(
+            NOW_MINUS_FIVE, "", QueuePriority.LOW);
 
-    private final QueueItem currentLowPriority2 = new QueueItem(NOW_MINUS_FIVE,
-            "", QueuePriority.LOW);
+    private final QueueItem currentLowPriority2 = QueueItem.create(
+            NOW_MINUS_FIVE, "", QueuePriority.LOW);
 
-    private final QueueItem currentNormalPriority = new QueueItem(NOW_MINUS_FIVE,
-            "", QueuePriority.NORMAL);
+    private final QueueItem currentNormalPriority = QueueItem.create(
+            NOW_MINUS_FIVE, "", QueuePriority.NORMAL);
 
-    private final QueueItem currentHighPriority = new QueueItem(NOW_MINUS_FIVE,
-            "", QueuePriority.HIGH);
+    private final QueueItem currentHighPriority = QueueItem.create(
+            NOW_MINUS_FIVE, "", QueuePriority.HIGH);
 
-    private final QueueItem oldLowPriority = new QueueItem(NOW_MINUS_TEN,
-            "", QueuePriority.LOW);
+    private final QueueItem oldLowPriority = QueueItem.create(
+            NOW_MINUS_TEN, "", QueuePriority.LOW);
 
     @Test
     public void testComparesByPriority() {