org.assertj.core.api

Class AbstractCharSequenceAssert<S extends AbstractCharSequenceAssert<S,A>,A extends CharSequence>

java.lang.Object

org.assertj.core.api.AbstractAssert<S,A>

org.assertj.core.api.AbstractCharSequenceAssert<S,A>

Type Parameters:

S - the "self" type of this assertion class. Please read "Emulating 'self types' using Java Generics to simplify fluent API implementation" for more details.

A - the type of the "actual" value.

All Implemented Interfaces:

Assert<S,A>, Descriptable<S>, EnumerableAssert<S,Character>, ExtensionPoints<S,A>

Direct Known Subclasses:

CharSequenceAssert, StringAssert

public abstract class AbstractCharSequenceAssert<S extends AbstractCharSequenceAssert<S,A>,A extends CharSequence>
extends AbstractAssert<S,A>
implements EnumerableAssert<S,Character>

Base class for all implementations of assertions for CharSequences.

Author:

Yvonne Wang, David DIDIER, Alex Ruiz, Joel Costigliola, Mikhail Mazursky, Nicolas Francois

Field Summary

Fields inherited from class org.assertj.core.api.AbstractAssert

actual, info, myself

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractCharSequenceAssert(A actual, Class<?> selfType)

Method Summary

Methods

Modifier and Type	Method and Description
S	contains(CharSequence... values) Verifies that the actual CharSequence contains all the given strings.
S	containsIgnoringCase(CharSequence sequence) Verifies that the actual CharSequence contains the given sequence, ignoring case considerations.
S	containsOnlyOnce(CharSequence sequence) Verifies that the actual CharSequence contains only once the given sequence.
S	containsSequence(CharSequence... values) Verifies that the actual CharSequence contains all the given strings in the given order.
S	doesNotContain(CharSequence sequence) Verifies that the actual CharSequence does not contain the given sequence.
S	doesNotMatch(CharSequence regex) Verifies that the actual CharSequence does not match the given regular expression.
S	doesNotMatch(Pattern pattern) Verifies that the actual CharSequence does not match the given regular expression.
S	endsWith(CharSequence suffix) Verifies that the actual CharSequence ends with the given suffix.
S	hasSameSizeAs(Iterable<?> other) Verifies that the actual group has the same size as given Iterable.
S	hasSameSizeAs(Object[] other) Verifies that the actual group has the same size as given array.
S	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.
S	isEqualToIgnoringCase(CharSequence expected) Verifies that the actual CharSequence is equal to the given one, ignoring case considerations.
S	isNotEmpty() Verifies that the actual group of values is not empty.
void	isNullOrEmpty() Verifies that the actual group of values is null or empty.
S	matches(CharSequence regex) Verifies that the actual CharSequence matches the given regular expression.
S	matches(Pattern pattern) Verifies that the actual CharSequence matches the given regular expression.
S	startsWith(CharSequence prefix) Verifies that the actual CharSequence starts with the given prefix.
S	usingComparator(Comparator<? super A> customComparator) Use given custom comparator instead of relying on actual type A equals method for incoming assertion checks.
S	usingDefaultComparator() Revert to standard comparison for incoming assertion checks.
S	usingDefaultElementComparator() Deprecated. Custom element Comparator is not supported for CharSequence comparison.
S	usingElementComparator(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, 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

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractCharSequenceAssert

protected AbstractCharSequenceAssert(A actual,
                          Class<?> selfType)

Method Detail

isNullOrEmpty

public void isNullOrEmpty()

Verifies that the actual group of values is null or empty.

Specified by:

isNullOrEmpty in interface EnumerableAssert<S extends AbstractCharSequenceAssert<S,A>,Character>

isEmpty

public void isEmpty()

Verifies that the actual group of values is empty.

Specified by:

isEmpty in interface EnumerableAssert<S extends AbstractCharSequenceAssert<S,A>,Character>

isNotEmpty

public S isNotEmpty()

Verifies that the actual group of values is not empty.

Specified by:

isNotEmpty in interface EnumerableAssert<S extends AbstractCharSequenceAssert<S,A>,Character>

Returns:

this assertion object.

hasSize

public S hasSize(int expected)

Verifies that the number of values in the actual group is equal to the given one.

Specified by:

hasSize in interface EnumerableAssert<S extends AbstractCharSequenceAssert<S,A>,Character>

Parameters:

expected - the expected number of values in the actual group.

Returns:

this assertion object.

hasSameSizeAs

public S hasSameSizeAs(Object[] other)

Verifies that the actual group has the same size as given array.

Specified by:

hasSameSizeAs in interface EnumerableAssert<S extends AbstractCharSequenceAssert<S,A>,Character>

Parameters:

other - the array to compare size with actual group.

Returns:

this assertion object.

hasSameSizeAs

public S hasSameSizeAs(Iterable<?> other)

Verifies that the actual group has the same size as given Iterable.

Specified by:

hasSameSizeAs in interface EnumerableAssert<S extends AbstractCharSequenceAssert<S,A>,Character>

Parameters:

other - the Iterable to compare size with actual group.

Returns:

this assertion object.

isEqualToIgnoringCase

public S isEqualToIgnoringCase(CharSequence expected)

Verifies that the actual CharSequence is equal to the given one, ignoring case considerations.

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.

containsOnlyOnce

public S containsOnlyOnce(CharSequence sequence)

Verifies that the actual CharSequence contains only once the given sequence.

Parameters:

sequence - the sequence to search for.

Returns:

this assertion object.

Throws:

AssertionError - if the actual CharSequence does not contain the given one, or contain it multiple times.

contains

public S contains(CharSequence... values)

Verifies that the actual CharSequence 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");
 

Parameters:

values - the Strings to look for.

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.

containsSequence

public S containsSequence(CharSequence... values)

Verifies that the actual CharSequence 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", "}");
 

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 S containsIgnoringCase(CharSequence sequence)

Verifies that the actual CharSequence contains the given sequence, ignoring case considerations.

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 S doesNotContain(CharSequence sequence)

Verifies that the actual CharSequence does not contain the given sequence.

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.

startsWith

public S startsWith(CharSequence prefix)

Verifies that the actual CharSequence starts with the given prefix.

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.

endsWith

public S endsWith(CharSequence suffix)

Verifies that the actual CharSequence ends with the given suffix.

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.

matches

public S matches(CharSequence regex)

Verifies that the actual CharSequence matches the given regular expression.

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 S doesNotMatch(CharSequence regex)

Verifies that the actual CharSequence does not match the given regular expression.

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 S matches(Pattern pattern)

Verifies that the actual CharSequence matches the given regular expression.

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 S doesNotMatch(Pattern pattern)

Verifies that the actual CharSequence does not match the given regular expression.

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.

usingElementComparator

@Deprecated
public final S usingElementComparator(Comparator<? super Character> customComparator)

Deprecated. Custom element Comparator is not supported for CharSequence comparison.

Do not use this method.

Specified by:

usingElementComparator in interface EnumerableAssert<S extends AbstractCharSequenceAssert<S,A>,Character>

Parameters:

customComparator - the comparator to use for incoming assertion checks.

Returns:

this assertion object.

Throws:

UnsupportedOperationException - if this method is called.

usingDefaultElementComparator

@Deprecated
public final S usingDefaultElementComparator()

Deprecated. Custom element Comparator is not supported for CharSequence comparison.

Do not use this method.

Specified by:

usingDefaultElementComparator in interface EnumerableAssert<S extends AbstractCharSequenceAssert<S,A>,Character>

Returns:

this assertion object.

Throws:

UnsupportedOperationException - if this method is called.

usingComparator

public S usingComparator(Comparator<? super A> 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 interface Assert<S extends AbstractCharSequenceAssert<S,A>,A extends CharSequence>

Overrides:

usingComparator in class AbstractAssert<S extends AbstractCharSequenceAssert<S,A>,A extends CharSequence>

Parameters:

customComparator - the comparator to use for incoming assertion checks.

Returns:

this assertion object.

usingDefaultComparator

public S 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 interface Assert<S extends AbstractCharSequenceAssert<S,A>,A extends CharSequence>

Overrides:

usingDefaultComparator in class AbstractAssert<S extends AbstractCharSequenceAssert<S,A>,A extends CharSequence>

Returns:

this assertion object.