public class StringAssert extends AbstractAssert<StringAssert,String> implements EnumerableAssert<StringAssert,String>
String
s.
To create a new instance of this class, invoke
.
Assertions.assertThat(String)
actual, info, myself
Modifier | Constructor and Description |
---|---|
protected |
StringAssert(String actual) |
Modifier and Type | Method and Description |
---|---|
StringAssert |
contains(String... values)
Verifies that the actual
String contains all the given strings. |
StringAssert |
containsIgnoringCase(String sequence)
Verifies that the actual
String contains the given sequence, ignoring case considerations. |
StringAssert |
containsOnlyOnce(String sequence)
Verifies that the actual
String contains only once the given sequence. |
StringAssert |
containsSequence(String... values)
Verifies that the actual
String contains all the given strings in the given order. |
StringAssert |
doesNotContain(String sequence)
Verifies that the actual
String does not contain the given sequence. |
StringAssert |
doesNotMatch(Pattern pattern)
Verifies that the actual
String does not match the given regular expression. |
StringAssert |
doesNotMatch(String regex)
Verifies that the actual
String does not match the given regular expression. |
StringAssert |
endsWith(String suffix)
Verifies that the actual
String ends with the given suffix. |
StringAssert |
hasSameSizeAs(Iterable<?> other)
Verifies that the actual group has the same size as given
Iterable . |
StringAssert |
hasSameSizeAs(Object[] other)
Verifies that the actual group has the same size as given array.
|
StringAssert |
hasSize(int expected)
Verifies that the number of values in the actual group is equal to the given one.
|
void |
isEmpty()
Verifies that the actual group of values is empty.
|
StringAssert |
isEqualToIgnoringCase(String expected)
Verifies that the actual
String is equal to the given one, ignoring case considerations. |
StringAssert |
isNotEmpty()
Verifies that the actual group of values is not empty.
|
void |
isNullOrEmpty()
Verifies that the actual group of values is
null or empty. |
StringAssert |
matches(Pattern pattern)
Verifies that the actual
String matches the given regular expression. |
StringAssert |
matches(String regex)
Verifies that the actual
String matches the given regular expression. |
StringAssert |
startsWith(String prefix)
Verifies that the actual
String starts with the given prefix. |
StringAssert |
usingComparator(Comparator<? super String> customComparator)
Use given custom comparator instead of relying on actual type A equals method for incoming assertion checks.
|
StringAssert |
usingDefaultComparator()
Revert to standard comparison for incoming assertion checks.
|
StringAssert |
usingDefaultElementComparator()
Revert to standard comparison for incoming assertion group element checks.
|
StringAssert |
usingElementComparator(Comparator<? super String> customComparator)
Use given custom comparator instead of relying on actual type A
equals method to compare group elements for
incoming assertion checks. |
as, as, describedAs, describedAs, descriptionText, doesNotHave, doesNotHaveSameClassAs, equals, failWithMessage, getWritableAssertionInfo, has, hashCode, hasSameClassAs, is, isEqualTo, isExactlyInstanceOf, isIn, isIn, isInstanceOf, isInstanceOfAny, isNot, isNotEqualTo, isNotExactlyInstanceOf, isNotIn, isNotIn, isNotInstanceOf, isNotInstanceOfAny, isNotNull, isNotOfAnyClassIn, isNotSameAs, isNull, isOfAnyClassIn, isSameAs, overridingErrorMessage
protected StringAssert(String actual)
public void isNullOrEmpty()
null
or empty.isNullOrEmpty
in interface EnumerableAssert<StringAssert,String>
public void isEmpty()
isEmpty
in interface EnumerableAssert<StringAssert,String>
public StringAssert isNotEmpty()
isNotEmpty
in interface EnumerableAssert<StringAssert,String>
this
assertion object.public StringAssert hasSize(int expected)
hasSize
in interface EnumerableAssert<StringAssert,String>
expected
- the expected number of values in the actual group.this
assertion object.public StringAssert hasSameSizeAs(Object[] other)
hasSameSizeAs
in interface EnumerableAssert<StringAssert,String>
other
- the array to compare size with actual group.this
assertion object.public StringAssert hasSameSizeAs(Iterable<?> other)
Iterable
.hasSameSizeAs
in interface EnumerableAssert<StringAssert,String>
other
- the Iterable
to compare size with actual group.this
assertion object.public StringAssert isEqualToIgnoringCase(String expected)
String
is equal to the given one, ignoring case considerations.expected
- the given String
to compare the actual String
to.this
assertion object.AssertionError
- if the actual String
is not equal to the given one.public StringAssert containsOnlyOnce(String sequence)
String
contains only once the given sequence.sequence
- the sequence to search for.this
assertion object.AssertionError
- if the actual String
does not contain the given one, or contain it multiple times.public StringAssert contains(String... values)
String
contains all the given strings.
You can use one or several strings as in the example below
assertThat("Gandalf the grey").contains("alf"); assertThat("Gandalf the grey").contains("alf", "grey");
values
- the Strings to look for.this
assertion object.NullPointerException
- if the given values is null
.IllegalArgumentException
- if the given values is empty.AssertionError
- if the actual String
is null
.AssertionError
- if the actual String
does not contain all the given strings.public StringAssert containsSequence(String... values)
String
contains all the given strings in the given order.
Example :
String book = "{ 'title':'A Game of Thrones', 'author':'George Martin'}"; // this assertion succeeds ... assertThat(book).containsSequence("{", "title", "A Game of Thrones", "}"); // ... but this one fails as "author" must come after "A Game of Thrones" assertThat(book).containsSequence("{", "author", "A Game of Thrones", "}");
values
- the Strings to look for in order.this
assertion object.NullPointerException
- if the given values is null
.IllegalArgumentException
- if the given values is empty.AssertionError
- if the actual String
is null
.AssertionError
- if the actual String
does not contain all the given strings in the given order.public StringAssert containsIgnoringCase(String sequence)
String
contains the given sequence, ignoring case considerations.sequence
- the sequence to search for.this
assertion object.NullPointerException
- if the given sequence is null
.AssertionError
- if the actual String
is null
.AssertionError
- if the actual String
does not contain the given one.public StringAssert doesNotContain(String sequence)
String
does not contain the given sequence.sequence
- the sequence to search for.this
assertion object.NullPointerException
- if the given sequence is null
.AssertionError
- if the actual String
is null
.AssertionError
- if the actual String
contains the given one.public StringAssert startsWith(String prefix)
String
starts with the given prefix.prefix
- the given prefix.this
assertion object.NullPointerException
- if the given prefix is null
.AssertionError
- if the actual String
is null
.AssertionError
- if the actual String
does not start with the given prefix.public StringAssert endsWith(String suffix)
String
ends with the given suffix.suffix
- the given suffix.this
assertion object.NullPointerException
- if the given suffix is null
.AssertionError
- if the actual String
is null
.AssertionError
- if the actual String
does not end with the given suffix.public StringAssert matches(String regex)
String
matches the given regular expression.regex
- the regular expression to which the actual String
is to be matched.this
assertion object.NullPointerException
- if the given pattern is null
.PatternSyntaxException
- if the regular expression's syntax is invalid.AssertionError
- if the actual String
is null
.AssertionError
- if the actual String
does not match the given regular expression.public StringAssert doesNotMatch(String regex)
String
does not match the given regular expression.regex
- the regular expression to which the actual String
is to be matched.this
assertion object.NullPointerException
- if the given pattern is null
.PatternSyntaxException
- if the regular expression's syntax is invalid.AssertionError
- if the actual String
is null
.AssertionError
- if the actual String
matches the given regular expression.public StringAssert matches(Pattern pattern)
String
matches the given regular expression.pattern
- the regular expression to which the actual String
is to be matched.this
assertion object.NullPointerException
- if the given pattern is null
.AssertionError
- if the actual String
is null
.AssertionError
- if the actual String
does not match the given regular expression.public StringAssert doesNotMatch(Pattern pattern)
String
does not match the given regular expression.pattern
- the regular expression to which the actual String
is to be matched.this
assertion object.NullPointerException
- if the given pattern is null
.AssertionError
- if the actual String
does not match the given regular expression.public StringAssert usingElementComparator(Comparator<? super String> customComparator)
equals
method to compare group elements for
incoming assertion checks.
Custom comparator is bound to assertion instance, meaning that if a new assertion is created, it will use default comparison strategy.
Examples :
// compares invoices by payee assertThat(invoiceList).usingComparator(invoicePayeeComparator).isEqualTo(expectedInvoiceList). // compares invoices by date, doesNotHaveDuplicates and contains both use the given invoice date comparator assertThat(invoiceList).usingComparator(invoiceDateComparator).doesNotHaveDuplicates().contains(may2010Invoice) // as assertThat(invoiceList) creates a new assertion, it falls back to standard comparison strategy // based on Invoice's equal method to compare invoiceList elements to lowestInvoice. assertThat(invoiceList).contains(lowestInvoice). // standard comparison : the fellowshipOfTheRing includes Gandalf but not Sauron (believe me) ... assertThat(fellowshipOfTheRing).contains(gandalf) .doesNotContain(sauron); // ... but if we compare only races, Sauron is in fellowshipOfTheRing because he's a Maia like Gandalf. assertThat(fellowshipOfTheRing).usingElementComparator(raceComparator) .contains(sauron);
usingElementComparator
in interface EnumerableAssert<StringAssert,String>
customComparator
- the comparator to use for incoming assertion checks.this
assertion object.public StringAssert usingDefaultElementComparator()
This method should be used to disable a custom comparison strategy set by calling EnumerableAssert.usingElementComparator(Comparator)
.
usingDefaultElementComparator
in interface EnumerableAssert<StringAssert,String>
this
assertion object.public StringAssert usingComparator(Comparator<? super String> customComparator)
AbstractAssert
Custom comparator is bound to assertion instance, meaning that if a new assertion is created, it will use default comparison strategy.
Examples :
// frodo and sam are instances of Character with Hobbit race (obviously :). // raceComparator implements Comparator<Character> assertThat(frodo).usingComparator(raceComparator).isEqualTo(sam);
usingComparator
in interface Assert<StringAssert,String>
usingComparator
in class AbstractAssert<StringAssert,String>
customComparator
- the comparator to use for incoming assertion checks.this
assertion object.public StringAssert usingDefaultComparator()
AbstractAssert
This method should be used to disable a custom comparison strategy set by calling Assert.usingComparator(Comparator)
.
usingDefaultComparator
in interface Assert<StringAssert,String>
usingDefaultComparator
in class AbstractAssert<StringAssert,String>
this
assertion object.Copyright © 2013 AssertJ. All Rights Reserved.