Added null check to substring matching. Corrected javadoc.

sf105 · sf105 · commit 56c5bbb0ef05 · 2016-04-07T11:42:21.000+02:00
diff --git a/hamcrest-core/src/main/java/org/hamcrest/core/StringContains.java b/hamcrest-core/src/main/java/org/hamcrest/core/StringContains.java
@@ -33,7 +33,7 @@ public static Matcher<String> containsString(String substring) {
      * Creates a matcher that matches if the examined {@link String} contains the specified
      * {@link String} anywhere, ignoring case.
      * For example:
-     * <pre>assertThat("myStringOfNote", containsString("ring"))</pre>
+     * <pre>assertThat("myStringOfNote", containsStringIgnoringCase("Ring"))</pre>
      *
      * @param substring
      *     the substring that the returned matcher will expect to find within any examined string
diff --git a/hamcrest-core/src/main/java/org/hamcrest/core/StringEndsWith.java b/hamcrest-core/src/main/java/org/hamcrest/core/StringEndsWith.java
@@ -30,7 +30,7 @@ public static Matcher<String> endsWith(String suffix) {
      * Creates a matcher that matches if the examined {@link String} ends with the specified
      * {@link String}, ignoring case.
      * For example:
-     * <pre>assertThat("myStringOfNote", endsWith("Note"))</pre>
+     * <pre>assertThat("myStringOfNote", endsWithIgnoringCase("note"))</pre>
      *
      * @param suffix
      *      the substring that the returned matcher will expect at the end of any examined string
diff --git a/hamcrest-core/src/main/java/org/hamcrest/core/StringStartsWith.java b/hamcrest-core/src/main/java/org/hamcrest/core/StringStartsWith.java
@@ -30,7 +30,7 @@ public class StringStartsWith extends SubstringMatcher {
      * {@link String}, ignoring case
      * </p>
      * For example:
-     * <pre>assertThat("myStringOfNote", startsWith("my"))</pre>
+     * <pre>assertThat("myStringOfNote", startsWithIgnoringCase("My"))</pre>
      *
      * @param prefix
      *      the substring that the returned matcher will expect at the start of any examined string
diff --git a/hamcrest-core/src/main/java/org/hamcrest/core/SubstringMatcher.java b/hamcrest-core/src/main/java/org/hamcrest/core/SubstringMatcher.java
@@ -16,6 +16,9 @@ protected SubstringMatcher(String relationship, boolean ignoringCase, String sub
         this.relationship = relationship;
         this.ignoringCase = ignoringCase;
         this.substring = substring;
+        if (null == substring) {
+            throw new IllegalArgumentException("missing substring");
+        }
     }
 
     @Override
diff --git a/hamcrest-core/src/test/java/org/hamcrest/core/StringContainsTest.java b/hamcrest-core/src/test/java/org/hamcrest/core/StringContainsTest.java
@@ -40,4 +40,6 @@ public void testMatchesSubstringsIgnoringCase() {
         assertMismatchDescription("was \"Something else\"", ignoringCase, "Something else");
         assertDescription("a string containing \"ExCert\" ignoring case", ignoringCase);
     }
+
+
 }
diff --git a/hamcrest-core/src/test/java/org/hamcrest/core/StringMatchingTest.java b/hamcrest-core/src/test/java/org/hamcrest/core/StringMatchingTest.java
@@ -0,0 +1,35 @@
+package org.hamcrest.core;
+
+import org.junit.Rule;
+import org.junit.Test;
+import org.junit.rules.ExpectedException;
+
+import static org.hamcrest.core.StringContains.containsString;
+import static org.hamcrest.core.StringEndsWith.endsWith;
+import static org.hamcrest.core.StringStartsWith.startsWith;
+
+/**
+ * @author Steve Freeman 2016 http://www.hamcrest.com
+ */
+public class StringMatchingTest {
+  @Rule public final ExpectedException thrown = ExpectedException.none();
+
+  @Test public void
+  startsWithFailsWithNullSubstring() {
+    thrown.expect(IllegalArgumentException.class);
+    startsWith(null);
+  }
+
+  @Test public void
+  endWithFailsWithNullSubstring() {
+    thrown.expect(IllegalArgumentException.class);
+    endsWith(null);
+  }
+
+  @Test public void
+  containsFailsWithNullSubstring() {
+    thrown.expect(IllegalArgumentException.class);
+    containsString(null);
+  }
+
+}
diff --git a/hamcrest-library/src/main/java/org/hamcrest/Matchers.java b/hamcrest-library/src/main/java/org/hamcrest/Matchers.java
@@ -471,7 +471,7 @@ public static org.hamcrest.Matcher<java.lang.String> containsString(java.lang.St
    * Creates a matcher that matches if the examined {@link String} contains the specified
    * {@link String} anywhere, ignoring case.
    * For example:
-   * <pre>assertThat("myStringOfNote", containsString("ring"))</pre>
+   * <pre>assertThat("myStringOfNote", containsStringIgnoringCase("Ring"))</pre>
    * 
    * @param substring
    *     the substring that the returned matcher will expect to find within any examined string
@@ -501,7 +501,7 @@ public static org.hamcrest.Matcher<java.lang.String> startsWith(java.lang.String
    * {@link String}, ignoring case
    * </p>
    * For example:
-   * <pre>assertThat("myStringOfNote", startsWith("my"))</pre>
+   * <pre>assertThat("myStringOfNote", startsWithIgnoringCase("My"))</pre>
    * 
    * @param prefix
    *      the substring that the returned matcher will expect at the start of any examined string
@@ -527,7 +527,7 @@ public static org.hamcrest.Matcher<java.lang.String> endsWith(java.lang.String s
    * Creates a matcher that matches if the examined {@link String} ends with the specified
    * {@link String}, ignoring case.
    * For example:
-   * <pre>assertThat("myStringOfNote", endsWith("Note"))</pre>
+   * <pre>assertThat("myStringOfNote", endsWithIgnoringCase("note"))</pre>
    * 
    * @param suffix
    *      the substring that the returned matcher will expect at the end of any examined string
@@ -1633,4 +1633,5 @@ public static org.hamcrest.Matcher<org.w3c.dom.Node> hasXPath(java.lang.String x
     return org.hamcrest.xml.HasXPath.hasXPath(xPath, namespaceContext);
   }
 
+
 }

Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@ public static Matcher<String> containsString(String substring) {`
`33`	`33`	`* Creates a matcher that matches if the examined {@link String} contains the specified`
`34`	`34`	`* {@link String} anywhere, ignoring case.`
`35`	`35`	`* For example:`
`36`		`- * <pre>assertThat("myStringOfNote", containsString("ring"))</pre>`
	`36`	`+ * <pre>assertThat("myStringOfNote", containsStringIgnoringCase("Ring"))</pre>`
`37`	`37`	`*`
`38`	`38`	`* @param substring`
`39`	`39`	`* the substring that the returned matcher will expect to find within any examined string`
Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ public static Matcher<String> endsWith(String suffix) {`
`30`	`30`	`* Creates a matcher that matches if the examined {@link String} ends with the specified`
`31`	`31`	`* {@link String}, ignoring case.`
`32`	`32`	`* For example:`
`33`		`- * <pre>assertThat("myStringOfNote", endsWith("Note"))</pre>`
	`33`	`+ * <pre>assertThat("myStringOfNote", endsWithIgnoringCase("note"))</pre>`
`34`	`34`	`*`
`35`	`35`	`* @param suffix`
`36`	`36`	`* the substring that the returned matcher will expect at the end of any examined string`
Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ public class StringStartsWith extends SubstringMatcher {`
`30`	`30`	`* {@link String}, ignoring case`
`31`	`31`	`* </p>`
`32`	`32`	`* For example:`
`33`		`- * <pre>assertThat("myStringOfNote", startsWith("my"))</pre>`
	`33`	`+ * <pre>assertThat("myStringOfNote", startsWithIgnoringCase("My"))</pre>`
`34`	`34`	`*`
`35`	`35`	`* @param prefix`
`36`	`36`	`* the substring that the returned matcher will expect at the start of any examined string`
Original file line number	Diff line number	Diff line change
`@@ -16,6 +16,9 @@ protected SubstringMatcher(String relationship, boolean ignoringCase, String sub`
`16`	`16`	`this.relationship = relationship;`
`17`	`17`	`this.ignoringCase = ignoringCase;`
`18`	`18`	`this.substring = substring;`
	`19`	`+ if (null == substring) {`
	`20`	`+ throw new IllegalArgumentException("missing substring");`
	`21`	`+ }`
`19`	`22`	`}`
`20`	`23`
`21`	`24`	`@Override`
Original file line number	Diff line number	Diff line change
`@@ -40,4 +40,6 @@ public void testMatchesSubstringsIgnoringCase() {`
`40`	`40`	`assertMismatchDescription("was \"Something else\"", ignoringCase, "Something else");`
`41`	`41`	`assertDescription("a string containing \"ExCert\" ignoring case", ignoringCase);`
`42`	`42`	`}`
	`43`	`+`
	`44`	`+`
`43`	`45`	`}`
Original file line number	Diff line number	Diff line change
`@@ -471,7 +471,7 @@ public static org.hamcrest.Matcher<java.lang.String> containsString(java.lang.St`
`471`	`471`	`* Creates a matcher that matches if the examined {@link String} contains the specified`
`472`	`472`	`* {@link String} anywhere, ignoring case.`
`473`	`473`	`* For example:`
`474`		`- * <pre>assertThat("myStringOfNote", containsString("ring"))</pre>`
	`474`	`+ * <pre>assertThat("myStringOfNote", containsStringIgnoringCase("Ring"))</pre>`
`475`	`475`	`*`
`476`	`476`	`* @param substring`
`477`	`477`	`* the substring that the returned matcher will expect to find within any examined string`
`@@ -501,7 +501,7 @@ public static org.hamcrest.Matcher<java.lang.String> startsWith(java.lang.String`
`501`	`501`	`* {@link String}, ignoring case`
`502`	`502`	`* </p>`
`503`	`503`	`* For example:`
`504`		`- * <pre>assertThat("myStringOfNote", startsWith("my"))</pre>`
	`504`	`+ * <pre>assertThat("myStringOfNote", startsWithIgnoringCase("My"))</pre>`
`505`	`505`	`*`
`506`	`506`	`* @param prefix`
`507`	`507`	`* the substring that the returned matcher will expect at the start of any examined string`
`@@ -527,7 +527,7 @@ public static org.hamcrest.Matcher<java.lang.String> endsWith(java.lang.String s`
`527`	`527`	`* Creates a matcher that matches if the examined {@link String} ends with the specified`
`528`	`528`	`* {@link String}, ignoring case.`
`529`	`529`	`* For example:`
`530`		`- * <pre>assertThat("myStringOfNote", endsWith("Note"))</pre>`
	`530`	`+ * <pre>assertThat("myStringOfNote", endsWithIgnoringCase("note"))</pre>`
`531`	`531`	`*`
`532`	`532`	`* @param suffix`
`533`	`533`	`* the substring that the returned matcher will expect at the end of any examined string`
`@@ -1633,4 +1633,5 @@ public static org.hamcrest.Matcher<org.w3c.dom.Node> hasXPath(java.lang.String x`
`1633`	`1633`	`return org.hamcrest.xml.HasXPath.hasXPath(xPath, namespaceContext);`
`1634`	`1634`	`}`
`1635`	`1635`
	`1636`	`+`
`1636`	`1637`	`}`