Add getMap() to Parser and IRCParser. Fixes issue 3206

Add getMap() to ChannelInfo and make getMap() in IRCChannelInfo behave the same way as in IRCClientInfo and IRCChannelClientInfo

Change-Id: I2cdce2eb87e77139520254eec98b51288510f043
Reviewed-on: http://gerrit.dmdirc.com/125
Tested-by: Shane Mc Cormack <shane@dmdirc.com>
Reviewed-by: Shane Mc Cormack <shane@dmdirc.com>

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

@@ -24,6 +24,7 @@ package com.dmdirc.parser.interfaces;
 
 import com.dmdirc.parser.common.ChannelListModeItem;
 import java.util.Collection;
+import java.util.Map;
 
 /**
  * Holds information about a channel and allows various operations to be
@@ -183,6 +184,14 @@ public interface ChannelInfo {
      */
     int getChannelClientCount();
 
+    /**
+     * Retrieves a {@link Map} which can be used to store arbitrary data
+     * about the channel client.
+     *
+     * @return A map used for storing arbitrary data
+     */
+    Map<Object, Object> getMap();
+
     /**
      * Retrieves the parser which created this ChannelInfo.
      *

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

@@ -28,6 +28,7 @@ import com.dmdirc.parser.common.CallbackManager;
 import com.dmdirc.parser.common.QueuePriority;
 import java.net.URI;
 import java.util.Collection;
+import java.util.Map;
 
 /**
  * A parser connects to a back-end chat system and handles all communication
@@ -90,6 +91,14 @@ public interface Parser extends Runnable {
      */
     void setBindIP(String ip);
 
+    /**
+     * Retrieves a {@link Map} which can be used to store arbitrary data
+     * about the client.
+     *
+     * @return A map used for storing arbitrary data
+     */
+    Map<Object, Object> getMap();
+
     /**
      * Determines the maximimum length a message of the specified type may be.
      *

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

@@ -86,7 +86,7 @@ public class IRCChannelInfo implements ChannelInfo {
     /** Modes waiting to be sent to the server. */
     private final List<String> lModeQueue = new LinkedList<String>();
     /** A Map to allow applications to attach misc data to this object */
-    private Map myMap;
+    private Map<Object, Object> myMap;
     
     /** Queue of requested list modes */
     private final Queue<Character> listModeQueue = new LinkedList<Character>();
@@ -244,16 +244,13 @@ public class IRCChannelInfo implements ChannelInfo {
      *
      * @param newMap New Map to attatch.
      */
-    public void setMap(final Map newMap) {
+    public void setMap(final Map<Object, Object> newMap) {
         myMap = newMap;
     }
     
-    /**
-     * Get the Map object attatched to this object.
-     *
-     * @return Map to attatched to this.
-     */
-    public Map getMap() {
+    /** {@inheritDoc} */
+    @Override
+    public Map<Object, Object> getMap() {
         return myMap;
     }
     

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

@@ -55,6 +55,7 @@ import java.security.NoSuchAlgorithmException;
 import java.security.cert.X509Certificate;
 import java.util.Arrays;
 import java.util.Collection;
+import java.util.HashMap;
 import java.util.Hashtable;
 import java.util.LinkedList;
 import java.util.List;
@@ -232,6 +233,9 @@ public class IRCParser implements SecureParser, Runnable {
     /** Current Socket State. */
     protected SocketState currentSocketState = SocketState.NULL;
 
+    /** Map to store arbitrary data. */
+    private Map<Object, Object> myMap = new HashMap<Object, Object>();
+
     /** This is the socket used for reading from/writing to the IRC server. */
     private Socket socket;
     /** Used for writing to the server. */
@@ -334,6 +338,10 @@ public class IRCParser implements SecureParser, Runnable {
     @Override
     public URI getURI() { return server.getURI(); }
 
+    /** {@inheritDoc} */
+    @Override
+    public Map<Object, Object> getMap() { return myMap; }
+
     /**
      * Get the current Value of createFake.
      *