applied the appendDescriptionOf method all over the place

nat.pryce · nat.pryce · commit 237b808e2357 · 2007-06-01T13:16:53.000Z
diff --git a/hamcrest-core/src/main/java/org/hamcrest/BaseDescription.java b/hamcrest-core/src/main/java/org/hamcrest/BaseDescription.java
@@ -84,7 +84,7 @@ private Description appendList(String start, String separator, String end, Itera
     }
 
 
-    /** Append the <var>str</var> to the description.  
+    /** Append the String <var>str</var> to the description.  
      *  The default implementation passes every character to {@link #append(char)}.  
      *  Override in subclasses to provide an efficient implementation.
      */
@@ -94,6 +94,8 @@ protected void append(String str) {
     	}
     }
     
+    /** Append the char <var>c</var> to the description.  
+     */
     protected abstract void append(char c);
 
     private void toJavaSyntax(String unformatted) {
diff --git a/hamcrest-core/src/main/java/org/hamcrest/StringDescription.java b/hamcrest-core/src/main/java/org/hamcrest/StringDescription.java
@@ -24,10 +24,8 @@ public StringDescription(Appendable out) {
      * @return
      *   The description of the object.
      */
-    public static String toString(SelfDescribing selfDescribing) {
-        StringDescription description = new StringDescription();
-        selfDescribing.describeTo(description);
-        return description.toString();
+    public static String toString(SelfDescribing value) {
+    	return new StringDescription().appendDescriptionOf(value).toString();
     }
 
     /**
@@ -37,7 +35,6 @@ public static String asString(SelfDescribing selfDescribing) {
         return toString(selfDescribing);
     }
 
-
     protected void append(String str) {
         try {
             out.append(str);
diff --git a/hamcrest-core/src/main/java/org/hamcrest/core/AllOf.java b/hamcrest-core/src/main/java/org/hamcrest/core/AllOf.java
@@ -29,17 +29,7 @@ public boolean matches(Object o) {
     }
 
     public void describeTo(Description description) {
-        description.appendText("(");
-        boolean seenFirst = false;
-        for (Matcher<? extends T> matcher : matchers) {
-            if (seenFirst) {
-                description.appendText(" and ");
-            } else {
-                seenFirst = true;
-            }
-            matcher.describeTo(description);
-        }
-        description.appendText(")");
+    	description.appendList("(", " and ", ")", matchers);
     }
 
     /**
diff --git a/hamcrest-core/src/main/java/org/hamcrest/core/AnyOf.java b/hamcrest-core/src/main/java/org/hamcrest/core/AnyOf.java
@@ -30,17 +30,7 @@ public boolean matches(Object o) {
     }
 
     public void describeTo(Description description) {
-        description.appendText("(");
-        boolean seenFirst = false;
-        for (Matcher<? extends T> matcher : matchers) {
-            if (seenFirst) {
-                description.appendText(" or ");
-            } else {
-                seenFirst = true;
-            }
-            matcher.describeTo(description);
-        }
-        description.appendText(")");
+    	description.appendList("(", " or ", ")", matchers);
     }
 
     /**
diff --git a/hamcrest-core/src/main/java/org/hamcrest/core/Is.java b/hamcrest-core/src/main/java/org/hamcrest/core/Is.java
@@ -27,10 +27,9 @@ public boolean matches(Object arg) {
     }
 
     public void describeTo(Description description) {
-        description.appendText("is ");
-        matcher.describeTo(description);
+        description.appendText("is ").appendDescriptionOf(matcher);
     }
-
+    
     /**
      * Decorates another Matcher, retaining the behavior but allowing tests
      * to be slightly more expressive.
diff --git a/hamcrest-core/src/main/java/org/hamcrest/core/IsNot.java b/hamcrest-core/src/main/java/org/hamcrest/core/IsNot.java
@@ -24,8 +24,7 @@ public boolean matches(Object arg) {
     }
 
     public void describeTo(Description description) {
-        description.appendText("not ");
-        matcher.describeTo(description);
+        description.appendText("not ").appendDescriptionOf(matcher);
     }
 
     /**
diff --git a/hamcrest-integration/src/main/java/org/hamcrest/MatcherAssert.java b/hamcrest-integration/src/main/java/org/hamcrest/MatcherAssert.java
@@ -11,10 +11,13 @@ public static <T> void assertThat(T actual, Matcher<T> matcher) {
     public static <T> void assertThat(String reason, T actual, Matcher<T> matcher) {
         if (!matcher.matches(actual)) {
             Description description = new StringDescription();
-            description.appendText(reason);
-            description.appendText("\nExpected: ");
-            matcher.describeTo(description);
-            description.appendText("\n     got: ").appendValue(actual).appendText("\n");
+            description.appendText(reason)
+                       .appendText("\nExpected: ")
+                       .appendDescriptionOf(matcher)
+                       .appendText("\n     got: ")
+                       .appendValue(actual)
+                       .appendText("\n");
+            
             throw new java.lang.AssertionError(description.toString());
         }
     }
diff --git a/hamcrest-integration/src/main/java/org/hamcrest/integration/EasyMock2Adapter.java b/hamcrest-integration/src/main/java/org/hamcrest/integration/EasyMock2Adapter.java
@@ -39,5 +39,4 @@ public boolean matches(Object argument) {
     public void appendTo(StringBuffer buffer) {
         hamcrestMatcher.describeTo(new StringDescription(buffer));
     }
-
 }
diff --git a/hamcrest-library/src/main/java/org/hamcrest/beans/HasPropertyWithValue.java b/hamcrest-library/src/main/java/org/hamcrest/beans/HasPropertyWithValue.java
@@ -102,7 +102,7 @@ public void describeTo(Description description) {
         description.appendText("hasProperty(");
         description.appendValue(propertyName);
         description.appendText(", ");
-        value.describeTo(description);
+        description.appendDescriptionOf(value);
         description.appendText(")");
     }
 
diff --git a/hamcrest-library/src/main/java/org/hamcrest/collection/IsArrayContaining.java b/hamcrest-library/src/main/java/org/hamcrest/collection/IsArrayContaining.java
@@ -24,8 +24,9 @@ public boolean matchesSafely(T[] array) {
     }
 
     public void describeTo(Description description) {
-        description.appendText("an array containing ");
-        elementMatcher.describeTo(description);
+        description
+        	.appendText("an array containing ")
+        	.appendDescriptionOf(elementMatcher);
     }
 
     @Factory
diff --git a/hamcrest-library/src/main/java/org/hamcrest/collection/IsCollectionContaining.java b/hamcrest-library/src/main/java/org/hamcrest/collection/IsCollectionContaining.java
@@ -27,8 +27,9 @@ public boolean matchesSafely(Iterable<T> collection) {
     }
 
     public void describeTo(Description description) {
-        description.appendText("a collection containing ");
-        elementMatcher.describeTo(description);
+        description
+        	.appendText("a collection containing ")
+        	.appendDescriptionOf(elementMatcher);
     }
 
     @Factory
diff --git a/hamcrest-library/src/main/java/org/hamcrest/collection/IsMapContaining.java b/hamcrest-library/src/main/java/org/hamcrest/collection/IsMapContaining.java
@@ -31,11 +31,11 @@ public boolean matchesSafely(Map<K, V> map) {
     }
 
     public void describeTo(Description description) {
-        description.appendText("map containing [");
-        keyMatcher.describeTo(description);
-        description.appendText("->");
-        valueMatcher.describeTo(description);
-        description.appendText("]");
+        description.appendText("map containing [")
+                   .appendDescriptionOf(keyMatcher)
+                   .appendText("->")
+			       .appendDescriptionOf(valueMatcher)
+			       .appendText("]");
     }
 
     @Factory
diff --git a/hamcrest-library/src/main/java/org/hamcrest/object/HasToString.java b/hamcrest-library/src/main/java/org/hamcrest/object/HasToString.java
@@ -18,9 +18,10 @@ public boolean matches(Object item) {
     }
 
     public void describeTo(Description description) {
-        description.appendText("asString(");
-        toStringMatcher.describeTo(description);
-        description.appendText(")");
+        description
+	        .appendText("asString(")
+	        .appendDescriptionOf(toStringMatcher)
+	        .appendText(")");
     }
     
     @Factory
diff --git a/hamcrest-library/src/main/java/org/hamcrest/xml/HasXPath.java b/hamcrest-library/src/main/java/org/hamcrest/xml/HasXPath.java
@@ -57,11 +57,10 @@ public boolean matchesSafely(Node item) {
     public void describeTo(Description description) {
         description.appendText("an XML document with XPath ").appendText(xpathString);
         if (valueMatcher != null) {
-            description.appendText(" ");
-            valueMatcher.describeTo(description);
+            description.appendText(" ").appendDescriptionOf(valueMatcher);
         }
     }
-
+    
     @Factory
     public static Matcher<Node> hasXPath(String xPath, Matcher<String> valueMatcher) {
         return new HasXPath(xPath, valueMatcher);
diff --git a/hamcrest-unit-test/src/main/java/org/hamcrest/AbstractMatcherTest.java b/hamcrest-unit-test/src/main/java/org/hamcrest/AbstractMatcherTest.java
@@ -24,7 +24,7 @@ public <T> void assertDoesNotMatch(String message, Matcher<T> c, T arg) {
 
     public void assertDescription(String expected, Matcher matcher) {
         Description description = new StringDescription();
-        matcher.describeTo(description);
+        description.appendDescriptionOf(matcher);
         assertEquals(expected, description.toString());
     }
 
diff --git a/hamcrest-unit-test/src/main/java/org/hamcrest/beans/HasPropertyWithValueTest.java b/hamcrest-unit-test/src/main/java/org/hamcrest/beans/HasPropertyWithValueTest.java
@@ -13,7 +13,6 @@
 import java.beans.SimpleBeanInfo;
 
 import org.hamcrest.AbstractMatcherTest;
-import org.hamcrest.Description;
 import org.hamcrest.Matcher;
 import org.hamcrest.StringDescription;
 
@@ -52,11 +51,9 @@ public void testDoesNotMatchWriteOnlyProperty() {
 
     public void testDescribeTo() {
         Matcher matcher = equalTo(true);
-        Description isEqualDescription = new StringDescription();
-        matcher.describeTo(isEqualDescription);
-
-        assertDescription("hasProperty(\"property\", " + isEqualDescription + ")",
-                hasProperty("property", matcher));
+        
+        assertDescription("hasProperty(\"property\", " + StringDescription.asString(matcher) + ")",
+                		  hasProperty("property", matcher));
     }
 
     public static class BeanWithoutInfo {
diff --git a/hamcrest-unit-test/src/main/java/org/hamcrest/object/HasToStringTest.java b/hamcrest-unit-test/src/main/java/org/hamcrest/object/HasToStringTest.java
@@ -1,15 +1,14 @@
 package org.hamcrest.object;
 
-import org.hamcrest.Description;
-import org.hamcrest.Matcher;
-import org.hamcrest.StringDescription;
-import org.hamcrest.AbstractMatcherTest;
-
 import static org.hamcrest.MatcherAssert.assertThat;
 import static org.hamcrest.core.IsEqual.equalTo;
 import static org.hamcrest.core.IsNot.not;
 import static org.hamcrest.object.HasToString.hasToString;
 
+import org.hamcrest.AbstractMatcherTest;
+import org.hamcrest.Matcher;
+import org.hamcrest.StringDescription;
+
 public class HasToStringTest extends AbstractMatcherTest {
 
     private static final String TO_STRING_RESULT = "toString result";
@@ -36,9 +35,6 @@ public void testHasReadableDescription() {
     }
 
     private String descriptionOf(Matcher matcher) {
-        Description description = new StringDescription();
-        matcher.describeTo(description);
-        return description.toString();
+    	return StringDescription.asString(matcher);
     }
-
 }

Original file line number	Diff line number	Diff line change
`@@ -84,7 +84,7 @@ private Description appendList(String start, String separator, String end, Itera`
`84`	`84`	`}`
`85`	`85`
`86`	`86`
`87`		`- /** Append the <var>str</var> to the description.`
	`87`	`+ /** Append the String <var>str</var> to the description.`
`88`	`88`	`* The default implementation passes every character to {@link #append(char)}.`
`89`	`89`	`* Override in subclasses to provide an efficient implementation.`
`90`	`90`	`*/`
`@@ -94,6 +94,8 @@ protected void append(String str) {`
`94`	`94`	`}`
`95`	`95`	`}`
`96`	`96`
	`97`	`+ /** Append the char <var>c</var> to the description.`
	`98`	`+ */`
`97`	`99`	`protected abstract void append(char c);`
`98`	`100`
`99`	`101`	`private void toJavaSyntax(String unformatted) {`
Original file line number	Diff line number	Diff line change
`@@ -27,10 +27,9 @@ public boolean matches(Object arg) {`
`27`	`27`	`}`
`28`	`28`
`29`	`29`	`public void describeTo(Description description) {`
`30`		`- description.appendText("is ");`
`31`		`- matcher.describeTo(description);`
	`30`	`+ description.appendText("is ").appendDescriptionOf(matcher);`
`32`	`31`	`}`
`33`		`-`
	`32`	`+`
`34`	`33`	`/**`
`35`	`34`	`* Decorates another Matcher, retaining the behavior but allowing tests`
`36`	`35`	`* to be slightly more expressive.`
Original file line number	Diff line number	Diff line change
`@@ -24,8 +24,7 @@ public boolean matches(Object arg) {`
`24`	`24`	`}`
`25`	`25`
`26`	`26`	`public void describeTo(Description description) {`
`27`		`- description.appendText("not ");`
`28`		`- matcher.describeTo(description);`
	`27`	`+ description.appendText("not ").appendDescriptionOf(matcher);`
`29`	`28`	`}`
`30`	`29`
`31`	`30`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -39,5 +39,4 @@ public boolean matches(Object argument) {`
`39`	`39`	`public void appendTo(StringBuffer buffer) {`
`40`	`40`	`hamcrestMatcher.describeTo(new StringDescription(buffer));`
`41`	`41`	`}`
`42`		`-`
`43`	`42`	`}`
Original file line number	Diff line number	Diff line change
`@@ -102,7 +102,7 @@ public void describeTo(Description description) {`
`102`	`102`	`description.appendText("hasProperty(");`
`103`	`103`	`description.appendValue(propertyName);`
`104`	`104`	`description.appendText(", ");`
`105`		`- value.describeTo(description);`
	`105`	`+ description.appendDescriptionOf(value);`
`106`	`106`	`description.appendText(")");`
`107`	`107`	`}`
`108`	`108`
Original file line number	Diff line number	Diff line change
`@@ -24,8 +24,9 @@ public boolean matchesSafely(T[] array) {`
`24`	`24`	`}`
`25`	`25`
`26`	`26`	`public void describeTo(Description description) {`
`27`		`- description.appendText("an array containing ");`
`28`		`- elementMatcher.describeTo(description);`
	`27`	`+ description`
	`28`	`+ .appendText("an array containing ")`
	`29`	`+ .appendDescriptionOf(elementMatcher);`
`29`	`30`	`}`
`30`	`31`
`31`	`32`	`@Factory`