Fixing hash for Intent keys

Change-Id: Ie7807d95b3e58f2e79c6127251ef355b77ba05ff

@@ -26,9 +26,9 @@ import java.util.Objects;
  * Key class for Intents.
  * Key class for Intents.
  */
  */
 // TODO maybe pull this up to utils
 // TODO maybe pull this up to utils
-// TODO need to make this classes kryo serializable
-public class Key {
+public abstract class Key {
 
 
+    //TODO consider making this a HashCode object (worry about performance)
     private final long hash;
     private final long hash;
     private static final HashFunction HASH_FN = Hashing.md5();
     private static final HashFunction HASH_FN = Hashing.md5();
 
 
@@ -40,15 +40,44 @@ public class Key {
         return hash;
         return hash;
     }
     }
 
 
+    @Override
+    public int hashCode() {
+        return (int) (hash() ^ (hash() >>> 32));
+    }
+
+    @Override
+    public abstract boolean equals(Object obj);
+
+    /**
+     * Creates a key based on the provided string.
+     * <p>
+     * Note: Two keys with equal value, but different appId, are not equal.
+     * </p>
+     *
+     * @param key the provided string
+     * @param appId application id to associate with this key
+     * @return the key for the string
+     */
     public static Key of(String key, ApplicationId appId) {
     public static Key of(String key, ApplicationId appId) {
         return new StringKey(key, appId);
         return new StringKey(key, appId);
     }
     }
 
 
+    /**
+     * Creates a key based on the provided long.
+     * <p>
+     * Note: Two keys with equal value, but different appId, are not equal.
+     * Also, "10" and 10L are different.
+     * </p>
+     *
+     * @param key the provided long
+     * @param appId application id to associate with this key
+     * @return the key for the long
+     */
     public static Key of(long key, ApplicationId appId) {
     public static Key of(long key, ApplicationId appId) {
         return new LongKey(key, appId);
         return new LongKey(key, appId);
     }
     }
 
 
-    public static final class StringKey extends Key {
+    private static final class StringKey extends Key {
 
 
         private final ApplicationId appId;
         private final ApplicationId appId;
         private final String key;
         private final String key;
@@ -67,9 +96,10 @@ public class Key {
             return key;
             return key;
         }
         }
 
 
+        // checkstyle requires this
         @Override
         @Override
         public int hashCode() {
         public int hashCode() {
-            return key.hashCode();
+            return super.hashCode();
         }
         }
 
 
         @Override
         @Override
@@ -87,7 +117,7 @@ public class Key {
         }
         }
     }
     }
 
 
-    public static final class LongKey extends Key {
+    private static final class LongKey extends Key {
 
 
         private final ApplicationId appId;
         private final ApplicationId appId;
         private final long key;
         private final long key;
@@ -106,9 +136,10 @@ public class Key {
             return "0x" + Long.toHexString(key);
             return "0x" + Long.toHexString(key);
         }
         }
 
 
+        // checkstyle requires this
         @Override
         @Override
         public int hashCode() {
         public int hashCode() {
-            return (int) (key ^ (key >>> 32));
+            return super.hashCode();
         }
         }
 
 
         @Override
         @Override
@@ -120,10 +151,10 @@ public class Key {
                 return false;
                 return false;
             }
             }
             final LongKey other = (LongKey) obj;
             final LongKey other = (LongKey) obj;
-            return Objects.equals(this.appId, other.appId) &&
-                    this.key == other.key;
+            return this.hash() == other.hash() &&
+                    this.key == other.key &&
+                    Objects.equals(this.appId, other.appId);
         }
         }
-
     }
     }
 }
 }
 
 

@@ -18,7 +18,6 @@ package org.onosproject.store.serializers;
 import com.google.common.collect.ImmutableList;
 import com.google.common.collect.ImmutableList;
 import com.google.common.collect.ImmutableMap;
 import com.google.common.collect.ImmutableMap;
 import com.google.common.collect.ImmutableSet;
 import com.google.common.collect.ImmutableSet;
-
 import org.onlab.packet.ChassisId;
 import org.onlab.packet.ChassisId;
 import org.onlab.packet.Ip4Address;
 import org.onlab.packet.Ip4Address;
 import org.onlab.packet.Ip4Prefix;
 import org.onlab.packet.Ip4Prefix;
@@ -284,9 +283,9 @@ public final class KryoNamespaces {
                     FlowRuleBatchEntry.FlowRuleOperation.class,
                     FlowRuleBatchEntry.FlowRuleOperation.class,
                     IntentId.class,
                     IntentId.class,
                     IntentState.class,
                     IntentState.class,
-                    Key.class,
-                    Key.LongKey.class,
-                    Key.StringKey.class,
+                    //Key.class, is abstract
+                    Key.of(1L, new DefaultApplicationId(0, "bar")).getClass(), //LongKey.class
+                    Key.of("foo", new DefaultApplicationId(0, "bar")).getClass(), //StringKey.class
                     Intent.class,
                     Intent.class,
                     ConnectivityIntent.class,
                     ConnectivityIntent.class,
                     PathIntent.class,
                     PathIntent.class,