Improve equals contract in Partitions plugin (#315)

* Update equals and hashCode in SimpleAttributeId and corresponding tests

* Update equals and hashCode in AttributeDefinition and corresponding tests

* Update equals and hashCode in AttributesPluginData and corresponding tests

* Update equals and hashCode in Partition and corresponding tests

* Update equals and hashCode in LabelSet and corresponding tests

* Update equals and hashCode in AndFilter and corresponding tests

* Update equals and hashCode in LocalFilter in AT_Filter

* Update equals and hashCode in OrFilter and corresponding tests

* Update equals and hashCode in NotFilter and corresponding tests

* Fix typo in testEquals in AT_SimpleAttributeId

* Add assertFalse(partition1 == partition2) to testEquals in AT_Partition

* Fix typo in testEquals in AT_OrFilter

* Add tests to show input order does not matter in testEquals and testHashCode in AndFilter

* Add tests to show input order does not matter in testEquals and testHashCode in OrFilter

* Update equals and hashCode in PartitionsPluginData and corresponding tests

* Update equals and hashCode in AttributeFilter and corresponding tests

* Update equals and hashCode in FalseFilter and corresponding tests

* Update equals and hashCode in TrueFilter and corresponding tests

* Minor updates to equals and testEquals for FalseFilter, TrueFilter, and PartitionsPluginData

---------

Co-authored-by: shawnhatch <hatchs@leidos.com>

Author: travisrieglerleidos

simulation/src/main/java/gov/hhs/aspr/ms/gcm/simulation/plugins/partitions/datamanagers/PartitionsPluginData.java

@@ -1,5 +1,7 @@
 package gov.hhs.aspr.ms.gcm.simulation.plugins.partitions.datamanagers;
 
+import java.util.Objects;
+
 import gov.hhs.aspr.ms.gcm.simulation.nucleus.PluginData;
 import gov.hhs.aspr.ms.gcm.simulation.nucleus.PluginDataBuilder;
 import gov.hhs.aspr.ms.gcm.simulation.nucleus.StandardVersioning;
@@ -76,29 +78,31 @@ private Data(Data data) {
 			locked = data.locked;
 		}
 
+		/**
+    	 * Standard implementation consistent with the {@link #equals(Object)} method
+    	 */
 		@Override
 		public int hashCode() {
-
-			final int prime = 31;
-			int result = 1;
-			result = prime * result + (supportRunContinuity ? 1231 : 1237);
-			return result;
+			return Objects.hash(supportRunContinuity);
 		}
 
+		/**
+    	 * Two {@link Data} instances are equal if and only if
+    	 * their inputs are equal.
+    	 */
 		@Override
 		public boolean equals(Object obj) {
-
 			if (this == obj) {
 				return true;
 			}
-			if (!(obj instanceof Data)) {
+			if (obj == null) {
 				return false;
 			}
-			Data other = (Data) obj;
-			if (supportRunContinuity != other.supportRunContinuity) {
+			if (getClass() != obj.getClass()) {
 				return false;
 			}
-			return true;
+			Data other = (Data) obj;
+			return supportRunContinuity == other.supportRunContinuity;
 		}
 
 		@Override
@@ -157,27 +161,31 @@ public Builder toBuilder() {
 		return new Builder(data);
 	}
 
+	/**
+	 * Standard implementation consistent with the {@link #equals(Object)} method
+	 */
 	@Override
 	public int hashCode() {
-		final int prime = 31;
-		int result = 1;
-		result = prime * result + data.hashCode();
-		return result;
+		return Objects.hash(data);
 	}
 
+	/**
+	 * Two {@link PartitionsPluginData} instances are equal if and only if
+	 * their inputs are equal.
+	 */
 	@Override
 	public boolean equals(Object obj) {
 		if (this == obj) {
 			return true;
 		}
-		if (!(obj instanceof PartitionsPluginData)) {
+		if (obj == null) {
 			return false;
 		}
-		PartitionsPluginData other = (PartitionsPluginData) obj;
-		if (!data.equals(other.data)) {
+		if (getClass() != obj.getClass()) {
 			return false;
 		}
-		return true;
+		PartitionsPluginData other = (PartitionsPluginData) obj;
+		return Objects.equals(data, other.data);
 	}
 
 	@Override

simulation/src/main/java/gov/hhs/aspr/ms/gcm/simulation/plugins/partitions/support/LabelSet.java

@@ -4,6 +4,7 @@
 import java.util.LinkedHashMap;
 import java.util.LinkedHashSet;
 import java.util.Map;
+import java.util.Objects;
 import java.util.Optional;
 import java.util.Set;
 
@@ -28,29 +29,31 @@
  */
 public final class LabelSet {
 
+	/**
+	 * Standard implementation consistent with the {@link #equals(Object)} method
+	 */
 	@Override
 	public int hashCode() {
-		final int prime = 31;
-		int result = 1;
-		result = prime * result + ((data.labels == null) ? 0 : data.labels.hashCode());
-		return result;
+		return Objects.hash(data);
 	}
 
+	/**
+	 * Two {@link LabelSet} instances are equal if and only if
+	 * their inputs are equal.
+	 */
 	@Override
 	public boolean equals(Object obj) {
-		if (this == obj)
+		if (this == obj) {
 			return true;
-		if (obj == null)
+		}
+		if (obj == null) {
 			return false;
-		if (getClass() != obj.getClass())
+		}
+		if (getClass() != obj.getClass()) {
 			return false;
+		}
 		LabelSet other = (LabelSet) obj;
-		if (data.labels == null) {
-			if (other.data.labels != null)
-				return false;
-		} else if (!data.labels.equals(other.data.labels))
-			return false;
-		return true;
+		return Objects.equals(data, other.data);
 	}
 
 	/**
@@ -140,6 +143,33 @@ private Data(Data data) {
 			dimensions = Collections.unmodifiableSet(new LinkedHashSet<>(data.labels.keySet()));
 			locked = data.locked;
 		}
+
+		/**
+    	 * Standard implementation consistent with the {@link #equals(Object)} method
+    	 */
+		@Override
+		public int hashCode() {
+			return Objects.hash(labels, dimensions);
+		}
+
+		/**
+    	 * Two {@link Data} instances are equal if and only if
+    	 * their inputs are equal.
+    	 */
+		@Override
+		public boolean equals(Object obj) {
+			if (this == obj) {
+				return true;
+			}
+			if (obj == null) {
+				return false;
+			}
+			if (getClass() != obj.getClass()) {
+				return false;
+			}
+			Data other = (Data) obj;
+			return Objects.equals(labels, other.labels) && Objects.equals(dimensions, other.dimensions);
+		}
 	}
 
 	/**

simulation/src/main/java/gov/hhs/aspr/ms/gcm/simulation/plugins/partitions/support/Partition.java

@@ -3,6 +3,7 @@
 import java.util.LinkedHashMap;
 import java.util.LinkedHashSet;
 import java.util.Map;
+import java.util.Objects;
 import java.util.Optional;
 import java.util.Set;
 
@@ -176,44 +177,32 @@ private Data(Data data) {
 			locked = data.locked;
 		}
 
+		/**
+    	 * Standard implementation consistent with the {@link #equals(Object)} method
+    	 */
 		@Override
 		public int hashCode() {
-			final int prime = 31;
-			int result = 1;
-			result = prime * result + ((filter == null) ? 0 : filter.hashCode());
-			result = prime * result + ((labelers == null) ? 0 : labelers.hashCode());
-			result = prime * result + (retainPersonKeys ? 1231 : 1237);
-			return result;
+			return Objects.hash(retainPersonKeys, labelers, filter);
 		}
 
+		/**
+    	 * Two {@link Data} instances are equal if and only if
+    	 * their inputs are equal.
+    	 */
 		@Override
 		public boolean equals(Object obj) {
-
 			if (this == obj) {
 				return true;
 			}
-			if (!(obj instanceof Data)) {
+			if (obj == null) {
 				return false;
 			}
-			Data other = (Data) obj;
-			if (filter == null) {
-				if (other.filter != null) {
-					return false;
-				}
-			} else if (!filter.equals(other.filter)) {
+			if (getClass() != obj.getClass()) {
 				return false;
 			}
-			if (labelers == null) {
-				if (other.labelers != null) {
-					return false;
-				}
-			} else if (!labelers.equals(other.labelers)) {
-				return false;
-			}
-			if (retainPersonKeys != other.retainPersonKeys) {
-				return false;
-			}
-			return true;
+			Data other = (Data) obj;
+			return retainPersonKeys == other.retainPersonKeys && Objects.equals(labelers, other.labelers)
+					&& Objects.equals(filter, other.filter);
 		}
 
 		@Override
@@ -246,31 +235,31 @@ public Set<Labeler> getLabelers() {
 		return new LinkedHashSet<>(data.labelers.values());
 	}
 
+	/**
+	 * Standard implementation consistent with the {@link #equals(Object)} method
+	 */
 	@Override
 	public int hashCode() {
-		final int prime = 31;
-		int result = 1;
-		result = prime * result + ((data == null) ? 0 : data.hashCode());
-		return result;
+		return Objects.hash(data);
 	}
 
+	/**
+	 * Two {@link Partition} instances are equal if and only if
+	 * their inputs are equal.
+	 */
 	@Override
 	public boolean equals(Object obj) {
 		if (this == obj) {
 			return true;
 		}
-		if (!(obj instanceof Partition)) {
+		if (obj == null) {
 			return false;
 		}
-		Partition other = (Partition) obj;
-		if (data == null) {
-			if (other.data != null) {
-				return false;
-			}
-		} else if (!data.equals(other.data)) {
+		if (getClass() != obj.getClass()) {
 			return false;
 		}
-		return true;
+		Partition other = (Partition) obj;
+		return Objects.equals(data, other.data);
 	}
 
 	@Override

simulation/src/main/java/gov/hhs/aspr/ms/gcm/simulation/plugins/partitions/support/filters/AndFilter.java

@@ -69,11 +69,19 @@ public void validate(PartitionsContext partitionsContext) {
 		b.validate(partitionsContext);
 	}
 
+	/**
+	 * Standard implementation consistent with the {@link #equals(Object)} method
+	 */
 	@Override
 	public int hashCode() {
 		return a.hashCode() + b.hashCode();
 	}
 
+	/**
+	 * Two {@link AndFilter} instances are equal if and only if
+	 * their inputs are equal. The order in which inputs are added 
+	 * does not matter.
+	 */
 	@Override
 	public boolean equals(Object obj) {
 		if (this == obj) {

simulation/src/main/java/gov/hhs/aspr/ms/gcm/simulation/plugins/partitions/support/filters/FalseFilter.java

@@ -38,17 +38,26 @@ public void validate(PartitionsContext partitionsContext) {
 
 	}
 
+	/**
+     * Standard implementation consistent with the {@link #equals(Object)} method
+     */
 	@Override
 	public int hashCode() {
 		return 0;
 	}
 
+	/**
+     * All {@link FalseFilter} instances are considered equal
+     */
 	@Override
 	public boolean equals(Object obj) {
 		if (this == obj) {
 			return true;
 		}
-		if (!(obj instanceof FalseFilter)) {
+		if (obj == null) {
+			return false;
+		}
+		if (getClass() != obj.getClass()) {
 			return false;
 		}
 		return true;

simulation/src/main/java/gov/hhs/aspr/ms/gcm/simulation/plugins/partitions/support/filters/NotFilter.java

@@ -1,5 +1,6 @@
 package gov.hhs.aspr.ms.gcm.simulation.plugins.partitions.support.filters;
 
+import java.util.Objects;
 import java.util.Set;
 
 import gov.hhs.aspr.ms.gcm.simulation.plugins.partitions.support.FilterSensitivity;
@@ -54,27 +55,31 @@ public Set<FilterSensitivity<?>> getFilterSensitivities() {
 		return a.getFilterSensitivities();
 	}
 
+	/**
+	 * Standard implementation consistent with the {@link #equals(Object)} method
+	 */
 	@Override
 	public int hashCode() {
-		final int prime = 31;
-		int result = 1;
-		result = prime * result + a.hashCode();
-		return result;
+		return Objects.hash(a);
 	}
 
+	/**
+	 * Two {@link NotFilter} instances are equal if and only if
+	 * their inputs are equal.
+	 */
 	@Override
 	public boolean equals(Object obj) {
 		if (this == obj) {
 			return true;
 		}
-		if (!(obj instanceof NotFilter)) {
+		if (obj == null) {
 			return false;
 		}
-		NotFilter other = (NotFilter) obj;
-		if (!a.equals(other.a)) {
+		if (getClass() != obj.getClass()) {
 			return false;
 		}
-		return true;
+		NotFilter other = (NotFilter) obj;
+		return Objects.equals(a, other.a);
 	}
 
 }