Support Message IDs

Author: mbax

src/main/java/org/kitteh/irc/client/library/defaults/element/messagetag/DefaultMessageTagMsgId.java

@@ -0,0 +1,65 @@
+/*
+ * * Copyright (C) 2013-2019 Matt Baxter https://kitteh.org
+ *
+ * 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 org.kitteh.irc.client.library.defaults.element.messagetag;
+
+import org.checkerframework.checker.nullness.qual.NonNull;
+import org.kitteh.irc.client.library.Client;
+import org.kitteh.irc.client.library.element.MessageTag;
+import org.kitteh.irc.client.library.feature.MessageTagManager;
+import org.kitteh.irc.client.library.util.TriFunction;
+
+import java.util.Objects;
+
+/**
+ * Default implementation of {@link MsgId}.
+ */
+public class DefaultMessageTagMsgId extends MessageTagManager.DefaultMessageTag implements MessageTag.MsgId {
+    /**
+     * Function to create this message tag.
+     */
+    @SuppressWarnings("ConstantConditions")
+    public static final TriFunction<Client, String, String, DefaultMessageTagMsgId> FUNCTION = (client, name, value) -> new DefaultMessageTagMsgId(name, value);
+
+    private final String id;
+
+    private DefaultMessageTagMsgId(@NonNull String name, @NonNull String value) {
+        super(name, value);
+        this.id = value;
+    }
+
+    @Override
+    public @NonNull String getId() {
+        return this.id;
+    }
+
+    @Override
+    public boolean equals(Object o) {
+        return o instanceof MessageTag.MsgId && this.id.equals(((MessageTag.MsgId) o).getId());
+    }
+
+    @Override
+    public int hashCode() {
+        return Objects.hash("MsgId", this.id);
+    }
+}

src/main/java/org/kitteh/irc/client/library/defaults/feature/DefaultMessageTagManager.java

@@ -26,9 +26,11 @@
 import org.checkerframework.checker.nullness.qual.NonNull;
 import org.checkerframework.checker.nullness.qual.Nullable;
 import org.kitteh.irc.client.library.Client;
+import org.kitteh.irc.client.library.defaults.element.messagetag.DefaultMessageTagMsgId;
 import org.kitteh.irc.client.library.defaults.element.messagetag.DefaultMessageTagTime;
 import org.kitteh.irc.client.library.element.MessageTag;
 import org.kitteh.irc.client.library.exception.KittehServerMessageTagException;
+import org.kitteh.irc.client.library.feature.CapabilityManager;
 import org.kitteh.irc.client.library.feature.MessageTagManager;
 import org.kitteh.irc.client.library.util.AbstractNameValueProcessor;
 import org.kitteh.irc.client.library.util.ToStringer;
@@ -80,7 +82,8 @@ private TagCreator(@NonNull String capability, @NonNull TriFunction<Client, Stri
      */
     public DefaultMessageTagManager(Client.WithManagement client) {
         super(client);
-        this.registerTagCreator("server-time", "time", DefaultMessageTagTime.FUNCTION);
+        this.registerTagCreator(CapabilityManager.Defaults.SERVER_TIME, "time", DefaultMessageTagTime.FUNCTION);
+        this.registerTagCreator(CapabilityManager.Defaults.MESSAGE_TAGS, "msgid", DefaultMessageTagMsgId.FUNCTION);
     }
 
     @Override

src/main/java/org/kitteh/irc/client/library/element/MessageTag.java

@@ -32,6 +32,13 @@
  * Reflects a message tag.
  */
 public interface MessageTag {
+    /**
+     * Represents the `msgid` tag as specified by the Message IDs spec.
+     */
+    interface MsgId extends MessageTag {
+        @NonNull String getId();
+    }
+
     /**
      * Represents the 'time' tag as specified by the 'server-time' extension.
      */