Package org.fest.assertions.api
Class StringAssert
- java.lang.Object
-
- org.fest.assertions.api.AbstractAssert<StringAssert,java.lang.String>
-
- org.fest.assertions.api.StringAssert
-
- All Implemented Interfaces:
Assert<StringAssert,java.lang.String>
,Descriptable<StringAssert>
,EnumerableAssert<StringAssert,java.lang.String>
,ExtensionPoints<StringAssert,java.lang.String>
public class StringAssert extends AbstractAssert<StringAssert,java.lang.String> implements EnumerableAssert<StringAssert,java.lang.String>
Assertion methods forString
s.To create a new instance of this class, invoke
.Assertions.assertThat(String)
- Author:
- Yvonne Wang, David DIDIER, Alex Ruiz, Joel Costigliola, Mikhail Mazursky, Nicolas Francois
-
-
Field Summary
-
Fields inherited from class org.fest.assertions.api.AbstractAssert
actual, myself
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
StringAssert(java.lang.String actual)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description StringAssert
contains(java.lang.String sequence)
Verifies that the actualString
contains the given sequence.StringAssert
containsIgnoringCase(java.lang.String sequence)
Verifies that the actualString
contains the given sequence, ignoring case considerations.StringAssert
containsOnlyOnce(java.lang.String sequence)
Verifies that the actualString
contains only once the given sequence.StringAssert
doesNotContain(java.lang.String sequence)
Verifies that the actualString
does not contain the given sequence.StringAssert
doesNotMatch(java.lang.String regex)
Verifies that the actualString
does not match the given regular expression.StringAssert
doesNotMatch(java.util.regex.Pattern pattern)
Verifies that the actualString
does not match the given regular expression.StringAssert
endsWith(java.lang.String suffix)
Verifies that the actualString
ends with the given suffix.StringAssert
hasSameSizeAs(java.lang.Iterable<?> other)
Verifies that the actual group has the same size as givenIterable
.StringAssert
hasSameSizeAs(java.lang.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(java.lang.String expected)
Verifies that the actualString
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 isnull
or empty.StringAssert
matches(java.lang.String regex)
Verifies that the actualString
matches the given regular expression.StringAssert
matches(java.util.regex.Pattern pattern)
Verifies that the actualString
matches the given regular expression.StringAssert
startsWith(java.lang.String prefix)
Verifies that the actualString
starts with the given prefix.StringAssert
usingComparator(java.util.Comparator<? super java.lang.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(java.util.Comparator<? super java.lang.String> customComparator)
Use given custom comparator instead of relying on actual type Aequals
method to compare group elements for incoming assertion checks.-
Methods inherited from class org.fest.assertions.api.AbstractAssert
as, as, describedAs, describedAs, descriptionText, doesNotHave, doesNotHaveSameClassAs, equals, 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
-
-
-
-
Method Detail
-
isNullOrEmpty
public void isNullOrEmpty()
Verifies that the actual group of values isnull
or empty.- Specified by:
isNullOrEmpty
in interfaceEnumerableAssert<StringAssert,java.lang.String>
-
isEmpty
public void isEmpty()
Verifies that the actual group of values is empty.- Specified by:
isEmpty
in interfaceEnumerableAssert<StringAssert,java.lang.String>
-
isNotEmpty
public StringAssert isNotEmpty()
Verifies that the actual group of values is not empty.- Specified by:
isNotEmpty
in interfaceEnumerableAssert<StringAssert,java.lang.String>
- Returns:
this
assertion object.
-
hasSize
public StringAssert hasSize(int expected)
Verifies that the number of values in the actual group is equal to the given one.- Specified by:
hasSize
in interfaceEnumerableAssert<StringAssert,java.lang.String>
- Parameters:
expected
- the expected number of values in the actual group.- Returns:
this
assertion object.
-
hasSameSizeAs
public StringAssert hasSameSizeAs(java.lang.Object[] other)
Verifies that the actual group has the same size as given array.- Specified by:
hasSameSizeAs
in interfaceEnumerableAssert<StringAssert,java.lang.String>
- Parameters:
other
- the array to compare size with actual group.- Returns:
this
assertion object.
-
hasSameSizeAs
public StringAssert hasSameSizeAs(java.lang.Iterable<?> other)
Verifies that the actual group has the same size as givenIterable
.- Specified by:
hasSameSizeAs
in interfaceEnumerableAssert<StringAssert,java.lang.String>
- Parameters:
other
- theIterable
to compare size with actual group.- Returns:
this
assertion object.
-
isEqualToIgnoringCase
public StringAssert isEqualToIgnoringCase(java.lang.String expected)
Verifies that the actualString
is equal to the given one, ignoring case considerations.- Parameters:
expected
- the givenString
to compare the actualString
to.- Returns:
this
assertion object.- Throws:
java.lang.AssertionError
- if the actualString
is not equal to the given one.
-
containsOnlyOnce
public StringAssert containsOnlyOnce(java.lang.String sequence)
Verifies that the actualString
contains only once the given sequence.- Parameters:
sequence
- the sequence to search for.- Returns:
this
assertion object.- Throws:
java.lang.AssertionError
- if the actualString
does not contain the given one, or contain it multiple times.
-
contains
public StringAssert contains(java.lang.String sequence)
Verifies that the actualString
contains the given sequence.- Parameters:
sequence
- the sequence to search for.- Returns:
this
assertion object.- Throws:
java.lang.NullPointerException
- if the given sequence isnull
.java.lang.AssertionError
- if the actualString
isnull
.java.lang.AssertionError
- if the actualString
does not contain the given one.
-
containsIgnoringCase
public StringAssert containsIgnoringCase(java.lang.String sequence)
Verifies that the actualString
contains the given sequence, ignoring case considerations.- Parameters:
sequence
- the sequence to search for.- Returns:
this
assertion object.- Throws:
java.lang.NullPointerException
- if the given sequence isnull
.java.lang.AssertionError
- if the actualString
isnull
.java.lang.AssertionError
- if the actualString
does not contain the given one.
-
doesNotContain
public StringAssert doesNotContain(java.lang.String sequence)
Verifies that the actualString
does not contain the given sequence.- Parameters:
sequence
- the sequence to search for.- Returns:
this
assertion object.- Throws:
java.lang.NullPointerException
- if the given sequence isnull
.java.lang.AssertionError
- if the actualString
isnull
.java.lang.AssertionError
- if the actualString
contains the given one.
-
startsWith
public StringAssert startsWith(java.lang.String prefix)
Verifies that the actualString
starts with the given prefix.- Parameters:
prefix
- the given prefix.- Returns:
this
assertion object.- Throws:
java.lang.NullPointerException
- if the given prefix isnull
.java.lang.AssertionError
- if the actualString
isnull
.java.lang.AssertionError
- if the actualString
does not start with the given prefix.
-
endsWith
public StringAssert endsWith(java.lang.String suffix)
Verifies that the actualString
ends with the given suffix.- Parameters:
suffix
- the given suffix.- Returns:
this
assertion object.- Throws:
java.lang.NullPointerException
- if the given suffix isnull
.java.lang.AssertionError
- if the actualString
isnull
.java.lang.AssertionError
- if the actualString
does not end with the given suffix.
-
matches
public StringAssert matches(java.lang.String regex)
Verifies that the actualString
matches the given regular expression.- Parameters:
regex
- the regular expression to which the actualString
is to be matched.- Returns:
this
assertion object.- Throws:
java.lang.NullPointerException
- if the given pattern isnull
.java.util.regex.PatternSyntaxException
- if the regular expression's syntax is invalid.java.lang.AssertionError
- if the actualString
isnull
.java.lang.AssertionError
- if the actualString
does not match the given regular expression.
-
doesNotMatch
public StringAssert doesNotMatch(java.lang.String regex)
Verifies that the actualString
does not match the given regular expression.- Parameters:
regex
- the regular expression to which the actualString
is to be matched.- Returns:
this
assertion object.- Throws:
java.lang.NullPointerException
- if the given pattern isnull
.java.util.regex.PatternSyntaxException
- if the regular expression's syntax is invalid.java.lang.AssertionError
- if the actualString
isnull
.java.lang.AssertionError
- if the actualString
matches the given regular expression.
-
matches
public StringAssert matches(java.util.regex.Pattern pattern)
Verifies that the actualString
matches the given regular expression.- Parameters:
pattern
- the regular expression to which the actualString
is to be matched.- Returns:
this
assertion object.- Throws:
java.lang.NullPointerException
- if the given pattern isnull
.java.lang.AssertionError
- if the actualString
isnull
.java.lang.AssertionError
- if the actualString
does not match the given regular expression.
-
doesNotMatch
public StringAssert doesNotMatch(java.util.regex.Pattern pattern)
Verifies that the actualString
does not match the given regular expression.- Parameters:
pattern
- the regular expression to which the actualString
is to be matched.- Returns:
this
assertion object.- Throws:
java.lang.NullPointerException
- if the given pattern isnull
.java.lang.AssertionError
- if the actualString
does not match the given regular expression.
-
usingElementComparator
public StringAssert usingElementComparator(java.util.Comparator<? super java.lang.String> customComparator)
Use given custom comparator instead of relying on actual type Aequals
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);
- Specified by:
usingElementComparator
in interfaceEnumerableAssert<StringAssert,java.lang.String>
- Parameters:
customComparator
- the comparator to use for incoming assertion checks.- Returns:
this
assertion object.
-
usingDefaultElementComparator
public StringAssert usingDefaultElementComparator()
Revert to standard comparison for incoming assertion group element checks.This method should be used to disable a custom comparison strategy set by calling
EnumerableAssert.usingElementComparator(Comparator)
.- Specified by:
usingDefaultElementComparator
in interfaceEnumerableAssert<StringAssert,java.lang.String>
- Returns:
this
assertion object.
-
usingComparator
public StringAssert usingComparator(java.util.Comparator<? super java.lang.String> customComparator)
Description copied from class:AbstractAssert
Use given custom comparator instead of relying on actual type A equals method 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 :
// frodo and sam are instances of Character with Hobbit race (obviously :). // raceComparator implements Comparator<Character> assertThat(frodo).usingComparator(raceComparator).isEqualTo(sam);
- Specified by:
usingComparator
in interfaceAssert<StringAssert,java.lang.String>
- Overrides:
usingComparator
in classAbstractAssert<StringAssert,java.lang.String>
- Parameters:
customComparator
- the comparator to use for incoming assertion checks.- Returns:
this
assertion object.
-
usingDefaultComparator
public StringAssert usingDefaultComparator()
Description copied from class:AbstractAssert
Revert to standard comparison for incoming assertion checks.This method should be used to disable a custom comparison strategy set by calling
Assert.usingComparator(Comparator)
.- Specified by:
usingDefaultComparator
in interfaceAssert<StringAssert,java.lang.String>
- Overrides:
usingDefaultComparator
in classAbstractAssert<StringAssert,java.lang.String>
- Returns:
this
assertion object.
-
-