Fixed: equals()/hashCode() bug

AbstractKeyword equals() and hashCode() do not consider userData
#1

Author: faseidl

mensa/pom.xml

@@ -3,7 +3,7 @@
 	<modelVersion>4.0.0</modelVersion>
 	<groupId>com.dell.mensa</groupId>
 	<artifactId>mensa</artifactId>
-	<version>1.0.0</version>
+	<version>1.0.1</version>
 	<name>Mensa</name>
 	<description>Mensa is a generic, flexible, enhanced, and efficient Java implementation of a pattern matching state machine as described by the 1975 paper by Alfred Aho and Margaret Corasick.</description>
 	<organization>

mensa/src/main/java/com/dell/mensa/impl/generic/AbstractKeyword.java

@@ -132,6 +132,9 @@ public int hashCode()
 		result = prime * result + (isCaseSensitive() ? 1231 : 1237);
 		result = prime * result + (isPunctuationSensitive() ? 1231 : 1237);
 
+		final Object userData = getUserData();
+		result = prime * result + (userData == null ? 0 : userData.hashCode());
+
 		final int length = length();
 		for (int i = 0; i < length; i++)
 		{
@@ -178,6 +181,24 @@ public boolean equals(final Object object_)
 			return false;
 		}
 
+		final Object userData = getUserData();
+		final Object otherUserData = other.getUserData();
+
+		if (userData == null)
+		{
+			if (otherUserData != null)
+			{
+				return false;
+			}
+		}
+		else
+		{
+			if (!userData.equals(otherUserData))
+			{
+				return false;
+			}
+		}
+
 		final int length = length();
 		if (length != other.length())
 		{

mensa/src/test/java/com/dell/mensa/impl/generic/KeywordAndCharacterKeywordTest.java

@@ -313,4 +313,45 @@ public void testEqualsObject()
 			}
 		}
 	}
+
+	/**
+	 * Test code for <a href="https://github.com/dell-oss/Mensa/issues/1">issue #1</a>:
+	 * AbstractKeyword equals() and hashCode() do not consider userData
+	 */
+	@SuppressWarnings("static-method")
+	@Test
+	public void testIssue_1_equals()
+	{
+		final String userData = "myData";
+
+		final IKeyword<Character> a = new Keyword<>(HE);
+		final IKeyword<Character> au = new Keyword<>(HE, userData);
+		final IKeyword<Character> b = new CharacterKeyword(STR_HE);
+		final IKeyword<Character> bu = new CharacterKeyword(STR_HE, userData);
+
+		Assert.assertTrue(a.equals(a));
+		Assert.assertFalse(a.equals(au));
+		Assert.assertTrue(a.equals(b));
+		Assert.assertFalse(a.equals(bu));
+
+		Assert.assertFalse(au.equals(a));
+		Assert.assertTrue(au.equals(au));
+		Assert.assertFalse(au.equals(b));
+		Assert.assertTrue(au.equals(bu));
+
+		Assert.assertTrue(b.equals(a));
+		Assert.assertFalse(b.equals(au));
+		Assert.assertTrue(b.equals(b));
+		Assert.assertFalse(b.equals(bu));
+
+		Assert.assertFalse(bu.equals(a));
+		Assert.assertTrue(bu.equals(au));
+		Assert.assertFalse(bu.equals(b));
+		Assert.assertTrue(bu.equals(bu));
+		
+		Assert.assertEquals(a.hashCode(), a.hashCode());
+		Assert.assertEquals(a.hashCode(), b.hashCode());
+		Assert.assertEquals(au.hashCode(), au.hashCode());
+		Assert.assertEquals(au.hashCode(), bu.hashCode());
+	}
 }