Address issue 101 (on google code issue tracker) - Add theInstance() alias for sameInstance() factory

scarytom · scarytom · commit 8f8924a9492b · 2012-05-20T09:31:18.000+01:00
diff --git a/hamcrest-core/src/main/java/org/hamcrest/core/IsSame.java b/hamcrest-core/src/main/java/org/hamcrest/core/IsSame.java
@@ -31,13 +31,26 @@ public void describeTo(Description description) {
     }
     
     /**
-     * Creates a new instance of IsSame
+     * Creates a matcher that evaluates to true only when the examined object is the
+     * same instance as the specified target object.
      *
-     * @param object The predicate evaluates to true only when the argument is
-     *               this object.
+     * @param target
+     *     the target instance against which others should be assessed
      */
     @Factory
-    public static <T> Matcher<T> sameInstance(T object) {
-        return new IsSame<T>(object);
+    public static <T> Matcher<T> sameInstance(T target) {
+        return new IsSame<T>(target);
+    }
+    
+    /**
+     * Creates a matcher that evaluates to true only when the examined object is the
+     * same instance as the specified target object.
+     *
+     * @param target
+     *     the target instance against which others should be assessed
+     */
+    @Factory
+    public static <T> Matcher<T> theInstance(T target) {
+        return new IsSame<T>(target);
     }
 }
diff --git a/hamcrest-unit-test/src/main/java/org/hamcrest/core/IsSameTest.java b/hamcrest-unit-test/src/main/java/org/hamcrest/core/IsSameTest.java
@@ -2,6 +2,7 @@
  */
 package org.hamcrest.core;
 
+import static org.hamcrest.core.IsSame.theInstance;
 import static org.hamcrest.core.IsSame.sameInstance;
 import static org.hamcrest.core.IsNot.not;
 import org.hamcrest.AbstractMatcherTest;
@@ -24,6 +25,14 @@ public void testEvaluatesToTrueIfArgumentIsReferenceToASpecifiedObject() {
         assertThat(o2, not(sameInstance(o1)));
     }
 
+    public void testAlternativeFactoryMethodAlsoMatchesOnlyIfArgumentIsReferenceToASpecifiedObject() {
+        Object o1 = new Object();
+        Object o2 = new Object();
+        
+        assertThat(o1, theInstance(o1));
+        assertThat(o2, not(theInstance(o1)));
+    }
+
     public void testReturnsReadableDescriptionFromToString() {
         assertDescription("sameInstance(\"ARG\")", sameInstance("ARG"));
     }
