Add protocol description objects (parser information objects)

Fixes issue 3472

Change-Id: If3f401793669e0e309d5841da217f7464958fbac
Reviewed-on: http://gerrit.dmdirc.com/1181
Automatic-Compile: DMDirc Local Commits <dmdirc@googlemail.com>
Reviewed-by: Gregory Holmes <greg@dmdirc.com>

src/com/dmdirc/parser/interfaces/Parser.java

@@ -25,8 +25,8 @@ package com.dmdirc.parser.interfaces;
 import com.dmdirc.parser.common.IgnoreList;
 import com.dmdirc.parser.common.CallbackManager;
 import com.dmdirc.parser.common.ChannelJoinRequest;
-
 import com.dmdirc.parser.common.QueuePriority;
+
 import java.net.URI;
 import java.util.Collection;
 import java.util.Map;
@@ -199,6 +199,7 @@ public interface Parser extends Runnable {
      * Extracts any channels present in the specified URI.
      *
      * @param uri The URI to extract channels from
+     * @return A list of channel join requests extracted from the specified URI
      * @since 0.6.4
      */
     Collection<? extends ChannelJoinRequest> extractChannels(final URI uri);

src/com/dmdirc/parser/interfaces/ProtocolDescription.java

@@ -0,0 +1,50 @@
+/*
+ * Copyright (c) 2006-2010 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.parser.interfaces;
+
+/**
+ * Describes the default properties a protocol handled by a {@link Parser}
+ * instance.
+ *
+ * @since 0.6.4
+ * @author chris
+ */
+public interface ProtocolDescription {
+
+    /**
+     * Retrieves the default port to use for this protocol if none is specified.
+     *
+     * @return This protocol's default port
+     */
+    int getDefaultPort();
+
+    /**
+     * Parses the specified hostmask into an array containing a nickname,
+     * username and hostname, in that order.
+     *
+     * @param hostmask The hostmask to be parsed
+     * @return An array containing the nickname, username and hostname
+     */
+    String[] parseHostmask(String hostmask);
+
+}

src/com/dmdirc/parser/irc/IRCProtocolDescription.java

@@ -0,0 +1,47 @@
+/*
+ * Copyright (c) 2006-2010 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.parser.irc;
+
+import com.dmdirc.parser.interfaces.ProtocolDescription;
+
+/**
+ * Provides a description of the IRC protocol.
+ *
+ * @since 0.6.4
+ * @author chris
+ */
+public class IRCProtocolDescription implements ProtocolDescription {
+
+    /** {@inheritDoc} */
+    @Override
+    public int getDefaultPort() {
+        return 6667;
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public String[] parseHostmask(final String hostmask) {
+        return IRCClientInfo.parseHostFull(hostmask);
+    }
+
+}