Package org.assertj.core.api

Class AbstractCharSequenceAssert<SELF extends AbstractCharSequenceAssert<SELF,​ACTUAL>,​ACTUAL extends CharSequence>

    • Constructor Detail

      • AbstractCharSequenceAssert

        public AbstractCharSequenceAssert​(ACTUAL actual,
                                  Class<?> selfType)

    • Method Detail

      • isNullOrEmpty

        public void isNullOrEmpty()
        Verifies that the actual CharSequence is empty, i.e., it has a length of 0, or is null.

        If you do not want to accept a null value, use isEmpty() instead.

        Both of these assertions will succeed: 

         String emptyString = ""
 assertThat(emptyString).isNullOrEmpty();
 
 String nullString = null;
 assertThat(nullString).isNullOrEmpty();
        Whereas these assertions will fail: 
         assertThat("a").isNullOrEmpty();
 assertThat("   ").isNullOrEmpty();
        Specified by:
        isNullOrEmpty in interface EnumerableAssert<SELF extends AbstractCharSequenceAssert<SELF,​ACTUAL>,​ACTUAL extends CharSequence>
        Throws:
        AssertionError - if the actual CharSequence has a non-zero length.

      • isEmpty

        public void isEmpty()
        Verifies that the actual CharSequence is empty, i.e., it has a length of 0 and is not null.

        If you want to accept a null value as well as a 0 length, use isNullOrEmpty() instead.

        This assertion will succeed: 

         String emptyString = ""
 assertThat(emptyString).isEmpty();
        Whereas these assertions will fail: 
         String nullString = null;
 assertThat(nullString).isEmpty();
 assertThat("a").isEmpty();
 assertThat("   ").isEmpty();
        Specified by:
        isEmpty in interface EnumerableAssert<SELF extends AbstractCharSequenceAssert<SELF,​ACTUAL>,​ACTUAL extends CharSequence>
        Throws:
        AssertionError - if the actual CharSequence has a non-zero length or is null.

      • isNotEmpty

        public SELF isNotEmpty()
        Verifies that the actual CharSequence is not empty, i.e., is not null and has a length of 1 or more.

        This assertion will succeed: 

         String bookName = "A Game of Thrones"
 assertThat(bookName).isNotEmpty();
        Whereas these assertions will fail: 
         String emptyString = ""
 assertThat(emptyString).isNotEmpty();
 
 String nullString = null;
 assertThat(nullString).isNotEmpty();
        Specified by:
        isNotEmpty in interface EnumerableAssert<SELF extends AbstractCharSequenceAssert<SELF,​ACTUAL>,​ACTUAL extends CharSequence>
        Returns:
        this assertion object.
        Throws:
        AssertionError - if the actual CharSequence is empty (has a length of 0).

      • isBlank

        public SELF isBlank()
        Verifies that the actual CharSequence is blank, i.e. is not null or empty and contains only whitespace characters.

        The whitespace definition used in this assertion follows the latest Unicode standard (which is not the same as Java whitespace definition) and is based on Guava CharMatcher#whitespace. If you want to stick with Java whitespace definition, use isJavaBlank().

        These assertions will succeed: 

         assertThat(" ").isBlank();
 assertThat("     ").isBlank();
        Whereas these assertions will fail: 
         assertThat("a").isBlank();
 assertThat(" b").isBlank();
 assertThat("").isBlank();
 String nullString = null;
 assertThat(nullString).isNotBlank();
        Returns:
        this assertion object.
        Throws:
        AssertionError - if the actual CharSequence is not blank.
        Since:
        2.6.0 / 3.6.0

      • isNotBlank

        public SELF isNotBlank()
        Verifies that the actual CharSequence is not blank, i.e. either is null, empty or contains at least one whitespace characters.

        It uses the same whitespace definition as in isBlank() assertion.

        These assertion will succeed: 

         assertThat("a").isNotBlank();
 assertThat(" b").isNotBlank();
 assertThat(" c ").isNotBlank();
 assertThat("").isNotBlank();
 String nullString = null;
 assertThat(nullString).isNotBlank();
        Whereas these assertions will fail: 
         assertThat(" ").isNotBlank();
 assertThat("    ").isNotBlank();
        Returns:
        this assertion object.
        Throws:
        AssertionError - if the actual CharSequence is blank.
        Since:
        2.6.0 / 3.6.0

      • isJavaBlank

        public SELF isJavaBlank()
        Verifies that the actual CharSequence is blank, i.e. it contains only whitespace characters (according to Character.isWhitespace(char)).

        If you want to use the latest Unicode standard whitespace definition (as in Guava), use isBlank(), see Guava explanation for more details.

        These assertions will succeed: 

         assertThat(" ").isBlank();
 assertThat("     ").isBlank();
        Whereas these assertions will fail: 
         assertThat("a").isBlank();
 assertThat(" b").isBlank();
 assertThat("").isBlank(); 
 String nullString = null;
 assertThat(nullString).isBlank();
        Returns:
        this assertion object.
        Throws:
        AssertionError - if the actual CharSequence is not blank.
        Since:
        2.6.0 / 3.6.0

      • isNotJavaBlank

        public SELF isNotJavaBlank()
        Verifies that the actual CharSequence is not blank, i.e. either is null, empty or contains at least one whitespace characters (according to Character.isWhitespace(char)).

        It uses the same whitespace definition as in isJavaBlank() assertion.

        These assertion will succeed: 

         assertThat("a").isNotBlank();
 assertThat(" b").isNotBlank();
 assertThat(" c ").isNotBlank();
 assertThat("").isNotBlank();
 String nullString = null;
 assertThat(nullString).isNotBlank();
        Whereas these assertions will fail: 
         assertThat(" ").isNotBlank();
 assertThat("   ").isNotBlank();
        Returns:
        this assertion object.
        Throws:
        AssertionError - if the actual CharSequence is blank.
        Since:
        2.6.0 / 3.6.0

      • hasSize

        public SELF hasSize​(int expected)
        Verifies that the actual CharSequence has the expected length using the length() method.

        This assertion will succeed: 

         String bookName = "A Game of Thrones"
 assertThat(bookName).hasSize(17);
        Whereas this assertion will fail: 
         String bookName = "A Clash of Kings"
 assertThat(bookName).hasSize(4);
        Specified by:
        hasSize in interface EnumerableAssert<SELF extends AbstractCharSequenceAssert<SELF,​ACTUAL>,​ACTUAL extends CharSequence>
        Parameters:
        expected - the expected length of the actual CharSequence.
        Returns:
        this assertion object.
        Throws:
        AssertionError - if the actual length is not equal to the expected length.

      • hasLineCount

        public SELF hasLineCount​(int expectedLineCount)
        Verifies that the actual CharSequence has the expected line count.

        A line is considered to be terminated by any one of a line feed ('\n'), a carriage return ('\r'), or a carriage return followed immediately by a linefeed (see LineNumberReader).

        This assertion will succeed: 

         String multiLine = "First line\n" +
                    "Last line";
 assertThat(multiLine).hasLineCount(2);
        Whereas this assertion will fail: 
         String bookName = "A Clash of Kings";
 assertThat(bookName).hasLineCount(3);
        Parameters:
        expectedLineCount - the expected line count of the actual CharSequence.
        Returns:
        this assertion object.
        Throws:
        AssertionError - if the actual line count is not equal to the expected one.

      • hasSameSizeAs

        public SELF hasSameSizeAs​(CharSequence other)
        Verifies that the actual CharSequence has a length that's the same as the length of the given CharSequence.

        Examples : 

         // assertion will pass
 assertThat("C-3PO").hasSameSizeAs("R2-D2");
 
 // assertion will fail as actual and expected sizes differ
 assertThat("C-3PO").hasSameSizeAs("B1 battle droid");
        Parameters:
        other - the given CharSequence to be used for size comparison.
        Returns:
        this assertion object.
        Throws:
        AssertionError - if the actual CharSequence has a length that's different from the length of the given CharSequence.
        NullPointerException - if the given CharSequence is null.

      • hasSameSizeAs

        public SELF hasSameSizeAs​(Object other)
        Verifies that the actual CharSequence has a length that's the same as the number of elements in the given array.

        Example: 

         // assertion will pass
 assertThat("12").hasSameSizeAs(new char[] { 'a', 'b' });
 
 // assertion will fail
 assertThat("12").hasSameSizeAs(new char[] { 'a', 'b', 'c' });
        Specified by:
        hasSameSizeAs in interface EnumerableAssert<SELF extends AbstractCharSequenceAssert<SELF,​ACTUAL>,​ACTUAL extends CharSequence>
        Parameters:
        other - the given array to be used for size comparison.
        Returns:
        this assertion object.
        Throws:
        AssertionError - if the actual CharSequence has a length that's different from the number of elements in the array.
        NullPointerException - if the given array is null.

      • hasSameSizeAs

        public SELF hasSameSizeAs​(Iterable<?> other)
        Verifies that the actual CharSequence has a length that's the same as the number of elements in the given Iterable.

        Example: 

         // assertion will pass
 assertThat("abc").hasSameSizeAs(Arrays.asList(1, 2, 3));
 
 // assertion will fail
 assertThat("ab").hasSameSizeAs(Arrays.asList(1, 2, 3));
        Specified by:
        hasSameSizeAs in interface EnumerableAssert<SELF extends AbstractCharSequenceAssert<SELF,​ACTUAL>,​ACTUAL extends CharSequence>
        Parameters:
        other - the given Iterable to be used for size comparison.
        Returns:
        this assertion object.
        Throws:
        AssertionError - if the actual CharSequence has a length that's different from the number of elements in the Iterable.
        NullPointerException - if the given Iterable is null.

      • isEqualToIgnoringCase

        public SELF isEqualToIgnoringCase​(CharSequence expected)
        Verifies that the actual CharSequence is equal to the given one, ignoring case considerations.

        Example : 

         // assertion will pass
 assertThat("Gandalf the grey").isEqualToIgnoringCase("GaNdAlF tHe GREY");
 assertThat("Gandalf the grey").isEqualToIgnoringCase("Gandalf the grey");
 
 // assertion will fail
 assertThat("Gandalf the grey").isEqualToIgnoringCase("Gandalf the white");
        Parameters:
        expected - the given CharSequence to compare the actual CharSequence to.
        Returns:
        this assertion object.
        Throws:
        AssertionError - if the actual CharSequence is not equal to the given one.

      • isNotEqualToIgnoringCase

        public SELF isNotEqualToIgnoringCase​(CharSequence expected)
        Verifies that the actual CharSequence is not equal to the given one, ignoring case considerations.

        Example : 

         // assertions will pass
 assertThat("Gandalf").isNotEqualToIgnoringCase("Hobbit");
 assertThat("Gandalf").isNotEqualToIgnoringCase("HOBit");
 assertThat((String)null).isNotEqualToIgnoringCase("Gandalf");
 assertThat("Gandalf").isNotEqualToIgnoringCase(null);

 // assertions will fail
 assertThat("Gandalf").isNotEqualToIgnoringCase("Gandalf");
 assertThat("Gandalf").isNotEqualToIgnoringCase("GaNDalf");
 assertThat((String)null).isNotEqualToIgnoringCase(null);
        Parameters:
        expected - the given CharSequence to compare the actual CharSequence to.
        Returns:
        this assertion object.
        Throws:
        AssertionError - if the actual CharSequence is not equal to the given one.

      • containsOnlyDigits

        public SELF containsOnlyDigits()
        Verifies that the actual CharSequence contains only digits. It fails if it contains non-digit characters or is empty.

        This assertion succeeds: 

         assertThat("10").containsOnlyDigits();
        Whereas this assertion fails: 
         assertThat("10$").containsOnlyDigits();
 assertThat("").containsOnlyDigits();
        Returns:
        this assertion object.
        Throws:
        AssertionError - if the actual CharSequence contains non-digit characters or is null.

      • containsOnlyOnce

        public SELF containsOnlyOnce​(CharSequence sequence)
        Verifies that the actual CharSequence contains the given sequence only once.

        Example : 

         // assertion will pass
 assertThat("Frodo").containsOnlyOnce("do");
 
 // assertions will fail
 assertThat("Frodo").containsOnlyOnce("o");
 assertThat("Frodo").containsOnlyOnce("y");
        Parameters:
        sequence - the sequence to search for.
        Returns:
        this assertion object.
        Throws:
        AssertionError - if the actual CharSequence either does not contain the given one at all, or contains it more than once.

      • contains

        public SELF contains​(CharSequence... values)
        Verifies that the actual CharSequence contains all the given values.

        You can use one or several CharSequences as in this example: 

         assertThat("Gandalf the grey").contains("alf");
 assertThat("Gandalf the grey").contains("alf", "grey");
        Parameters:
        values - the Strings to look for.
        Returns:
        this assertion object.
        Throws:
        NullPointerException - if the given list of values is null.
        IllegalArgumentException - if the list of given values is empty.
        AssertionError - if the actual CharSequence is null.
        AssertionError - if the actual CharSequence does not contain all the given strings.

      • contains

        public SELF contains​(Iterable<? extends CharSequence> values)
        Verifies that the actual CharSequence contains all the CharSequences of the given Iterable.

        Examples: 

         assertThat("Gandalf the grey").contains(Arrays.asList("alf"));
 assertThat("Gandalf the grey").contains(Arrays.asList("alf", "grey"));
        Parameters:
        values - the Strings to look for.
        Returns:
        this assertion object.
        Throws:
        NullPointerException - if the given list of values is null.
        IllegalArgumentException - if the list of given values is empty.
        AssertionError - if the actual CharSequence is null.
        AssertionError - if the actual CharSequence does not contain all the given strings.

      • containsSequence

        public SELF containsSequence​(CharSequence... values)
        Verifies that the actual CharSequence contains all the given values in the given order.

        Note that unlike IterableAssert.containsSequence(Object...), the assertion will succeed when there are values between the expected sequence values.

        Example: 

         String book = "{ 'title':'A Game of Thrones', 'author':'George Martin'}";
 
 // this assertions succeeds
 assertThat(book).containsSequence("'title'", ":", "'A Game of Thrones'");
 
 // this one too even if there are values between the expected sequence (e.g "'title':'") 
 assertThat(book).containsSequence("{", "A Game of Thrones", "George Martin", "}");
 
 // this one fails as "author" must come after "A Game of Thrones"
 assertThat(book).containsSequence("{", "author", "A Game of Thrones", "}");
        Parameters:
        values - the Strings to look for, in order.
        Returns:
        this assertion object.
        Throws:
        NullPointerException - if the given values is null.
        IllegalArgumentException - if the given values is empty.
        AssertionError - if the actual CharSequence is null.
        AssertionError - if the actual CharSequence does not contain all the given strings in the given order.

      • containsSequence

        public SELF containsSequence​(Iterable<? extends CharSequence> values)
        Verifies that the actual CharSequence contains all the values of the given Iterable in the Iterable iteration order.

        Note that unlike IterableAssert.containsSequence(Object...), the assertion will succeed when there are values between the expected sequence values.

        Example: 

         String book = "{ 'title':'A Game of Thrones', 'author':'George Martin'}";

 // this assertion succeeds
 assertThat(book).containsSequence(asList("{", "title", "A Game of Thrones", "}"));
 
 // this one too even if there are values between the expected sequence (e.g "'title':'") 
 assertThat(book).containsSequence(asList("{", "A Game of Thrones", "George Martin", "}"));

 // but this one fails as "author" must come after "A Game of Thrones"
 assertThat(book).containsSequence(asList("{", "author", "A Game of Thrones", "}"));
        Parameters:
        values - the Strings to look for, in order.
        Returns:
        this assertion object.
        Throws:
        NullPointerException - if the given values is null.
        IllegalArgumentException - if the given values is empty.
        AssertionError - if the actual CharSequence is null.
        AssertionError - if the actual CharSequence does not contain all the given strings in the given order.

      • containsIgnoringCase

        public SELF containsIgnoringCase​(CharSequence sequence)
        Verifies that the actual CharSequence contains the given sequence, ignoring case considerations.

        Example : 

         // assertion will pass
 assertThat("Gandalf the grey").containsIgnoringCase("gandalf");
 
 // assertion will fail
 assertThat("Gandalf the grey").containsIgnoringCase("white");
        Parameters:
        sequence - the sequence to search for.
        Returns:
        this assertion object.
        Throws:
        NullPointerException - if the given sequence is null.
        AssertionError - if the actual CharSequence is null.
        AssertionError - if the actual CharSequence does not contain the given one.

      • doesNotContain

        public SELF doesNotContain​(CharSequence sequence)
        Verifies that the actual CharSequence does not contain the given sequence.

        Example : 

         // assertion will pass
 assertThat("Frodo").doesNotContain("fro");
 assertThat("Frodo").doesNotContain("gandalf");
 
 // assertion will fail
 assertThat("Frodo").doesNotContain("Fro");
        Parameters:
        sequence - the sequence to search for.
        Returns:
        this assertion object.
        Throws:
        NullPointerException - if the given sequence is null.
        AssertionError - if the actual CharSequence is null.
        AssertionError - if the actual CharSequence contains the given one.

      • doesNotContainPattern

        public SELF doesNotContainPattern​(CharSequence pattern)
        Verifies that the actual CharSequence does not contain the given regular expression.

        Example : 

         // assertion will pass
 assertThat("Frodo").doesNotContainPattern("Fr.ud");

 // assertion will fail
 assertThat("Freud").doesNotContainPattern("Fr.ud");
        Parameters:
        pattern - the regular expression to find in the actual CharSequence.
        Returns:
        this assertion object.
        Throws:
        NullPointerException - if the given pattern is null.
        PatternSyntaxException - if the regular expression's syntax is invalid.
        AssertionError - if the actual CharSequence is null.
        AssertionError - if the given regular expression can be found in the actual CharSequence.
        Since:
        2.7.0 / 3.7.0

      • doesNotContainPattern

        public SELF doesNotContainPattern​(Pattern pattern)
        Verifies that the actual CharSequence does not contain the given regular expression.

        Example : 

         // assertion will pass
 assertThat("Frodo").doesNotContainPattern(Pattern.compile("Fr.ud"));

 // assertion will fail
 assertThat("Freud").doesNotContainPattern(Pattern.compile("Fr.ud"));
        Parameters:
        pattern - the regular expression to find in the actual CharSequence.
        Returns:
        this assertion object.
        Throws:
        NullPointerException - if the given pattern is null.
        AssertionError - if the actual CharSequence is null.
        AssertionError - if the given regular expression can be found in the actual CharSequence.
        Since:
        2.7.0 / 3.7.0

      • startsWith

        public SELF startsWith​(CharSequence prefix)
        Verifies that the actual CharSequence starts with the given prefix.

        Example : 

         // assertions will pass
 assertThat("Frodo").startsWith("Fro");
 assertThat("Gandalf the grey").startsWith("Gandalf");
 
 // assertions will fail
 assertThat("Frodo").startsWith("fro");
 assertThat("Gandalf the grey").startsWith("grey");
        Parameters:
        prefix - the given prefix.
        Returns:
        this assertion object.
        Throws:
        NullPointerException - if the given prefix is null.
        AssertionError - if the actual CharSequence is null.
        AssertionError - if the actual CharSequence does not start with the given prefix.

      • doesNotStartWith

        public SELF doesNotStartWith​(CharSequence prefix)
        Verifies that the actual CharSequence does not start with the given prefix.

        Example: 

         // assertions will pass
 assertThat("Frodo").doesNotStartWith("fro");
 assertThat("Gandalf the grey").doesNotStartWith("grey");

 // assertions will fail
 assertThat("Gandalf the grey").doesNotStartWith("Gandalf");
 assertThat("Frodo").doesNotStartWith("");
        Parameters:
        prefix - the given prefix.
        Returns:
        this assertion object.
        Throws:
        NullPointerException - if the given prefix is null.
        AssertionError - if the actual CharSequence is null.
        AssertionError - if the actual CharSequence starts with the given prefix.

      • endsWith

        public SELF endsWith​(CharSequence suffix)
        Verifies that the actual CharSequence ends with the given suffix.

        Example : 

         // assertion will pass
 assertThat("Frodo").endsWith("do");
 
 // assertion will fail
 assertThat("Frodo").endsWith("Fro");
        Parameters:
        suffix - the given suffix.
        Returns:
        this assertion object.
        Throws:
        NullPointerException - if the given suffix is null.
        AssertionError - if the actual CharSequence is null.
        AssertionError - if the actual CharSequence does not end with the given suffix.

      • doesNotEndWith

        public SELF doesNotEndWith​(CharSequence suffix)
        Verifies that the actual CharSequence does not end with the given suffix.

        Example: 

         // assertion will pass
 assertThat("Frodo").doesNotEndWith("Fro");

 // assertions will fail
 assertThat("Frodo").doesNotEndWith("do");
 assertThat("Frodo").doesNotEndWith("");
        Parameters:
        suffix - the given suffix.
        Returns:
        this assertion object.
        Throws:
        NullPointerException - if the given suffix is null.
        AssertionError - if the actual CharSequence is null.
        AssertionError - if the actual CharSequence ends with the given suffix.

      • matches

        public SELF matches​(CharSequence regex)
        Verifies that the actual CharSequence matches the given regular expression.

        Example : 

         // assertion will pass
 assertThat("Frodo").matches("..o.o");
 
 // assertion will fail
 assertThat("Frodo").matches(".*d");
        Parameters:
        regex - the regular expression to which the actual CharSequence is to be matched.
        Returns:
        this assertion object.
        Throws:
        NullPointerException - if the given pattern is null.
        PatternSyntaxException - if the regular expression's syntax is invalid.
        AssertionError - if the actual CharSequence is null.
        AssertionError - if the actual CharSequence does not match the given regular expression.

      • doesNotMatch

        public SELF doesNotMatch​(CharSequence regex)
        Verifies that the actual CharSequence does not match the given regular expression.

        Example : 

         // assertion will pass
 assertThat("Frodo").doesNotMatch(".*d");
 
 // assertion will fail
 assertThat("Frodo").doesNotMatch("..o.o");
        Parameters:
        regex - the regular expression to which the actual CharSequence is to be matched.
        Returns:
        this assertion object.
        Throws:
        NullPointerException - if the given pattern is null.
        PatternSyntaxException - if the regular expression's syntax is invalid.
        AssertionError - if the actual CharSequence is null.
        AssertionError - if the actual CharSequence matches the given regular expression.

      • matches

        public SELF matches​(Pattern pattern)
        Verifies that the actual CharSequence matches the given regular expression pattern.

        Example : 

         // assertion will pass
 assertThat("Frodo").matches(Pattern.compile("..o.o"));
 
 // assertion will fail
 assertThat("Frodo").matches(Pattern.compile(".*d"));
        Parameters:
        pattern - the regular expression to which the actual CharSequence is to be matched.
        Returns:
        this assertion object.
        Throws:
        NullPointerException - if the given pattern is null.
        AssertionError - if the actual CharSequence is null.
        AssertionError - if the actual CharSequence does not match the given regular expression.

      • doesNotMatch

        public SELF doesNotMatch​(Pattern pattern)
        Verifies that the actual CharSequence does not match the given regular expression pattern.

        Example : 

         // assertion will pass
 assertThat("Frodo").doesNotMatch(Pattern.compile(".*d"));
 
 // assertion will fail
 assertThat("Frodo").doesNotMatch(Pattern.compile("..o.o"));
        Parameters:
        pattern - the regular expression to which the actual CharSequence is to be matched.
        Returns:
        this assertion object.
        Throws:
        NullPointerException - if the given pattern is null.
        AssertionError - if the actual CharSequence does not match the given regular expression.

      • isXmlEqualTo

        public SELF isXmlEqualTo​(CharSequence expectedXml)
        Verifies that the actual CharSequence is equal to the given XML CharSequence after both have been formatted the same way.

        Example : 

         String expectedXml =
     "<rings>\n" +
         "  <bearer>\n" +
         "    <name>Frodo</name>\n" +
         "    <ring>\n" +
         "      <name>one ring</name>\n" +
         "      <createdBy>Sauron</createdBy>\n" +
         "    </ring>\n" +
         "  </bearer>\n" +
         "</rings>";
 
 // No matter how your xml string is formated, isXmlEqualTo is able to compare it's content with another xml String.
 String oneLineXml = "<rings><bearer><name>Frodo</name><ring><name>one ring</name><createdBy>Sauron</createdBy></ring></bearer></rings>";
 assertThat(oneLineXml).isXmlEqualTo(expectedXml);
 
 String xmlWithNewLine =
     "<rings>\n" +
         "<bearer>   \n" +
         "  <name>Frodo</name>\n" +
         "  <ring>\n" +
         "    <name>one ring</name>\n" +
         "    <createdBy>Sauron</createdBy>\n" +
         "  </ring>\n" +
         "</bearer>\n" +
         "</rings>";
 assertThat(xmlWithNewLine).isXmlEqualTo(expectedXml);
 
 // You can compare it with oneLineXml
 assertThat(xmlWithNewLine).isXmlEqualTo(oneLineXml);
 
 // Tip : use isXmlEqualToContentOf assertion to compare your XML String with the content of an XML file :
 assertThat(oneLineXml).isXmlEqualToContentOf(new File("src/test/resources/formatted.xml"));
        Parameters:
        expectedXml - the XML CharSequence to which the actual CharSequence is to be compared to.
        Returns:
        this assertion object to chain other assertions.
        Throws:
        NullPointerException - if the given CharSequence is null.
        AssertionError - if the actual CharSequence is null or is not the same XML as the given XML CharSequence.

      • isXmlEqualToContentOf

        public SELF isXmlEqualToContentOf​(File xmlFile)
        Verifies that the actual CharSequence is equal to the content of the given file.

        This is an handy shortcut that calls : isXmlEqualTo(contentOf(xmlFile))

        Example : 
         // You can easily compare your XML String to the content of an XML file, whatever how formatted they are.
 String oneLineXml = "<rings><bearer><name>Frodo</name><ring><name>one ring</name><createdBy>Sauron</createdBy></ring></bearer></rings>";
 assertThat(oneLineXml).isXmlEqualToContentOf(new File("src/test/resources/formatted.xml"));
        Parameters:
        xmlFile - the file to read the expected XML String to compare with actual CharSequence
        Returns:
        this assertion object to chain other assertions.
        Throws:
        NullPointerException - if the given File is null.
        AssertionError - if the actual CharSequence is null or is not the same XML as the content of given File.

      • inHexadecimal

        public SELF inHexadecimal()
        Description copied from class: AbstractAssert
        Use hexadecimal object representation instead of standard representation in error messages.

        It can be useful when comparing UNICODE characters - many unicode chars have duplicate characters assigned, it is thus impossible to find differences from the standard error message:

        With standard message: 

         assertThat("µµµ").contains("μμμ");

 java.lang.AssertionError:
 Expecting:
   <"µµµ">
 to contain:
   <"μμμ">
        With Hexadecimal message: 
         assertThat("µµµ").inHexadecimal().contains("μμμ");

 java.lang.AssertionError:
 Expecting:
   <"['00B5', '00B5', '00B5']">
 to contain:
   <"['03BC', '03BC', '03BC']">
        Overrides:
        inHexadecimal in class AbstractAssert<SELF extends AbstractCharSequenceAssert<SELF,​ACTUAL>,​ACTUAL extends CharSequence>
        Returns:
        this assertion object.

      • inUnicode

        public SELF inUnicode()
        Use unicode character representation instead of standard representation in error messages.

        It can be useful when comparing UNICODE characters - many unicode chars have duplicate characters assigned, it is thus impossible to find differences from the standard error message:

        With standard message: 

         assertThat("µµµ").contains("μμμ");
 
 java.lang.AssertionError:
 Expecting:
   <"µµµ">
 to contain:
   <"μμμ">
        With Hexadecimal message: 
         assertThat("µµµ").inUnicode().contains("μμμ");
 
 java.lang.AssertionError:
 Expecting:
   <µµµ>
 to contain:
   <μμμ>
        Returns:
        this assertion object.

      • isEqualToIgnoringWhitespace

        public SELF isEqualToIgnoringWhitespace​(CharSequence expected)
        Verifies that the actual CharSequence is equal to the given one, ignoring whitespace differences

        Examples : 

         // assertions will pass
 assertThat("Game of Thrones").isEqualToIgnoringWhitespace("Game   of   Thrones")
                              .isEqualToIgnoringWhitespace("  Game of   Thrones  ")
                              .isEqualToIgnoringWhitespace("  Game of Thrones  ")
                              .isEqualToIgnoringWhitespace("Gameof      Thrones")
                              .isEqualToIgnoringWhitespace("Game of\tThrones")
                              .isEqualToIgnoringWhitespace("GameofThrones");

 // assertion will fail
 assertThat("Game of Thrones").isEqualToIgnoringWhitespace("Game OF Thrones");

        This assertion behavior has changed in 2.8.0 to really ignore all whitespaces, the old behaviour has been kept in the better named isEqualToNormalizingWhitespace(CharSequence).

        Parameters:
        expected - the given CharSequence to compare the actual CharSequence to.
        Returns:
        this assertion object.
        Throws:
        AssertionError - if the actual CharSequence is not equal ignoring whitespace differences to the given one.

      • isNotEqualToIgnoringWhitespace

        public SELF isNotEqualToIgnoringWhitespace​(CharSequence expected)
        Verifies that the actual CharSequence is not equal to the given one, ignoring whitespace differences.

        Example : 

         // assertions will pass
 assertThat(" my\tfoo bar ").isNotEqualToIgnoringWhitespace("myfoo");
 assertThat(" my\tfoo").isNotEqualToIgnoringWhitespace(" my bar");

 // assertions will fail
 assertThat("my      foo bar").isNotEqualToIgnoringWhitespace("my foo bar");
 assertThat("  my foo bar  ").isNotEqualToIgnoringWhitespace("my foo bar");
 assertThat(" my     foo bar ").isNotEqualToIgnoringWhitespace("my foo bar");
 assertThat(" my\tfoo bar ").isNotEqualToIgnoringWhitespace(" my foo bar");
 assertThat("my foo bar").isNotEqualToIgnoringWhitespace("   my foo bar   ");
        Parameters:
        expected - the given CharSequence to compare the actual CharSequence to.
        Returns:
        this assertion object.
        Throws:
        AssertionError - if the actual CharSequence is equal ignoring whitespace differences to the given one.

      • isEqualToNormalizingWhitespace

        public SELF isEqualToNormalizingWhitespace​(CharSequence expected)
        Verifies that the actual CharSequence is equal to the given one, after the whitespace of both strings has been normalized.
        To be exact, the following rules are applied:
        • all leading and trailing whitespace of both actual and expected strings are ignored
        • any remaining whitespace, appearing within either string, is collapsed to a single space before comparison

        Example : 

         // assertions will pass
 assertThat("Game of Thrones").isEqualToNormalizingWhitespace("Game   of   Thrones")
                              .isEqualToNormalizingWhitespace("Game of     Thrones")
                              .isEqualToNormalizingWhitespace("Game     of Thrones")
                              .isEqualToNormalizingWhitespace("  Game of Thrones  ")
                              .isEqualToNormalizingWhitespace("  Game of   Thrones  ")
                              .isEqualToNormalizingWhitespace("Game of\tThrones")
                              .isEqualToNormalizingWhitespace("Game of Thrones");

 // assertions will fail
 assertThat("Game of Thrones").isEqualToNormalizingWhitespace("Game ofThrones");
 assertThat("Game of Thrones").isEqualToNormalizingWhitespace("Gameo fThrones");
 assertThat("Game of Thrones").isEqualToNormalizingWhitespace("Gameof Thrones");
        Parameters:
        expected - the given CharSequence to compare the actual CharSequence to.
        Returns:
        this assertion object.
        Throws:
        AssertionError - if the actual CharSequence is not equal to the given one after whitespace has been normalized.
        Since:
        2.8.0 / 3.8.0

      • isNotEqualToNormalizingWhitespace

        public SELF isNotEqualToNormalizingWhitespace​(CharSequence expected)
        Verifies that the actual CharSequence is not equal to the given one, after the whitespace of both strings has been normalized.
        To be exact, the following rules are applied:
        • all leading and trailing whitespace of both actual and expected strings are ignored
        • any remaining whitespace, appearing within either string, is collapsed to a single space before comparison

        Example : 

         // assertions will pass
 assertThat(" my\tfoo").isNotEqualToNormalizingWhitespace(" my bar");
 assertThat(" my\tfoo bar ").isNotEqualToNormalizingWhitespace(" my foobar");

 // assertions will fail
 assertThat("my      foo bar").isNotEqualToNormalizingWhitespace("my foo bar");
 assertThat("  my foo bar  ").isNotEqualToNormalizingWhitespace("my foo bar");
 assertThat(" my     foo bar ").isNotEqualToNormalizingWhitespace("my foo bar");
 assertThat(" my\tfoo bar ").isNotEqualToNormalizingWhitespace(" my foo bar");
 assertThat("my foo bar").isNotEqualToNormalizingWhitespace("   my foo bar   ");
        Parameters:
        expected - the given CharSequence to compare the actual CharSequence to.
        Returns:
        this assertion object.
        Throws:
        AssertionError - if the actual CharSequence is equal to the given one after whitespace has been normalized.
        Since:
        2.8.0 / 3.8.0

      • isSubstringOf

        public SELF isSubstringOf​(CharSequence sequence)
        Verifies that the actual CharSequence is a substring of the given one (opposite assertion of contains(CharSequence cs).

        Example : 

         // assertions will pass
 assertThat("Lego").isSubstringOf("Legolas");
 assertThat("Legolas").isSubstringOf("Legolas");
 
 // assertion will fail
 assertThat("Frodo").isSubstringOf("Frod");
        Parameters:
        sequence - the sequence that is expected to contain actual.
        Returns:
        this assertion object.
        Throws:
        AssertionError - if the actual CharSequence is not a substring of the given parameter.

      • containsPattern

        public SELF containsPattern​(CharSequence regex)
        Verifies that the actual CharSequence contains the given regular expression.

        Example : 

         // assertion will pass
 assertThat("Frodo").containsPattern("Fr.d");
 
 // assertion will fail
 assertThat("Frodo").containsPattern("Frodod");
        Parameters:
        regex - the regular expression to find in the actual CharSequence.
        Returns:
        this assertion object.
        Throws:
        NullPointerException - if the given pattern is null.
        PatternSyntaxException - if the regular expression's syntax is invalid.
        AssertionError - if the actual CharSequence is null.
        AssertionError - if the given regular expression cannot be found in the actual CharSequence.

      • containsPattern

        public SELF containsPattern​(Pattern pattern)
        Verifies that the actual CharSequence contains the given regular expression pattern.

        Example : 

         // assertion will pass
 assertThat("Frodo").containsPattern(Pattern.compile("Fr.d"));
 
 // assertion will fail
 assertThat("Frodo").containsPattern(Pattern.compile("Frodod"));
        Parameters:
        pattern - the regular expression to find in the actual CharSequence.
        Returns:
        this assertion object.
        Throws:
        NullPointerException - if the given pattern is null.
        AssertionError - if the actual CharSequence is null.
        AssertionError - if the given regular expression cannot be found in the actual CharSequence.

      • isEqualToNormalizingNewlines

        public SELF isEqualToNormalizingNewlines​(CharSequence expected)
        Verifies that the actual CharSequence is equals to another CharSequence after normalizing new line characters (i.e. '\r\n' == '\n').

        This assertion will succeed: 

         String bookName = "Lord of the Rings\r\n";
 assertThat(bookName).isEqualToNormalizingNewlines("Lord of the Rings\n");
        Whereas this assertion will fail: 
         String singleLine = "\n";
 assertThat(singleLine).isEqualToNormalizingNewlines("");
        Parameters:
        expected - the given CharSequence to compare the actual CharSequence to.
        Returns:
        this assertion object.
        Throws:
        AssertionError - if the actual CharSequence and the given CharSequence are different after new lines are normalized.
        Since:
        2.7.0 / 3.7.0