Package org.hamcrest.text

Class IsEqualCompressingWhiteSpace

java.lang.Object
org.hamcrest.BaseMatcher<String>
org.hamcrest.TypeSafeMatcher<String>
org.hamcrest.text.IsEqualCompressingWhiteSpace
All Implemented Interfaces:
Matcher<String>, SelfDescribing
public class IsEqualCompressingWhiteSpace extends TypeSafeMatcher<String>
Tests if a string is equal to another string, compressing any changes in whitespace.

  • Constructor Details

  • Method Details

    • getString

      protected String getString()
      Gets the string
      Returns:
      the string

    • matchesSafely

      public boolean matchesSafely(String item)
      Description copied from class: TypeSafeMatcher
      Check if the item matches. The item will already have been checked for the specific type and will never be null. Subclasses should implement this.
      Specified by:
      matchesSafely in class TypeSafeMatcher<String>
      Parameters:
      item - the type safe item to match against.
      Returns:
      boolean true/false depending if item matches matcher.

    • describeMismatchSafely

      public void describeMismatchSafely(String item, Description mismatchDescription)
      Description copied from class: TypeSafeMatcher
      Describe the mismatch. The item will already have been checked for the specific type and will never be null. Subclasses should override this.
      Overrides:
      describeMismatchSafely in class TypeSafeMatcher<String>
      Parameters:
      item - the type safe item to match against.
      mismatchDescription - the mismatch description.

    • describeTo

      public void describeTo(Description description)
      Description copied from interface: SelfDescribing
      Generates a description of the object. The description may be part of a description of a larger object of which this is just a component, so it should be worded appropriately.
      Parameters:
      description - The description to be built or appended to.

    • stripSpaces

      public String stripSpaces(String toBeStripped)
      Strips spaces
      Parameters:
      toBeStripped - the string to be stripped
      Returns:
      the stripped string

    • equalToIgnoringWhiteSpace

      public static Matcher<String> equalToIgnoringWhiteSpace(String expectedString)
      Deprecated.
      equalToCompressingWhiteSpace(String)
      Parameters:
      expectedString - the expected value of matched strings
      Returns:
      The matcher.

    • equalToCompressingWhiteSpace

      public static Matcher<String> equalToCompressingWhiteSpace(String expectedString)
      Creates a matcher of String that matches when the examined string is equal to the specified expectedString, when whitespace differences are (mostly) ignored. To be exact, the following whitespace rules are applied:
      • all leading and trailing whitespace of both the expectedString and the examined string are ignored
      • any remaining whitespace, appearing within either string, is collapsed to a single space before comparison
      For example: 
      assertThat("   my\tfoo  bar ", equalToCompressingWhiteSpace(" my  foo bar"))
      Parameters:
      expectedString - the expected value of matched strings
      Returns:
      The matcher.