Improve equals contract

core/src/main/java/gov/hhs/aspr/ms/taskit/core/engine/TaskitEngine.java

@@ -368,7 +368,7 @@ public final <T> ITranslationSpec getTranslationSpecForClass(Class<T> classRef)
 	}
 
 	/**
-	 * A hash code implementation consistent with equals().
+	 * Standard implementation consistent with the {@link #equals(Object)} method
 	 */
 	@Override
 	public int hashCode() {

core/src/main/java/gov/hhs/aspr/ms/taskit/core/engine/TaskitEngineData.java

@@ -302,29 +302,31 @@ public static Builder builder() {
 		return new Builder();
 	}
 
+	/**
+	 * Standard implementation consistent with the {@link #equals(Object)} method.
+	 * Note that we do not include the classToSpec map as part of the hash code
+	 * contract, as there is never a case where it would differ from the
+	 * translationSpec set, since both data structures get populated in the same
+	 * addTranslationSpec() method. The data structure that matters is the list of
+	 * translation specs, not the mapping, which only exists as a convenience map
+	 * for translation purposes.
+	 */
 	@Override
 	public int hashCode() {
-		/*
-		 * Note that we do not include the classToSpec map as part of the hash code
-		 * contract, as there is never a case where it would differ from the
-		 * translationSpec set, since both data structures get populated in the same
-		 * addTranslationSpec() method. The data structure that matters is the list of
-		 * translation specs, not the mapping, which only exists as a convenience map
-		 * for translation purposes
-		 */
 		return Objects.hash(translationSpecs);
 	}
 
+	/**
+	 * Two {@link TaskitEngineData} instances are equal if and only if
+	 * their translationSpecs are equal. Note that we do not include the classToSpec 
+	 * map as part of the equals contract, as there is never a case where it would 
+	 * differ from the translationSpec set, since both data structures get populated 
+	 * in the same addTranslationSpec() method. The data structure that matters is 
+	 * the list of translation specs, not the mapping, which only exists as a 
+	 * convenience map for translation purposes.
+	 */
 	@Override
 	public boolean equals(Object obj) {
-		/*
-		 * Note that we do not include the classToSpec map as part of the equals
-		 * contract, as there is never a case where it would differ from the
-		 * translationSpec set, since both data structures get populated in the same
-		 * addTranslationSpec() method. The data structure that matters is the list of
-		 * translation specs, not the mapping, which only exists as a convenience map
-		 * for translation purposes
-		 */
 		if (this == obj) {
 			return true;
 		}
@@ -333,7 +335,7 @@ public boolean equals(Object obj) {
 			return false;
 		}
 
-		if (!(obj instanceof TaskitEngineData)) {
+		if (getClass() != obj.getClass()) {
 			return false;
 		}
 

core/src/main/java/gov/hhs/aspr/ms/taskit/core/testsupport/engine/TestTaskitEngine.java

@@ -147,14 +147,4 @@ protected <I> I readFile(File file, Class<I> inputClassRef) throws IOException {
 
 		return this.gson.fromJson(jsonObject.toString(), inputClassRef);
 	}
-
-	@Override
-	public int hashCode() {
-		return super.hashCode();
-	}
-
-	@Override
-	public boolean equals(Object obj) {
-		return super.equals(obj);
-	}
 }

core/src/main/java/gov/hhs/aspr/ms/taskit/core/testsupport/objects/TestAppObject.java

@@ -4,7 +4,7 @@
 
 /**
  * Test class representing a class with various variables, including a Complex
- * class.
+ * class, and an enum.
  * <p>
  * <b>Should NOT</b> be used outside of testing.
  * </p>
@@ -97,11 +97,11 @@ public void setTestAppEnum(TestAppEnum testAppEnum) {
 	}
 
 	/**
-	 * Hash code implementation consistent with equals()
+	 * Standard implementation consistent with the {@link #equals(Object)} method
 	 */
 	@Override
 	public int hashCode() {
-		return Objects.hash(integer, bool, string, testComplexAppObject);
+		return Objects.hash(integer, bool, string, testComplexAppObject, testAppEnum);
 	}
 
 	/**
@@ -121,6 +121,6 @@ public boolean equals(Object obj) {
 		}
 		TestAppObject other = (TestAppObject) obj;
 		return integer == other.integer && bool == other.bool && Objects.equals(string, other.string)
-				&& Objects.equals(testComplexAppObject, other.testComplexAppObject);
+				&& Objects.equals(testComplexAppObject, other.testComplexAppObject) && testAppEnum == other.testAppEnum;
 	}
 }

core/src/main/java/gov/hhs/aspr/ms/taskit/core/testsupport/objects/TestComplexAppObject.java

@@ -63,7 +63,7 @@ public void setNumEntities(int numEntities) {
 	}
 
 	/**
-	 * Hash code implentation consistent with equals().
+	 * Standard implementation consistent with the {@link #equals(Object)} method
 	 */
 	@Override
 	public int hashCode() {

core/src/main/java/gov/hhs/aspr/ms/taskit/core/testsupport/objects/TestComplexInputObject.java

@@ -62,7 +62,7 @@ public void setNumEntities(int numEntities) {
 	}
 
 	/**
-	 * Hash code implementation consistent with equals().
+	 * Standard implementation consistent with the {@link #equals(Object)} method
 	 */
 	@Override
 	public int hashCode() {

core/src/main/java/gov/hhs/aspr/ms/taskit/core/testsupport/objects/TestInputEnum.java

@@ -0,0 +1,12 @@
+package gov.hhs.aspr.ms.taskit.core.testsupport.objects;
+
+/** 
+ * Complement enum to {@link TestAppEnum}.
+ * <p>
+ * <b>Should NOT</b> be used outside of testing.
+ * </p>
+ */
+public enum TestInputEnum {
+    TEST1,
+    TEST2
+}

core/src/main/java/gov/hhs/aspr/ms/taskit/core/testsupport/objects/TestInputObject.java

@@ -5,9 +5,6 @@
 /**
  * Complement class to {@link TestAppObject}
  * <p>
- * Note this class does not have an enum variable.
- * </p>
- * <p>
  * <b>Should NOT</b> be used outside of testing.
  * </p>
  */
@@ -16,6 +13,7 @@ public class TestInputObject {
 	private boolean bool;
 	private String string;
 	private TestComplexInputObject testComplexInputObject;
+	private TestInputEnum testInputEnum;
 
 	/**
 	 * @return value of the integer variable
@@ -82,16 +80,32 @@ public void setTestComplexInputObject(TestComplexInputObject testComplexInputObj
 	}
 
 	/**
-	 * Hash code implementation consistent with equals().
+	 * @return the value of the enum variable
+	 */
+	public TestInputEnum getTestInputEnum() {
+		return this.testInputEnum;
+	}
+
+	/**
+	 * Sets the value of the enum variable.
+	 * 
+	 * @param testInputEnum the value to set
+	 */
+	public void setTestInputEnum(TestInputEnum testInputEnum) {
+		this.testInputEnum = testInputEnum;
+	}
+
+	/**
+	 * Standard implementation consistent with the {@link #equals(Object)} method
 	 */
 	@Override
 	public int hashCode() {
-		return Objects.hash(integer, bool, string, testComplexInputObject);
+		return Objects.hash(integer, bool, string, testComplexInputObject, testInputEnum);
 	}
 
 	/**
 	 * Two {@link TestInputObject}s are equal if and only if their integers, bools,
-	 * strings, and testComplexInputObjects are equal.
+	 * strings, testComplexInputObjects, and testInputEnums are equal.
 	 */
 	@Override
 	public boolean equals(Object obj) {
@@ -106,7 +120,6 @@ public boolean equals(Object obj) {
 		}
 		TestInputObject other = (TestInputObject) obj;
 		return integer == other.integer && bool == other.bool && Objects.equals(string, other.string)
-				&& Objects.equals(testComplexInputObject, other.testComplexInputObject);
+				&& Objects.equals(testComplexInputObject, other.testComplexInputObject) && testInputEnum == other.testInputEnum;
 	}
-
 }

core/src/main/java/gov/hhs/aspr/ms/taskit/core/testsupport/objects/TestObjectWrapper.java

@@ -35,11 +35,11 @@ public void setWrappedObject(Object wrappedObject) {
 	}
 
 	/**
-	 * Hash code implementation consistent with equals().
+	 * Standard implementation consistent with the {@link #equals(Object)} method
 	 */
 	@Override
 	public int hashCode() {
-		return Objects.hashCode(wrappedObject);
+		return Objects.hash(wrappedObject);
 	}
 
 	/**