Five more Equals/HashCode/StringBuilder replacements
[controller.git] / opendaylight / sal / api / src / main / java / org / opendaylight / controller / sal / core / NodeConnector.java
index bbe952ddea61dcc2817cb5b568ea7f8117b9a25f..495af7970c7f0597ad50fc1e39863aafd3753fd6 100644 (file)
  */
 package org.opendaylight.controller.sal.core;
 
-import org.apache.commons.lang3.tuple.ImmutablePair;
-import java.util.concurrent.ConcurrentHashMap;
 import java.io.Serializable;
-import java.util.HashMap;
-import java.util.Map;
-
-import org.apache.commons.lang3.builder.EqualsBuilder;
-import org.apache.commons.lang3.builder.HashCodeBuilder;
+import java.util.concurrent.ConcurrentHashMap;
 
-import javax.xml.bind.annotation.XmlRootElement;
 import javax.xml.bind.annotation.XmlAccessType;
 import javax.xml.bind.annotation.XmlAccessorType;
-import javax.xml.bind.annotation.XmlElement;
 import javax.xml.bind.annotation.XmlAttribute;
+import javax.xml.bind.annotation.XmlElement;
+import javax.xml.bind.annotation.XmlRootElement;
+
+import org.apache.commons.lang3.tuple.ImmutablePair;
 
 /**
  * Describe a generic network element attachment points,
@@ -52,29 +48,33 @@ public class NodeConnector implements Serializable {
      */
     public static class NodeConnectorIDType {
         private static final
-        ConcurrentHashMap<String, ImmutablePair<Class, String>> compatibleType =
-            new ConcurrentHashMap<String, ImmutablePair<Class, String>>();
+        ConcurrentHashMap<String, ImmutablePair<Class<? extends Object>, String>> compatibleType =
+            new ConcurrentHashMap<String, ImmutablePair<Class<? extends Object>, String>>();
         /**
-         * Represent a special port pointing toward the controller,
-         * this is to send data packets toward the controller from
-         * data plane.
+         * Represents the OFPP_CONTROLLER reserved port to forward a
+         * packet to the controller, this is to send data packets
+         * to the controller from the data plane triggering
+         * a packet_in event.
          */
         public static String CONTROLLER = "CTRL";
         /**
-         * Special port describing ALL the ports in the system,
-         * should be used for flooding like mechanism but better
-         * to be carefull with it
+         * Represents the OFPP_ALL reserved OF port
+         * to forward to ALL the ports in the system ,
+         * should be used for flooding like mechanism to
+         * be used cautiously to avoid excessive flooding.
          */
         public static String ALL = "ALL";
         /**
-         * Describe the local networking stack of the node
-         * on which the packet is destined. Yet another special port
+         * Represents the OFPP_LOCAL reserved OF port
+         * to access the local networking stack of the node
+         * of which the packet is destined. Typically used for
+         * inband OF communications channel.
          */
         public static String SWSTACK = "SW";
         /**
-         * Describe a special destination that invoke the
-         * traditional HW forwarding on platforms that has this
-         * provision.
+         * Describes OFPP_Normal reserved port destination that invokes
+         * the traditional native L2/L3 HW normal forwarding functionality
+         * if supported on the forwarding element.
          */
         public static String HWPATH = "HW";
         public static String OPENFLOW = "OF";
@@ -177,7 +177,7 @@ public class NodeConnector implements Serializable {
          * @return true if registered, false otherwise
          */
         public static boolean registerIDType(String type,
-                                             Class compatibleID,
+                                             Class<? extends Object> compatibleID,
                                              String compatibleNode) {
             if (compatibleType.get(type) != null) {
                 return false;
@@ -330,10 +330,10 @@ public class NodeConnector implements Serializable {
         }
     }
 
-    /** 
+    /**
      * Private setter for nodeConnectorType to be called by JAXB not by anyone
      * else, NodeConnector is immutable
-     * 
+     *
      * @param type of node to be set
      */
     private void setType(String type) {
@@ -364,9 +364,9 @@ public class NodeConnector implements Serializable {
         return this.nodeConnectorID.toString();
     }
 
-    /** 
+    /**
      * private setter to be used by JAXB
-     * 
+     *
      * @param nodeConnectorIDString String representation for NodeConnectorID
      */
     private void setNodeConnectorIDString(String IDStr) {
@@ -388,26 +388,46 @@ public class NodeConnector implements Serializable {
 
     @Override
     public int hashCode() {
-        return new HashCodeBuilder(63389, 4951)
-            .append(nodeConnectorType)
-            .append(nodeConnectorID)
-            .append(nodeConnectorNode)
-            .hashCode();
+        final int prime = 31;
+        int result = 1;
+        result = prime * result
+                + ((nodeConnectorID == null) ? 0 : nodeConnectorID.hashCode());
+        result = prime
+                * result
+                + ((nodeConnectorNode == null) ? 0 : nodeConnectorNode
+                        .hashCode());
+        result = prime
+                * result
+                + ((nodeConnectorType == null) ? 0 : nodeConnectorType
+                        .hashCode());
+        return result;
     }
 
     @Override
     public boolean equals(Object obj) {
-        if (obj == null) { return false; }
-        if (obj == this) { return true; }
-        if (obj.getClass() != getClass()) {
+        if (this == obj)
+            return true;
+        if (obj == null)
             return false;
-        }
-        NodeConnector rhs = (NodeConnector)obj;
-        return new EqualsBuilder()
-            .append(this.getType(), rhs.getType())
-            .append(this.getID(), rhs.getID())
-            .append(this.getNode(), rhs.getNode())
-            .isEquals();
+        if (getClass() != obj.getClass())
+            return false;
+        NodeConnector other = (NodeConnector) obj;
+        if (nodeConnectorID == null) {
+            if (other.nodeConnectorID != null)
+                return false;
+        } else if (!nodeConnectorID.equals(other.nodeConnectorID))
+            return false;
+        if (nodeConnectorNode == null) {
+            if (other.nodeConnectorNode != null)
+                return false;
+        } else if (!nodeConnectorNode.equals(other.nodeConnectorNode))
+            return false;
+        if (nodeConnectorType == null) {
+            if (other.nodeConnectorType != null)
+                return false;
+        } else if (!nodeConnectorType.equals(other.nodeConnectorType))
+            return false;
+        return true;
     }
 
     @Override
@@ -443,7 +463,7 @@ public class NodeConnector implements Serializable {
      *
      * @param str String to be parsed in a NodeConnector
      *
-     * @return the NodeConnector if parse is succesfull, null otherwise
+     * @return the NodeConnector if parse is successful, null otherwise
      */
     public static NodeConnector fromString(String str) {
         if (str == null) {
@@ -462,13 +482,13 @@ public class NodeConnector implements Serializable {
     }
 
     /**
-     * return a NodeConnector from a string not containing explicitely
+     * return a NodeConnector from a string not containing explicitly
      * the Node portion which has to be supplied as parameter
      *
      * @param str String to be parsed in a NodeConnector
      * @param n Node to which the NodeConnector is attached
      *
-     * @return the NodeConnector if parse is succesfull, null otherwise
+     * @return the NodeConnector if parse is successful, null otherwise
      */
     public static NodeConnector fromStringNoNode(String str, Node n) {
         if (str == null) {
@@ -536,14 +556,14 @@ public class NodeConnector implements Serializable {
 
     /**
      * return a NodeConnector from a pair (type, ID) in string format
-     * not containing explicitely the Node portion which has to be
+     * not containing explicitly the Node portion which has to be
      * supplied as parameter
      *
      * @param typeStr type String to be parsed in a NodeConnector
      * @param IDStr ID String portion to be parsed in a NodeConnector
      * @param n Node to which the NodeConnector is attached
      *
-     * @return the NodeConnector if parse is succesfull, null otherwise
+     * @return the NodeConnector if parse is successful, null otherwise
      */
     public static NodeConnector fromStringNoNode(String typeStr, String IDStr,
                                                  Node n) {