Class AbstractCharSequenceAssert<SELF extends AbstractCharSequenceAssert<SELF,ACTUAL>,ACTUAL extends CharSequence>
- java.lang.Object
-
- org.assertj.core.api.AbstractAssert<SELF,ACTUAL>
-
- org.assertj.core.api.AbstractCharSequenceAssert<SELF,ACTUAL>
-
- Type Parameters:
SELF- the "self" type of this assertion class. Please read "Emulating 'self types' using Java Generics to simplify fluent API implementation" for more details.ACTUAL- the type of the "actual" value.
- All Implemented Interfaces:
Assert<SELF,ACTUAL>,Descriptable<SELF>,EnumerableAssert<SELF,Character>,ExtensionPoints<SELF,ACTUAL>
- Direct Known Subclasses:
AbstractStringAssert,CharSequenceAssert
public abstract class AbstractCharSequenceAssert<SELF extends AbstractCharSequenceAssert<SELF,ACTUAL>,ACTUAL extends CharSequence> extends AbstractAssert<SELF,ACTUAL> implements EnumerableAssert<SELF,Character>
Base class for all implementations of assertions forCharSequences.- Author:
- Yvonne Wang, David DIDIER, Alex Ruiz, Joel Costigliola, Mikhail Mazursky, Nicolas Francois, Daniel Weber
-
-
Field Summary
Fields Modifier and Type Field Description (package private) Stringsstrings-
Fields inherited from class org.assertj.core.api.AbstractAssert
actual, assertionErrorCreator, conditions, info, myself, objects, throwUnsupportedExceptionOnEquals
-
-
Constructor Summary
Constructors Constructor Description AbstractCharSequenceAssert(ACTUAL actual, Class<?> selfType)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description SELFcontains(CharSequence... values)Verifies that the actualCharSequencecontains all the given values.SELFcontains(Iterable<? extends CharSequence> values)Verifies that the actualCharSequencecontains all theCharSequences of the given Iterable.SELFcontainsIgnoringCase(CharSequence sequence)Verifies that the actualCharSequencecontains the given sequence, ignoring case considerations.SELFcontainsOnlyDigits()Verifies that the actualCharSequencecontains only digits.SELFcontainsOnlyOnce(CharSequence sequence)Verifies that the actualCharSequencecontains the given sequence only once.SELFcontainsOnlyWhitespaces()Verifies that the actualCharSequenceconsists of one or more whitespace characters (according toCharacter.isWhitespace(char)).SELFcontainsPattern(CharSequence regex)Verifies that the actualCharSequencecontains the given regular expression.SELFcontainsPattern(Pattern pattern)Verifies that the actualCharSequencecontains the given regular expression pattern.SELFcontainsSequence(CharSequence... values)Verifies that the actualCharSequencecontains the given sequence of values in the given order without any other values between them.SELFcontainsSequence(Iterable<? extends CharSequence> values)Verifies that the actualCharSequencecontains all the values of the given Iterable in the Iterable iteration order without any other values between them.SELFcontainsSubsequence(CharSequence... values)Verifies that the actualCharSequencecontains all the given values in the given order, possibly with other values between them.SELFcontainsSubsequence(Iterable<? extends CharSequence> values)Verifies that the actualCharSequencecontains all the values of the given Iterable in the Iterable iteration order (possibly with other values between them).SELFcontainsWhitespaces()Verifies that the actualCharSequencecontains one or more whitespace characters (according toCharacter.isWhitespace(char)).SELFdoesNotContain(CharSequence... values)Verifies that the actualCharSequencedoes not contain any of the given values.SELFdoesNotContain(Iterable<? extends CharSequence> values)Verifies that the actualCharSequencedoes not contain any of the given Iterable.SELFdoesNotContainAnyWhitespaces()Verifies that the actualCharSequenceis eithernull, empty or does not contain any whitespace characters (according toCharacter.isWhitespace(char)).SELFdoesNotContainOnlyWhitespaces()Verifies that the actualCharSequenceis either:nullempty contains at least one non-whitespace character (according toCharacter.isWhitespace(char)).SELFdoesNotContainPattern(CharSequence pattern)Verifies that the actualCharSequencedoes not contain the given regular expression.SELFdoesNotContainPattern(Pattern pattern)Verifies that the actualCharSequencedoes not contain the given regular expression.SELFdoesNotEndWith(CharSequence suffix)Verifies that the actualCharSequencedoes not end with the given suffix.SELFdoesNotMatch(CharSequence regex)Verifies that the actualCharSequencedoes not match the given regular expression.SELFdoesNotMatch(Pattern pattern)Verifies that the actualCharSequencedoes not match the given regular expression pattern.SELFdoesNotStartWith(CharSequence prefix)Verifies that the actualCharSequencedoes not start with the given prefix.SELFendsWith(CharSequence suffix)Verifies that the actualCharSequenceends with the given suffix.SELFhasLineCount(int expectedLineCount)Verifies that the actualCharSequencehas the expected line count.SELFhasSameSizeAs(CharSequence other)Verifies that the actualCharSequencehas a length that's the same as the length of the givenCharSequence.SELFhasSameSizeAs(Iterable<?> other)Verifies that the actualCharSequencehas a length that's the same as the number of elements in the given Iterable.SELFhasSameSizeAs(Object other)Verifies that the actualCharSequencehas a length that's the same as the number of elements in the given array.SELFhasSize(int expected)Verifies that the actualCharSequencehas the expected length using thelength()method.SELFhasSizeBetween(int lowerBoundary, int higherBoundary)Verifies that the actualCharSequencehas length between the given boundaries (inclusive) using thelength()method.SELFhasSizeGreaterThan(int expected)Verifies that the actualCharSequencehas a length greater than the given value using thelength()method.SELFhasSizeGreaterThanOrEqualTo(int expected)Verifies that the actualCharSequencehas a length greater than or equal to the given value using thelength()method.SELFhasSizeLessThan(int expected)Verifies that the actualCharSequencehas has a length less than the given value using thelength()method.SELFhasSizeLessThanOrEqualTo(int expected)Verifies that the actualCharSequencehas a length less than or equal to the given value using thelength()method.SELFinHexadecimal()Use hexadecimal object representation instead of standard representation in error messages.SELFinUnicode()Use unicode character representation instead of standard representation in error messages.SELFisBlank()Verifies that the actualCharSequenceis blank, i.e.voidisEmpty()Verifies that the actualCharSequenceis empty, i.e., it has a length of 0 and is notnull.SELFisEqualToIgnoringCase(CharSequence expected)Verifies that the actualCharSequenceis equal to the given one, ignoring case considerations.SELFisEqualToIgnoringNewLines(CharSequence expected)Verifies that the actualCharSequenceis equal to the given one after both strings new lines (\n, \r\n) have been removed.SELFisEqualToIgnoringWhitespace(CharSequence expected)Verifies that the actualCharSequenceis equal to the given one, ignoring whitespace differencesSELFisEqualToNormalizingNewlines(CharSequence expected)Verifies that the actualCharSequenceis equals to anotherCharSequenceafter normalizing new line characters (i.e.SELFisEqualToNormalizingWhitespace(CharSequence expected)Verifies that the actualCharSequenceis 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 comparisonSELFisJavaBlank()Deprecated.UseisBlank()instead.SELFisLowerCase()Verifies that the actualCharSequenceis a lowercaseCharSequenceby comparing it to a lowercaseactualbuilt withString.toLowerCase().SELFisNotBlank()Verifies that the actualCharSequenceis: notnullnot empty contains at least one non-whitespace character (according toCharacter.isWhitespace(char))SELFisNotEmpty()Verifies that the actualCharSequenceis not empty, i.e., is notnulland has a length of 1 or more.SELFisNotEqualToIgnoringCase(CharSequence expected)Verifies that the actualCharSequenceis not equal to the given one, ignoring case considerations.SELFisNotEqualToIgnoringWhitespace(CharSequence expected)Verifies that the actualCharSequenceis not equal to the given one, ignoring whitespace differences.SELFisNotEqualToNormalizingWhitespace(CharSequence expected)Verifies that the actualCharSequenceis 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 comparisonSELFisNotJavaBlank()Deprecated.UseisNotBlank()instead.voidisNullOrEmpty()Verifies that the actualCharSequenceis empty, i.e., it has a length of 0, or isnull.SELFisSubstringOf(CharSequence sequence)Verifies that the actualCharSequenceis a substring of the given one (opposite assertion ofcontains(CharSequence cs).SELFisUpperCase()Verifies that the actualCharSequenceis a uppercaseCharSequenceby comparing it to an uppercaseactualbuilt withString.toUpperCase().SELFisXmlEqualTo(CharSequence expectedXml)Verifies that the actualCharSequenceis equal to the given XMLCharSequenceafter both have been formatted the same way.SELFisXmlEqualToContentOf(File xmlFile)Verifies that the actualCharSequenceis equal to the content of the given file.SELFmatches(CharSequence regex)Verifies that the actualCharSequencematches the given regular expression.SELFmatches(Pattern pattern)Verifies that the actualCharSequencematches the given regular expression pattern.SELFstartsWith(CharSequence prefix)Verifies that the actualCharSequencestarts with the given prefix.SELFusingComparator(Comparator<? super ACTUAL> customComparator)Use the given custom comparator instead of relying on actual type A equals method for incoming assertion checks.SELFusingComparator(Comparator<? super ACTUAL> customComparator, String customComparatorDescription)Use the given custom comparator instead of relying on actual type A equals method for incoming assertion checks.SELFusingDefaultComparator()Revert to standard comparison for the incoming assertion checks.SELFusingDefaultElementComparator()Deprecated.Custom element Comparator is not supported for CharSequence comparison.SELFusingElementComparator(Comparator<? super Character> customComparator)Deprecated.Custom element Comparator is not supported for CharSequence comparison.-
Methods inherited from class org.assertj.core.api.AbstractAssert
as, as, asInstanceOf, asList, asString, describedAs, describedAs, descriptionText, doesNotHave, doesNotHaveSameClassAs, equals, failWithMessage, getWritableAssertionInfo, has, hashCode, hasSameClassAs, hasSameHashCodeAs, hasToString, inBinary, is, isEqualTo, isExactlyInstanceOf, isIn, isIn, isInstanceOf, isInstanceOfAny, isInstanceOfSatisfying, isNot, isNotEqualTo, isNotExactlyInstanceOf, isNotIn, isNotIn, isNotInstanceOf, isNotInstanceOfAny, isNotNull, isNotOfAnyClassIn, isNotSameAs, isNull, isOfAnyClassIn, isSameAs, matches, matches, newListAssertInstance, overridingErrorMessage, satisfies, satisfies, satisfiesAnyOf, satisfiesAnyOf, setCustomRepresentation, throwAssertionError, withAssertionState, withFailMessage, withRepresentation, withThreadDumpOnError
-
-
-
-
Field Detail
-
strings
Strings strings
-
-
Method Detail
-
isNullOrEmpty
public void isNullOrEmpty()
Verifies that the actualCharSequenceis empty, i.e., it has a length of 0, or isnull.If you do not want to accept a
nullvalue, useisEmpty()instead.Both of these assertions will succeed:
Whereas these assertions will fail:String emptyString = "" assertThat(emptyString).isNullOrEmpty(); String nullString = null; assertThat(nullString).isNullOrEmpty();assertThat("a").isNullOrEmpty(); assertThat(" ").isNullOrEmpty();- Specified by:
isNullOrEmptyin interfaceEnumerableAssert<SELF extends AbstractCharSequenceAssert<SELF,ACTUAL>,ACTUAL extends CharSequence>- Throws:
AssertionError- if the actualCharSequencehas a non-zero length.
-
isEmpty
public void isEmpty()
Verifies that the actualCharSequenceis empty, i.e., it has a length of 0 and is notnull.If you want to accept a
nullvalue as well as a 0 length, useisNullOrEmpty()instead.This assertion will succeed:
Whereas these assertions will fail:String emptyString = "" assertThat(emptyString).isEmpty();String nullString = null; assertThat(nullString).isEmpty(); assertThat("a").isEmpty(); assertThat(" ").isEmpty();- Specified by:
isEmptyin interfaceEnumerableAssert<SELF extends AbstractCharSequenceAssert<SELF,ACTUAL>,ACTUAL extends CharSequence>- Throws:
AssertionError- if the actualCharSequencehas a non-zero length or is null.
-
isNotEmpty
public SELF isNotEmpty()
Verifies that the actualCharSequenceis not empty, i.e., is notnulland has a length of 1 or more.This assertion will succeed:
Whereas these assertions will fail:String bookName = "A Game of Thrones" assertThat(bookName).isNotEmpty();String emptyString = "" assertThat(emptyString).isNotEmpty(); String nullString = null; assertThat(nullString).isNotEmpty();- Specified by:
isNotEmptyin interfaceEnumerableAssert<SELF extends AbstractCharSequenceAssert<SELF,ACTUAL>,ACTUAL extends CharSequence>- Returns:
thisassertion object.- Throws:
AssertionError- if the actualCharSequenceis empty (has a length of 0).
-
isBlank
public SELF isBlank()
Verifies that the actualCharSequenceis blank, i.e. isnull, empty or consists of one or more whitespace characters (according toCharacter.isWhitespace(char)).The definition of this method has changed, the old behaviour is now under
containsOnlyWhitespaces().These assertions succeed:
Whereas these assertions fail:assertThat(" ").isBlank(); assertThat("").isBlank(); assertThat(" ").isBlank(); String nullString = null; assertThat(nullString).isBlank();assertThat("a").isBlank(); assertThat(" b").isBlank(); assertThat(" c ").isBlank();- Returns:
thisassertion object.- Throws:
AssertionError- if the actualCharSequenceis not blank.- Since:
- 2.6.0 / 3.6.0
-
isNotBlank
public SELF isNotBlank()
Verifies that the actualCharSequenceis:- not
null - not empty
- contains at least one non-whitespace character (according to
Character.isWhitespace(char))
The definition of this method has changed, the old behaviour is now under
doesNotContainOnlyWhitespaces().These assertions succeed:
Whereas these assertions fail:assertThat("a").isNotBlank(); assertThat(" b").isNotBlank(); assertThat(" c ").isNotBlank();assertThat(" ").isNotBlank(); assertThat("").isNotBlank(); assertThat(" ").isNotBlank(); String nullString = null; assertThat(nullString).isNotBlank();- Returns:
thisassertion object.- Throws:
AssertionError- if the actualCharSequenceis blank.- Since:
- 2.6.0 / 3.6.0
- not
-
containsWhitespaces
public SELF containsWhitespaces()
Verifies that the actualCharSequencecontains one or more whitespace characters (according toCharacter.isWhitespace(char)).These assertions will succeed:
Whereas these assertions will fail:assertThat(" ").containsWhitespaces(); assertThat("a b").containsWhitespaces(); assertThat(" c ").containsWhitespaces();assertThat("").containsWhitespaces(); assertThat("a").containsWhitespaces(); String nullString = null; assertThat(nullString).containsWhitespaces();- Returns:
thisassertion object.- Throws:
AssertionError- if the actualCharSequencedoes not contain any whitespace characters.- Since:
- 3.11.0
-
containsOnlyWhitespaces
public SELF containsOnlyWhitespaces()
Verifies that the actualCharSequenceconsists of one or more whitespace characters (according toCharacter.isWhitespace(char)).These assertions will succeed:
Whereas these assertions will fail:assertThat(" ").containsOnlyWhitespaces(); assertThat(" ").containsOnlyWhitespaces();assertThat("a").containsOnlyWhitespaces(); assertThat("").containsOnlyWhitespaces(); assertThat(" b").containsOnlyWhitespaces(); assertThat(" c ").containsOnlyWhitespaces(); String nullString = null; assertThat(nullString).containsOnlyWhitespaces();- Returns:
thisassertion object.- Throws:
AssertionError- if the actualCharSequenceis not blank.- Since:
- 2.9.0 / 3.9.0
-
doesNotContainAnyWhitespaces
public SELF doesNotContainAnyWhitespaces()
Verifies that the actualCharSequenceis eithernull, empty or does not contain any whitespace characters (according toCharacter.isWhitespace(char)).These assertions will succeed:
Whereas these assertions will fail:assertThat("a").doesNotContainAnyWhitespaces(); assertThat("").doesNotContainAnyWhitespaces(); assertThat("ab").doesNotContainAnyWhitespaces(); String nullString = null; assertThat(nullString).doesNotContainAnyWhitespaces();assertThat(" ").doesNotContainAnyWhitespaces(); assertThat(" a").doesNotContainAnyWhitespaces();- Returns:
thisassertion object.- Throws:
AssertionError- if the actualCharSequencecontains one or more whitespace characters.- Since:
- 3.11.0
-
doesNotContainOnlyWhitespaces
public SELF doesNotContainOnlyWhitespaces()
Verifies that the actualCharSequenceis either:null- empty
- contains at least one non-whitespace character (according to
Character.isWhitespace(char)).
The main difference with
isNotBlank()is that it accepts null or emptyCharSequence.These assertions will succeed:
Whereas these assertions will fail:assertThat("a").doesNotContainOnlyWhitespaces(); assertThat("").doesNotContainOnlyWhitespaces(); assertThat(" b").doesNotContainOnlyWhitespaces(); assertThat(" c ").doesNotContainOnlyWhitespaces(); String nullString = null; assertThat(nullString).doesNotContainOnlyWhitespaces();assertThat(" ").doesNotContainOnlyWhitespaces(); assertThat(" ").doesNotContainOnlyWhitespaces();- Returns:
thisassertion object.- Throws:
AssertionError- if the actualCharSequenceis blank.- Since:
- 2.9.0 / 3.9.0
-
isJavaBlank
@Deprecated public SELF isJavaBlank()
Deprecated.UseisBlank()instead.Verifies that the actualCharSequenceis blank, i.e. consists of one or more whitespace characters (according toCharacter.isWhitespace(char)).These assertions will succeed:
Whereas these assertions will fail:assertThat(" ").isJavaBlank(); assertThat(" ").isJavaBlank();assertThat("a").isJavaBlank(); assertThat(" b").isJavaBlank(); assertThat("").isJavaBlank(); String nullString = null; assertThat(nullString).isJavaBlank();- Returns:
thisassertion object.- Throws:
AssertionError- if the actualCharSequenceis not blank.- Since:
- 2.6.0 / 3.6.0
-
isNotJavaBlank
@Deprecated public SELF isNotJavaBlank()
Deprecated.UseisNotBlank()instead.Verifies that the actualCharSequenceis not blank, i.e. either isnull, empty or contains at least one non-whitespace character (according toCharacter.isWhitespace(char)).These assertions will succeed:
Whereas these assertions will fail:assertThat("a").isNotJavaBlank(); assertThat(" b").isNotJavaBlank(); assertThat(" c ").isNotJavaBlank(); assertThat("").isNotJavaBlank(); String nullString = null; assertThat(nullString).isNotJavaBlank();assertThat(" ").isNotJavaBlank(); assertThat(" ").isNotJavaBlank();- Returns:
thisassertion object.- Throws:
AssertionError- if the actualCharSequenceis blank.- Since:
- 2.6.0 / 3.6.0
-
hasSize
public SELF hasSize(int expected)
Verifies that the actualCharSequencehas the expected length using thelength()method.This assertion will succeed:
Whereas this assertion will fail:String bookName = "A Game of Thrones" assertThat(bookName).hasSize(17);String bookName = "A Clash of Kings" assertThat(bookName).hasSize(4);- Specified by:
hasSizein interfaceEnumerableAssert<SELF extends AbstractCharSequenceAssert<SELF,ACTUAL>,ACTUAL extends CharSequence>- Parameters:
expected- the expected length of the actualCharSequence.- Returns:
thisassertion object.- Throws:
AssertionError- if the actual length is not equal to the expected length.
-
hasSizeLessThan
public SELF hasSizeLessThan(int expected)
Verifies that the actualCharSequencehas has a length less than the given value using thelength()method.This assertion will succeed:
Whereas this assertion will fail:assertThat("abc").hasSizeLessThan(4);assertThat("abc").hasSizeLessThan(3);- Specified by:
hasSizeLessThanin interfaceEnumerableAssert<SELF extends AbstractCharSequenceAssert<SELF,ACTUAL>,ACTUAL extends CharSequence>- Parameters:
expected- the expected maximum length of the actualCharSequence.- Returns:
thisassertion object.- Throws:
AssertionError- if the actual length is equal or greater than the expected length.- Since:
- 3.12.0
-
hasSizeLessThanOrEqualTo
public SELF hasSizeLessThanOrEqualTo(int expected)
Verifies that the actualCharSequencehas a length less than or equal to the given value using thelength()method.This assertion will succeed:
Whereas this assertion will fail:assertThat("abc").hasSizeLessThanOrEqualTo(3);assertThat("abc").hasSizeLessThanOrEqualTo(2);- Specified by:
hasSizeLessThanOrEqualToin interfaceEnumerableAssert<SELF extends AbstractCharSequenceAssert<SELF,ACTUAL>,ACTUAL extends CharSequence>- Parameters:
expected- the expected maximum length of the actualCharSequence.- Returns:
thisassertion object.- Throws:
AssertionError- if the actual length is greater than the expected length.- Since:
- 3.12.0
-
hasSizeGreaterThan
public SELF hasSizeGreaterThan(int expected)
Verifies that the actualCharSequencehas a length greater than the given value using thelength()method.This assertion will succeed:
Whereas this assertion will fail:assertThat("abcs").hasSizeGreaterThan(2);assertThat("abc").hasSizeGreaterThan(3);- Specified by:
hasSizeGreaterThanin interfaceEnumerableAssert<SELF extends AbstractCharSequenceAssert<SELF,ACTUAL>,ACTUAL extends CharSequence>- Parameters:
expected- the expected minimum length of the actualCharSequence.- Returns:
thisassertion object.- Throws:
AssertionError- if the actual length is equal or less than the expected length.- Since:
- 3.12.0
-
hasSizeGreaterThanOrEqualTo
public SELF hasSizeGreaterThanOrEqualTo(int expected)
Verifies that the actualCharSequencehas a length greater than or equal to the given value using thelength()method.This assertion will succeed:
Whereas this assertion will fail:assertThat("abc").hasSizeGreaterThanOrEqualTo(3);assertThat("abc").hasSizeGreaterThanOrEqualTo(3);- Specified by:
hasSizeGreaterThanOrEqualToin interfaceEnumerableAssert<SELF extends AbstractCharSequenceAssert<SELF,ACTUAL>,ACTUAL extends CharSequence>- Parameters:
expected- the expected minimum length of the actualCharSequence.- Returns:
thisassertion object.- Throws:
AssertionError- if the actual length is less than the expected length.- Since:
- 3.12.0
-
hasSizeBetween
public SELF hasSizeBetween(int lowerBoundary, int higherBoundary)
Verifies that the actualCharSequencehas length between the given boundaries (inclusive) using thelength()method.This assertion will succeed:
Whereas this assertion will fail:String bookName = "A Game of Thrones" assertThat(bookName).hasSizeBetween(5, 25); assertThat(bookName).hasSizeBetween(16, 17);String bookName = "A Clash of Kings" assertThat(bookName).hasSizeBetween(2, 5);- Specified by:
hasSizeBetweenin interfaceEnumerableAssert<SELF extends AbstractCharSequenceAssert<SELF,ACTUAL>,ACTUAL extends CharSequence>- Parameters:
lowerBoundary- the lower boundary compared to which actual length should be greater than or equal to.higherBoundary- the higher boundary compared to which actual length should be less than or equal to.- Returns:
thisassertion object.- Throws:
AssertionError- if the actual length is not between the boundaries.- Since:
- 3.12.0
-
hasLineCount
public SELF hasLineCount(int expectedLineCount)
Verifies that the actualCharSequencehas 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 (seeLineNumberReader).This assertion will succeed:
Whereas this assertion will fail:String multiLine = "First line\n" + "Last line"; assertThat(multiLine).hasLineCount(2);String bookName = "A Clash of Kings"; assertThat(bookName).hasLineCount(3);- Parameters:
expectedLineCount- the expected line count of the actualCharSequence.- Returns:
thisassertion object.- Throws:
AssertionError- if the actual line count is not equal to the expected one.
-
hasSameSizeAs
public SELF hasSameSizeAs(CharSequence other)
Verifies that the actualCharSequencehas a length that's the same as the length of the givenCharSequence.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 givenCharSequenceto be used for size comparison.- Returns:
thisassertion object.- Throws:
AssertionError- if the actualCharSequencehas a length that's different from the length of the givenCharSequence.NullPointerException- if the givenCharSequenceisnull.
-
hasSameSizeAs
public SELF hasSameSizeAs(Object other)
Verifies that the actualCharSequencehas 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:
hasSameSizeAsin interfaceEnumerableAssert<SELF extends AbstractCharSequenceAssert<SELF,ACTUAL>,ACTUAL extends CharSequence>- Parameters:
other- the given array to be used for size comparison.- Returns:
thisassertion object.- Throws:
AssertionError- if the actualCharSequencehas a length that's different from the number of elements in the array.NullPointerException- if the given array isnull.
-
hasSameSizeAs
public SELF hasSameSizeAs(Iterable<?> other)
Verifies that the actualCharSequencehas 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:
hasSameSizeAsin interfaceEnumerableAssert<SELF extends AbstractCharSequenceAssert<SELF,ACTUAL>,ACTUAL extends CharSequence>- Parameters:
other- the givenIterableto be used for size comparison.- Returns:
thisassertion object.- Throws:
AssertionError- if the actualCharSequencehas a length that's different from the number of elements in theIterable.NullPointerException- if the givenIterableisnull.
-
isEqualToIgnoringCase
public SELF isEqualToIgnoringCase(CharSequence expected)
Verifies that the actualCharSequenceis 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 givenCharSequenceto compare the actualCharSequenceto.- Returns:
thisassertion object.- Throws:
AssertionError- if the actualCharSequenceis not equal to the given one.
-
isNotEqualToIgnoringCase
public SELF isNotEqualToIgnoringCase(CharSequence expected)
Verifies that the actualCharSequenceis 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 givenCharSequenceto compare the actualCharSequenceto.- Returns:
thisassertion object.- Throws:
AssertionError- if the actualCharSequenceis not equal to the given one.
-
containsOnlyDigits
public SELF containsOnlyDigits()
Verifies that the actualCharSequencecontains only digits. It fails if it contains non-digit characters or is empty.This assertion succeeds:
Whereas these assertions fail:assertThat("10").containsOnlyDigits();assertThat("10$").containsOnlyDigits(); assertThat("").containsOnlyDigits();- Returns:
thisassertion object.- Throws:
AssertionError- if the actualCharSequencecontains non-digit characters or isnull.
-
containsOnlyOnce
public SELF containsOnlyOnce(CharSequence sequence)
Verifies that the actualCharSequencecontains 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:
thisassertion object.- Throws:
AssertionError- if the actualCharSequenceeither does not contain the given one at all, or contains it more than once.
-
contains
public SELF contains(CharSequence... values)
Verifies that the actualCharSequencecontains 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:
thisassertion object.- Throws:
NullPointerException- if the given list of values isnull.IllegalArgumentException- if the list of given values is empty.AssertionError- if the actualCharSequenceisnull.AssertionError- if the actualCharSequencedoes not contain all the given strings.
-
contains
public SELF contains(Iterable<? extends CharSequence> values)
Verifies that the actualCharSequencecontains all theCharSequences 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:
thisassertion object.- Throws:
NullPointerException- if the given list of values isnull.IllegalArgumentException- if the list of given values is empty.AssertionError- if the actualCharSequenceisnull.AssertionError- if the actualCharSequencedoes not contain all the given values.
-
containsSequence
public SELF containsSequence(CharSequence... values)
Verifies that the actualCharSequencecontains the given sequence of values in the given order without any other values between them.Breaking change since 2.9.0: in previous versions this assertion behaved like
containsSubsequenceand allowed other values between the sequence values.Example:
String book = "{ 'title':'A Game of Thrones', 'author':'George Martin'}"; // this assertion succeeds assertThat(book).containsSequence("'title'", ":", "'A Game of Thrones'"); // this assertion will fail because there are values between the expected sequence (e.g "'title':'") assertThat(book).containsSequence("{", "A Game of Thrones", "George Martin", "}"); // this one fails as ":" must come after "'title'" assertThat(book).containsSequence(":", "'title'", "'A Game of Thrones'");- Parameters:
values- the sequence of charSequence to look for, in order.- Returns:
thisassertion object.- Throws:
NullPointerException- if the given sequence of charSequence isnull.IllegalArgumentException- if the given sequence of charSequence is empty.AssertionError- if the givenCharSequenceisnull.AssertionError- if the givenCharSequencedoes not contain the given sequence of values in the given order without any other values between them.
-
containsSequence
public SELF containsSequence(Iterable<? extends CharSequence> values)
Verifies that the actualCharSequencecontains all the values of the given Iterable in the Iterable iteration order without any other values between them.Breaking change since 2.9.0: in previous versions this assertion behaved like
containsSubsequenceand allowed other values between the 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 assertion will fail because there are values between the expected sequence (e.g "'title':'") assertThat(book).containsSequence(asList("{", "A Game of Thrones", "George Martin", "}")); // this one fails as "author" must come after "A Game of Thrones" assertThat(book).containsSequence(asList("author", "A Game of Thrones"));- Parameters:
values- the sequence of charSequence to look for, in order.- Returns:
thisassertion object.- Throws:
NullPointerException- if the given sequence of charSequence isnull.IllegalArgumentException- if the given sequence of charSequence is empty.AssertionError- if the givenCharSequenceisnull.AssertionError- if the givenCharSequencedoes not contain the given sequence of values in the given order without any other charvalues between them.
-
containsSubsequence
public SELF containsSubsequence(CharSequence... values)
Verifies that the actualCharSequencecontains all the given values in the given order, possibly with other values between them.Example:
String book = "{ 'title':'A Game of Thrones', 'author':'George Martin'}"; // this assertion succeeds assertThat(book).containsSubsequence("'title'", ":", "'A Game of Thrones'"); // these ones succeed even if there are values between the given values assertThat(book).containsSubsequence("{", "A Game of Thrones", "George Martin", "}"); assertThat(book).containsSubsequence("A", "Game", "of", "George"); // this one fails as "author" must come after "A Game of Thrones" assertThat(book).containsSubsequence("{", "author", "A Game of Thrones", "}");- Parameters:
values- the Strings to look for, in order.- Returns:
thisassertion object.- Throws:
NullPointerException- if the given values isnull.IllegalArgumentException- if the given values is empty.AssertionError- if the actualCharSequenceisnull.AssertionError- if the actualCharSequencedoes not contain all the given values in the given order.
-
containsSubsequence
public SELF containsSubsequence(Iterable<? extends CharSequence> values)
Verifies that the actualCharSequencecontains all the values of the given Iterable in the Iterable iteration order (possibly with other values between them).Example:
String book = "{ 'title':'A Game of Thrones', 'author':'George Martin'}"; // this assertion succeeds assertThat(book).containsSubsequence(asList("'title'", ":", "'A Game of Thrones'")); // these ones succeed even if there are values between the given values assertThat(book).containsSubsequence(asList("{", "A Game of Thrones", "George Martin", "}")); assertThat(book).containsSubsequence(asList("A", "Game", "of", "George")); // but this one fails as "author" must come after "A Game of Thrones" assertThat(book).containsSubsequence(asList("{", "author", "A Game of Thrones", "}"));- Parameters:
values- the Strings to look for, in order.- Returns:
thisassertion object.- Throws:
NullPointerException- if the given values isnull.IllegalArgumentException- if the given values is empty.AssertionError- if the actualCharSequenceisnull.AssertionError- if the actualCharSequencedoes not contain all the given values in the given order.
-
containsIgnoringCase
public SELF containsIgnoringCase(CharSequence sequence)
Verifies that the actualCharSequencecontains 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:
thisassertion object.- Throws:
NullPointerException- if the given sequence isnull.AssertionError- if the actualCharSequenceisnull.AssertionError- if the actualCharSequencedoes not contain the given one.
-
doesNotContain
public SELF doesNotContain(CharSequence... values)
Verifies that the actualCharSequencedoes not contain any of the given values.Example :
// assertion will pass assertThat("Frodo").doesNotContain("pippin") .doesNotContain("fro", "sam"); // assertion will fail assertThat("Frodo").doesNotContain("Fro", "Gimli", "Legolas");- Parameters:
values- the CharSequences to search for.- Returns:
thisassertion object.- Throws:
NullPointerException- if the given list of values isnull.IllegalArgumentException- if the list of given values is empty.AssertionError- if the actualCharSequenceisnull.AssertionError- if the actualCharSequencecontains any of the given values.
-
doesNotContain
public SELF doesNotContain(Iterable<? extends CharSequence> values)
Verifies that the actualCharSequencedoes not contain any of the given Iterable.Example :
// assertion will pass assertThat("Frodo").doesNotContain(Arrays.asList("")) .doesNotContain(Arrays.asList("fro", "sam")); // assertion will fail assertThat("Frodo").doesNotContain(Arrays.asList("Fro", "Gimli", "Legolas"));- Parameters:
values- the CharSequences to search for.- Returns:
thisassertion object.- Throws:
NullPointerException- if the given list of values isnull.IllegalArgumentException- if the list of given values is empty.AssertionError- if the actualCharSequenceisnull.AssertionError- if the actualCharSequencecontains any of the given values.
-
doesNotContainPattern
public SELF doesNotContainPattern(CharSequence pattern)
Verifies that the actualCharSequencedoes 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 actualCharSequence.- Returns:
thisassertion object.- Throws:
NullPointerException- if the given pattern isnull.PatternSyntaxException- if the regular expression's syntax is invalid.AssertionError- if the actualCharSequenceisnull.AssertionError- if the given regular expression can be found in the actualCharSequence.- Since:
- 2.7.0 / 3.7.0
-
doesNotContainPattern
public SELF doesNotContainPattern(Pattern pattern)
Verifies that the actualCharSequencedoes 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 actualCharSequence.- Returns:
thisassertion object.- Throws:
NullPointerException- if the given pattern isnull.AssertionError- if the actualCharSequenceisnull.AssertionError- if the given regular expression can be found in the actualCharSequence.- Since:
- 2.7.0 / 3.7.0
-
startsWith
public SELF startsWith(CharSequence prefix)
Verifies that the actualCharSequencestarts 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:
thisassertion object.- Throws:
NullPointerException- if the given prefix isnull.AssertionError- if the actualCharSequenceisnull.AssertionError- if the actualCharSequencedoes not start with the given prefix.
-
doesNotStartWith
public SELF doesNotStartWith(CharSequence prefix)
Verifies that the actualCharSequencedoes 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:
thisassertion object.- Throws:
NullPointerException- if the given prefix isnull.AssertionError- if the actualCharSequenceisnull.AssertionError- if the actualCharSequencestarts with the given prefix.
-
endsWith
public SELF endsWith(CharSequence suffix)
Verifies that the actualCharSequenceends 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:
thisassertion object.- Throws:
NullPointerException- if the given suffix isnull.AssertionError- if the actualCharSequenceisnull.AssertionError- if the actualCharSequencedoes not end with the given suffix.
-
doesNotEndWith
public SELF doesNotEndWith(CharSequence suffix)
Verifies that the actualCharSequencedoes 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:
thisassertion object.- Throws:
NullPointerException- if the given suffix isnull.AssertionError- if the actualCharSequenceisnull.AssertionError- if the actualCharSequenceends with the given suffix.
-
matches
public SELF matches(CharSequence regex)
Verifies that the actualCharSequencematches 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 actualCharSequenceis to be matched.- Returns:
thisassertion object.- Throws:
NullPointerException- if the given pattern isnull.PatternSyntaxException- if the regular expression's syntax is invalid.AssertionError- if the actualCharSequenceisnull.AssertionError- if the actualCharSequencedoes not match the given regular expression.
-
doesNotMatch
public SELF doesNotMatch(CharSequence regex)
Verifies that the actualCharSequencedoes 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 actualCharSequenceis to be matched.- Returns:
thisassertion object.- Throws:
NullPointerException- if the given pattern isnull.PatternSyntaxException- if the regular expression's syntax is invalid.AssertionError- if the actualCharSequenceisnull.AssertionError- if the actualCharSequencematches the given regular expression.
-
matches
public SELF matches(Pattern pattern)
Verifies that the actualCharSequencematches 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 actualCharSequenceis to be matched.- Returns:
thisassertion object.- Throws:
NullPointerException- if the given pattern isnull.AssertionError- if the actualCharSequenceisnull.AssertionError- if the actualCharSequencedoes not match the given regular expression.
-
doesNotMatch
public SELF doesNotMatch(Pattern pattern)
Verifies that the actualCharSequencedoes 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 actualCharSequenceis to be matched.- Returns:
thisassertion object.- Throws:
NullPointerException- if the given pattern isnull.AssertionError- if the actualCharSequencedoes not match the given regular expression.
-
isXmlEqualTo
public SELF isXmlEqualTo(CharSequence expectedXml)
Verifies that the actualCharSequenceis equal to the given XMLCharSequenceafter 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 XMLCharSequenceto which the actualCharSequenceis to be compared to.- Returns:
thisassertion object to chain other assertions.- Throws:
NullPointerException- if the givenCharSequenceisnull.AssertionError- if the actualCharSequenceisnullor is not the same XML as the given XMLCharSequence.
-
isXmlEqualToContentOf
public SELF isXmlEqualToContentOf(File xmlFile)
Verifies that the actualCharSequenceis equal to the content of the given file.This is an handy shortcut that calls :
Example :isXmlEqualTo(contentOf(xmlFile))// 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 actualCharSequence- Returns:
thisassertion object to chain other assertions.- Throws:
NullPointerException- if the givenFileisnull.AssertionError- if the actualCharSequenceisnullor is not the same XML as the content of givenFile.
-
usingElementComparator
@Deprecated public final SELF usingElementComparator(Comparator<? super Character> customComparator)
Deprecated.Custom element Comparator is not supported for CharSequence comparison.Do not use this method.- Specified by:
usingElementComparatorin interfaceEnumerableAssert<SELF extends AbstractCharSequenceAssert<SELF,ACTUAL>,ACTUAL extends CharSequence>- Parameters:
customComparator- the comparator to use for incoming assertion checks.- Returns:
thisassertion object.- Throws:
UnsupportedOperationException- if this method is called.
-
usingDefaultElementComparator
@Deprecated public final SELF usingDefaultElementComparator()
Deprecated.Custom element Comparator is not supported for CharSequence comparison.Do not use this method.- Specified by:
usingDefaultElementComparatorin interfaceEnumerableAssert<SELF extends AbstractCharSequenceAssert<SELF,ACTUAL>,ACTUAL extends CharSequence>- Returns:
thisassertion object.- Throws:
UnsupportedOperationException- if this method is called.
-
usingComparator
public SELF usingComparator(Comparator<? super ACTUAL> customComparator)
Description copied from class:AbstractAssertUse the given custom comparator instead of relying on actual type A equals method for incoming assertion checks.The custom comparator is bound to assertion instance, meaning that if a new assertion instance is created, the default comparison strategy will be used.
Examples :
// frodo and sam are instances of Character with Hobbit race (obviously :). // raceComparator implements Comparator<Character> assertThat(frodo).usingComparator(raceComparator).isEqualTo(sam);- Specified by:
usingComparatorin interfaceAssert<SELF extends AbstractCharSequenceAssert<SELF,ACTUAL>,ACTUAL extends CharSequence>- Overrides:
usingComparatorin classAbstractAssert<SELF extends AbstractCharSequenceAssert<SELF,ACTUAL>,ACTUAL extends CharSequence>- Parameters:
customComparator- the comparator to use for the incoming assertion checks.- Returns:
thisassertion object.
-
usingComparator
public SELF usingComparator(Comparator<? super ACTUAL> customComparator, String customComparatorDescription)
Description copied from class:AbstractAssertUse the given custom comparator instead of relying on actual type A equals method for incoming assertion checks.The custom comparator is bound to assertion instance, meaning that if a new assertion instance is created, the default comparison strategy will be used.
Examples :
// frodo and sam are instances of Character with Hobbit race (obviously :). // raceComparator implements Comparator<Character> assertThat(frodo).usingComparator(raceComparator, "Hobbit Race Comparator").isEqualTo(sam);- Specified by:
usingComparatorin interfaceAssert<SELF extends AbstractCharSequenceAssert<SELF,ACTUAL>,ACTUAL extends CharSequence>- Overrides:
usingComparatorin classAbstractAssert<SELF extends AbstractCharSequenceAssert<SELF,ACTUAL>,ACTUAL extends CharSequence>- Parameters:
customComparator- the comparator to use for the incoming assertion checks.customComparatorDescription- comparator description to be used in assertion error messages- Returns:
thisassertion object.
-
usingDefaultComparator
public SELF usingDefaultComparator()
Description copied from class:AbstractAssertRevert to standard comparison for the incoming assertion checks.This method should be used to disable a custom comparison strategy set by calling
usingComparator.- Specified by:
usingDefaultComparatorin interfaceAssert<SELF extends AbstractCharSequenceAssert<SELF,ACTUAL>,ACTUAL extends CharSequence>- Overrides:
usingDefaultComparatorin classAbstractAssert<SELF extends AbstractCharSequenceAssert<SELF,ACTUAL>,ACTUAL extends CharSequence>- Returns:
thisassertion object.
-
inHexadecimal
public SELF inHexadecimal()
Description copied from class:AbstractAssertUse 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:
With Hexadecimal message:assertThat("µµµ").contains("μμμ"); java.lang.AssertionError: Expecting: <"µµµ"> to contain: <"μμμ">assertThat("µµµ").inHexadecimal().contains("μμμ"); java.lang.AssertionError: Expecting: <"['00B5', '00B5', '00B5']"> to contain: <"['03BC', '03BC', '03BC']">- Overrides:
inHexadecimalin classAbstractAssert<SELF extends AbstractCharSequenceAssert<SELF,ACTUAL>,ACTUAL extends CharSequence>- Returns:
thisassertion 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:
With Hexadecimal message:assertThat("µµµ").contains("μμμ"); java.lang.AssertionError: Expecting: <"µµµ"> to contain: <"μμμ">assertThat("µµµ").inUnicode().contains("μμμ"); java.lang.AssertionError: Expecting: <µµµ> to contain: <μμμ>- Returns:
thisassertion object.
-
isEqualToIgnoringWhitespace
public SELF isEqualToIgnoringWhitespace(CharSequence expected)
Verifies that the actualCharSequenceis equal to the given one, ignoring whitespace differencesExamples :
// 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 givenCharSequenceto compare the actualCharSequenceto.- Returns:
thisassertion object.- Throws:
AssertionError- if the actualCharSequenceis not equal ignoring whitespace differences to the given one.
-
isNotEqualToIgnoringWhitespace
public SELF isNotEqualToIgnoringWhitespace(CharSequence expected)
Verifies that the actualCharSequenceis 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 givenCharSequenceto compare the actualCharSequenceto.- Returns:
thisassertion object.- Throws:
AssertionError- if the actualCharSequenceis equal ignoring whitespace differences to the given one.
-
isEqualToNormalizingWhitespace
public SELF isEqualToNormalizingWhitespace(CharSequence expected)
Verifies that the actualCharSequenceis 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 givenCharSequenceto compare the actualCharSequenceto.- Returns:
thisassertion object.- Throws:
AssertionError- if the actualCharSequenceis 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 actualCharSequenceis 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 givenCharSequenceto compare the actualCharSequenceto.- Returns:
thisassertion object.- Throws:
AssertionError- if the actualCharSequenceis 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 actualCharSequenceis a substring of the given one (opposite assertion ofcontains(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:
thisassertion object.- Throws:
AssertionError- if the actualCharSequenceis not a substring of the given parameter.
-
containsPattern
public SELF containsPattern(CharSequence regex)
Verifies that the actualCharSequencecontains 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 actualCharSequence.- Returns:
thisassertion object.- Throws:
NullPointerException- if the given pattern isnull.PatternSyntaxException- if the regular expression's syntax is invalid.AssertionError- if the actualCharSequenceisnull.AssertionError- if the given regular expression cannot be found in the actualCharSequence.
-
containsPattern
public SELF containsPattern(Pattern pattern)
Verifies that the actualCharSequencecontains 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 actualCharSequence.- Returns:
thisassertion object.- Throws:
NullPointerException- if the given pattern isnull.AssertionError- if the actualCharSequenceisnull.AssertionError- if the given regular expression cannot be found in the actualCharSequence.
-
isEqualToNormalizingNewlines
public SELF isEqualToNormalizingNewlines(CharSequence expected)
Verifies that the actualCharSequenceis equals to anotherCharSequenceafter normalizing new line characters (i.e. '\r\n' == '\n').This assertion will succeed:
Whereas this assertion will fail:String bookName = "Lord of the Rings\r\n"; assertThat(bookName).isEqualToNormalizingNewlines("Lord of the Rings\n");String singleLine = "\n"; assertThat(singleLine).isEqualToNormalizingNewlines("");- Parameters:
expected- the givenCharSequenceto compare the actualCharSequenceto.- Returns:
thisassertion object.- Throws:
AssertionError- if the actualCharSequenceand the givenCharSequenceare different after new lines are normalized.- Since:
- 2.7.0 / 3.7.0
-
isEqualToIgnoringNewLines
public SELF isEqualToIgnoringNewLines(CharSequence expected)
Verifies that the actualCharSequenceis equal to the given one after both strings new lines (\n, \r\n) have been removed.Example :
// assertions will pass assertThat("Some textWith new lines").isEqualToIgnoringNewLines("Some text\nWith new lines") .isEqualToIgnoringNewLines("Some text\r\nWith new lines") .isEqualToIgnoringNewLines("Some text\n\nWith new lines"); assertThat("Some text\nWith new lines").isEqualToIgnoringNewLines("Some text\nWith new lines") .isEqualToIgnoringNewLines("Some text\r\nWith new lines") .isEqualToIgnoringNewLines("Some text\n\nWith new lines"); // assertions will fail assertThat("Some text\nWith new lines").isEqualToIgnoringNewLines("Some text With new lines"); assertThat("Some text\r\nWith new lines").isEqualToIgnoringNewLines("Some text With new lines");- Parameters:
expected- the givenCharSequenceto compare the actualCharSequenceto.- Returns:
thisassertion object.- Throws:
AssertionError- if the actualCharSequenceis not equal to the given one after new lines have been removed.
-
isLowerCase
public SELF isLowerCase()
Verifies that the actualCharSequenceis a lowercaseCharSequenceby comparing it to a lowercaseactualbuilt withString.toLowerCase().Example :
// assertions will pass assertThat("lego").isLowerCase(); assertThat("").isLowerCase(); assertThat(" ").isLowerCase(); assertThat(".").isLowerCase(); assertThat("7").isLowerCase(); assertThat("a.7").isLowerCase(); // assertions will fail assertThat("Lego").isLowerCase(); assertThat("LEGO").isLowerCase();- Returns:
thisassertion object.- Throws:
AssertionError- if the actualCharSequenceis not lowercase.
-
isUpperCase
public SELF isUpperCase()
Verifies that the actualCharSequenceis a uppercaseCharSequenceby comparing it to an uppercaseactualbuilt withString.toUpperCase().Example :
// assertions will pass assertThat("LEGO").isUpperCase(); assertThat("").isUpperCase(); assertThat(" ").isUpperCase(); assertThat(".").isUpperCase(); assertThat("7").isUpperCase(); assertThat("A.7").isUpperCase(); // assertions will fail assertThat("Lego").isUpperCase(); assertThat("lego").isUpperCase();- Returns:
thisassertion object.- Throws:
AssertionError- if the actualCharSequenceis not uppercase.
-
-