Add protocol description objects to twitter/irc plugins

Change-Id: I9703a04c087940686705e7fdddb0be5dcc2a3b00
Reviewed-on: http://gerrit.dmdirc.com/1183
Reviewed-by: Gregory Holmes <greg@dmdirc.com>
Automatic-Compile: Gregory Holmes <greg@dmdirc.com>

src/com/dmdirc/addons/parser_irc/IrcPlugin.java

@@ -24,13 +24,17 @@ package com.dmdirc.addons.parser_irc;
 
 import com.dmdirc.parser.common.MyInfo;
 import com.dmdirc.parser.interfaces.Parser;
+import com.dmdirc.parser.interfaces.ProtocolDescription;
 import com.dmdirc.parser.irc.IRCParser;
+import com.dmdirc.parser.irc.IRCProtocolDescription;
 import com.dmdirc.plugins.Plugin;
+
 import java.net.URI;
 
 /**
  * A plugin which provides access to the IRC Parser.
  *
+ * @since 0.6.4
  * @author chris
  */
 public class IrcPlugin extends Plugin {
@@ -58,4 +62,13 @@ public class IrcPlugin extends Plugin {
         return new IRCParser(myInfo, address);
     }
 
+    /**
+     * Retrieves a description of the IRC protocol.
+     *
+     * @return An appropriate protocol description object
+     */
+    public ProtocolDescription getDescription() {
+        return new IRCProtocolDescription();
+    }
+
 }

src/com/dmdirc/addons/parser_irc/plugin.config

@@ -26,4 +26,5 @@ provides:
   ircs parser
 
 exports:
-  getParser in com.dmdirc.addons.parser_irc.IrcPlugin as getParser
+  getParser in com.dmdirc.addons.parser_irc.IrcPlugin as getParser
+  getDescription in com.dmdirc.addons.parser_irc.IrcPlugin as getProtocolDescription

src/com/dmdirc/addons/parser_twitter/TwitterPlugin.java

@@ -29,6 +29,7 @@ import com.dmdirc.config.prefs.PreferencesSetting;
 import com.dmdirc.config.prefs.PreferencesType;
 import com.dmdirc.parser.common.MyInfo;
 import com.dmdirc.parser.interfaces.Parser;
+import com.dmdirc.parser.interfaces.ProtocolDescription;
 import com.dmdirc.plugins.Plugin;
 import java.net.URI;
 import java.util.ArrayList;
@@ -69,6 +70,16 @@ public class TwitterPlugin extends Plugin  {
         return (unloading) ? null : new Twitter(myInfo, address, this);
     }
 
+    /**
+     * Retrieves a protocol description for the twitter protocol.
+     *
+     * @return A description of the twitter protocol
+     * @since 0.6.4
+     */
+    public ProtocolDescription getDescription() {
+        return new TwitterProtocolDescription();
+    }
+
     /** {@inheritDoc} */
     @Override
     public void showConfig(final PreferencesManager manager) {

src/com/dmdirc/addons/parser_twitter/TwitterProtocolDescription.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.addons.parser_twitter;
+
+import com.dmdirc.parser.interfaces.ProtocolDescription;
+
+/**
+ * Describes the twitter protocol.
+ *
+ * @since 0.6.4
+ * @author chris
+ */
+public class TwitterProtocolDescription implements ProtocolDescription {
+
+    /** {@inheritDoc} */
+    @Override
+    public int getDefaultPort() {
+        return 80;
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public String[] parseHostmask(final String hostmask) {
+        return TwitterClientInfo.parseHostFull(hostmask, null, null);
+    }
+
+}

src/com/dmdirc/addons/parser_twitter/plugin.config

@@ -46,6 +46,7 @@ provides:
 
 exports:
   getParser in com.dmdirc.addons.parser_twitter.TwitterPlugin as getParser
+  getDescription in com.dmdirc.addons.parser_twitter.TwitterPlugin as getProtocolDescription
 
 icons:
   category-twitter=plugin://twitter:com/dmdirc/addons/parser_twitter/res/twitter.png