Class AbstractIterableAssert<SELF extends AbstractIterableAssert<SELF,ACTUAL,ELEMENT,ELEMENT_ASSERT>,ACTUAL extends Iterable<? extends ELEMENT>,ELEMENT,ELEMENT_ASSERT extends AbstractAssert<ELEMENT_ASSERT,ELEMENT>>
- 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.ELEMENT
- the type of elements of the "actual" value.ELEMENT_ASSERT
- used for navigational assertions to return the right assert type.
- All Implemented Interfaces:
Assert<SELF,
,ACTUAL> Descriptable<SELF>
,EnumerableAssert<SELF,
,ELEMENT> ExtensionPoints<SELF,
,ACTUAL> ObjectEnumerableAssert<SELF,
ELEMENT>
- Direct Known Subclasses:
AbstractListAssert
,ClassBasedNavigableIterableAssert
,FactoryBasedNavigableIterableAssert
ObjectEnumerableAssert
whose actual value type is
Collection
.-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final String
private Map<String,
Comparator<?>> private TypeComparators
protected Iterables
Fields inherited from class org.assertj.core.api.AbstractAssert
actual, conditions, info, myself, objects
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionVerifies that all the elements of actual match the givenPredicate
.Verifies that all the elements of actual match the givenPredicate
.allSatisfy
(Consumer<? super ELEMENT> requirements) Verifies that all the elements satisfy given requirements expressed as aConsumer
.anySatisfy
(Consumer<? super ELEMENT> requirements) Verifies that at least one element satisfies the given requirements expressed as aConsumer
.Verifies that each element value satisfies the given condition.areAtLeast
(int times, Condition<? super ELEMENT> condition) Verifies that there are at least n elements in the actual group satisfying the given condition.areAtLeastOne
(Condition<? super ELEMENT> condition) Verifies that there is at least one element in the actual group satisfying the given condition.Verifies that there are at most n elements in the actual group satisfying the given condition.areExactly
(int times, Condition<? super ELEMENT> condition) Verifies that there are exactly n elements in the actual group satisfying the given condition.Verifies that each element value does not satisfy the given condition.Sets the description of the assertion that is going to be called after.as
(Description description) Sets the description of the assertion that is going to be called after.Verifies that the actual group contains the given values, in any order.containsAll
(Iterable<? extends ELEMENT> iterable) Verifies that the actual group contains all the elements of givenIterable
, in any order.containsExactly
(ELEMENT... values) Verifies that the actual group contains only the given values and nothing else, in order.
This assertion should only be used with groups that have a consistent iteration order (i.e.containsExactlyElementsOf
(Iterable<? extends ELEMENT> iterable) Same asObjectEnumerableAssert.containsExactly(Object...)
but handle theIterable
to array conversion : verifies that actual contains all the elements of the given iterable and nothing else in the same order.containsExactlyInAnyOrder
(ELEMENT... values) Verifies that the actual group contains exactly the given values and nothing else, in any order.Verifies that the actual group contains at least a null element.containsOnly
(ELEMENT... values) Verifies that the actual group contains only the given values and nothing else, in any order.containsOnlyElementsOf
(Iterable<? extends ELEMENT> iterable) Same semantic asObjectEnumerableAssert.containsOnly(Object[])
: verifies that actual contains all the elements of the given iterable and nothing else, in any order.containsOnlyOnce
(ELEMENT... values) Verifies that the actual group contains the given values only once.containsSequence
(ELEMENT... sequence) Verifies that the actual group contains the given sequence in the correct order and without extra values between the sequence values.containsSequence
(Iterable<? extends ELEMENT> sequence) Verifies that the actual group contains the given sequence in the correct order and without extra values between the sequence values.containsSubsequence
(ELEMENT... subsequence) Verifies that the actual group contains the given subsequence in the correct order (possibly with other values between them).containsSubsequence
(Iterable<? extends ELEMENT> subsequence) Verifies that the actual group contains the given subsequence in the correct order (possibly with other values between them).describedAs
(String description, Object... args) Sets the description of the assertion that is going to be called after.describedAs
(Description description) Sets the description of the assertion that is going to be called after.doesNotContain
(ELEMENT... values) Verifies that the actual group does not contain the given values.doesNotContainAnyElementsOf
(Iterable<? extends ELEMENT> iterable) Verifies that actual does not contain any elements of the givenIterable
(i.e.Verifies that the actual group does not contain null elements.doesNotContainSequence
(ELEMENT... sequence) Verifies that the actual group does not contain the given sequence, a sequence is defined by an ordered group of values without extra values between them.doesNotContainSequence
(Iterable<? extends ELEMENT> sequence) Verifies that the actual group does not contain the given sequence, a sequence is defined by an ordered group of values without extra values between them.doesNotContainSubsequence
(ELEMENT... subsequence) Verifies that the actual group does not contain the given subsequence, a subsequence is defined by an ordered group of values with possibly extra values between them.doesNotContainSubsequence
(Iterable<? extends ELEMENT> subsequence) Verifies that the actual group does not contain the given subsequence, a subsequence is defined by an ordered group of values with possibly extra values between them.doesNotHave
(Condition<? super ACTUAL> condition) Verifies that the actual value does not satisfy the given condition.Verifies that the actual group does not contain duplicates.doesNotHaveSameClassAs
(Object other) Verifies that the actual value does not have the same class as the given object.private <V> AbstractListAssert<?,
List<? extends V>, V, ObjectAssert<V>> doFlatExtracting
(Extractor<? super ELEMENT, ? extends Collection<V>> extractor) Verifies that all elements do not satisfy the given condition.element
(int index) Navigate and allow to perform assertions on the chosen element of theIterable
under test.Verifies that the actual group ends with the given sequence of objects, without any other objects between them.AbstractListAssert<?,
List<? extends Object>, Object, ObjectAssert<Object>> extracting
(String propertyOrField) Extract the values of the given field or property from the Iterable's elements under test into a new Iterable, this new Iterable becoming the Iterable under test.AbstractListAssert<?,
List<? extends Tuple>, Tuple, ObjectAssert<Tuple>> extracting
(String... propertiesOrFields) Extract the values of the given fields/properties from the Iterable's elements under test into a new Iterable composed of Tuples (a simple data structure), this new Iterable becoming the Iterable under test.<P> AbstractListAssert<?,
List<? extends P>, P, ObjectAssert<P>> extracting
(String propertyOrField, Class<P> extractingType) Extract the values of given field or property from the Iterable's elements under test into a new Iterable, this new Iterable becoming the Iterable under test.final ListAssert<Tuple>
extracting
(Function<ELEMENT, ?>... extractors) <V> AbstractListAssert<?,
List<? extends V>, V, ObjectAssert<V>> extracting
(Extractor<? super ELEMENT, V> extractor) Extract the values from Iterable's elements under test by applying an extracting function on them.<V,
EXCEPTION extends Exception>
AbstractListAssert<?,List<? extends V>, V, ObjectAssert<V>> extracting
(ThrowingExtractor<? super ELEMENT, V, EXCEPTION> extractor) Extract the values from Iterable's elements under test by applying an extracting function (which might throw an exception) on them.AbstractListAssert<?,
List<? extends Object>, Object, ObjectAssert<Object>> extractingResultOf
(String method) Extract the result of given method invocation on the Iterable's elements under test into a new Iterable, this new Iterable becoming the Iterable under test.<P> AbstractListAssert<?,
List<? extends P>, P, ObjectAssert<P>> extractingResultOf
(String method, Class<P> extractedType) Extract the result of given method invocation on the Iterable's elements under test into a new list of the given class, this new List becoming the object under test.AbstractListAssert<?,
List<? extends ELEMENT>, ELEMENT, ObjectAssert<ELEMENT>> filteredOn
(String propertyOrFieldName, Object expectedValue) Filter the iterable under test keeping only elements having a property or field equal toexpectedValue
, the property/field is specified bypropertyOrFieldName
parameter.AbstractListAssert<?,
List<? extends ELEMENT>, ELEMENT, ObjectAssert<ELEMENT>> filteredOn
(String propertyOrFieldName, FilterOperator<?> filterOperator) Filter the iterable under test keeping only elements having a property or field matching the filter expressed with theFilterOperator
, the property/field is specified bypropertyOrFieldName
parameter.AbstractListAssert<?,
List<? extends ELEMENT>, ELEMENT, ObjectAssert<ELEMENT>> filteredOn
(Predicate<? super ELEMENT> predicate) Filter the iterable under test keeping only elements matching the givenPredicate
.AbstractListAssert<?,
List<? extends ELEMENT>, ELEMENT, ObjectAssert<ELEMENT>> filteredOn
(Condition<? super ELEMENT> condition) Filter the iterable under test keeping only elements matching the givenCondition
.AbstractListAssert<?,
List<? extends ELEMENT>, ELEMENT, ObjectAssert<ELEMENT>> filteredOnNull
(String propertyOrFieldName) Filter the iterable under test keeping only elements whose property or field specified bypropertyOrFieldName
is null.first()
Navigate and allow to perform assertions on the first element of theIterable
under test.AbstractListAssert<?,
List<? extends Object>, Object, ObjectAssert<Object>> flatExtracting
(String fieldOrPropertyName) Extract from Iterable's elements the Iterable/Array values corresponding to the given property/field name and concatenate them into a single list becoming the new object under test.AbstractListAssert<?,
List<? extends Object>, Object, ObjectAssert<Object>> flatExtracting
(String... fieldOrPropertyNames) Extract the given property/field values from eachIterable
's element and flatten the extracted values in a list that is used as the new object under test.final ListAssert<Object>
flatExtracting
(Extractor<? super ELEMENT, ?>... extractors) Extract multiple values from eachIterable
's element according to the givenExtractor
s and concatenate/flatten the extracted values in a list that is used as the new object under test.<V> AbstractListAssert<?,
List<? extends V>, V, ObjectAssert<V>> flatExtracting
(Extractor<? super ELEMENT, ? extends Collection<V>> extractor) Extract the Iterable values from Iterable's elements under test by applying an Iterable extracting function on them and concatenating the result lists.final <EXCEPTION extends Exception>
ListAssert<Object>flatExtracting
(ThrowingExtractor<? super ELEMENT, ?, EXCEPTION>... extractors) Extract multiple values from eachIterable
's element according to the givenThrowingExtractor
s and concatenate/flatten the extracted values in a list that is used as the new object under test.<V,
EXCEPTION extends Exception>
AbstractListAssert<?,List<? extends V>, V, ObjectAssert<V>> flatExtracting
(ThrowingExtractor<? super ELEMENT, ? extends Collection<V>, EXCEPTION> extractor) Extract the Iterable values from Iterable's elements under test by applying an Iterable extracting function (which might throw an exception) on them and concatenating the result lists.Verifies that the actual value satisfies the given condition.hasAtLeastOneElementOfType
(Class<?> expectedType) Verifies that at least one element in the actualIterable
has the specified type (matching includes subclasses of the given type).hasOnlyElementsOfType
(Class<?> expectedType) Verifies that all elements in the actualIterable
have the specified type (matching includes subclasses of the given type).hasOnlyElementsOfTypes
(Class<?>... types) Verifies that all elements of the actual group are instances of the given types.void
hasOnlyOneElementSatisfying
(Consumer<ELEMENT> elementAssertions) Verifies that the unique element of theIterable
satifies the given assertions expressed as aConsumer
, if it does not, only the first error is reported, useSoftAssertions
to get all the errors.hasSameClassAs
(Object other) Verifies that the actual value has the same class as the given object.hasSameElementsAs
(Iterable<? extends ELEMENT> iterable) An alias ofObjectEnumerableAssert.containsOnlyElementsOf(Iterable)
: verifies that actual contains all the elements of the given iterable and nothing else, in any order.hasSameSizeAs
(Iterable<?> other) Verifies that the actual group has the same size as givenIterable
.hasSameSizeAs
(Object other) Verifies that the actual group has the same size as given array.hasSize
(int expected) Verifies that the number of values in the actual group is equal to the given one.hasToString
(String expectedToString) Verifies that actualactual.toString()
is equal to the givenString
.Verifies that all elements satisfy the given condition.haveAtLeast
(int times, Condition<? super ELEMENT> condition) Verifies that there are at least n elements in the actual group satisfying the given condition.haveAtLeastOne
(Condition<? super ELEMENT> condition) Verifies that there is at least one element in the actual group satisfying the given condition.haveAtMost
(int times, Condition<? super ELEMENT> condition) Verifies that there are at most n elements in the actual group satisfying the given condition.haveExactly
(int times, Condition<? super ELEMENT> condition) Verifies that there are exactly n elements in the actual group satisfying the given condition.inBinary()
Enable binary representation of Iterable elements instead of standard representation in error messages.Enable hexadecimal representation of Iterable elements instead of standard representation in error messages.Verifies that the actual value satisfies the given condition.void
isEmpty()
Verifies that the actual group of values is empty.Verifies that the actual value is equal to the given one.isExactlyInstanceOf
(Class<?> type) Verifies that the actual value is exactly an instance of the given type.Verifies that the actual value is present in the given values.Verifies that the actual value is present in the given array of values.isInstanceOf
(Class<?> type) Verifies that the actual value is an instance of the given type.isInstanceOfAny
(Class<?>... types) Verifies that the actual value is an instance of any of the given types.Verifies that the actual value does not satisfy the given condition.Verifies that the actual group of values is not empty.isNotEqualTo
(Object other) Verifies that the actual value is not equal to the given one.isNotExactlyInstanceOf
(Class<?> type) Verifies that the actual value is not exactly an instance of given type.Verifies that the actual value is not present in the given values.Verifies that the actual value is not present in the given array of values.isNotInstanceOf
(Class<?> type) Verifies that the actual value is not an instance of the given type.isNotInstanceOfAny
(Class<?>... types) Verifies that the actual value is not an instance of any of the given types.Verifies that the actual value is notnull
.isNotOfAnyClassIn
(Class<?>... types) Verifies that the actual value type is not in given types.isNotSameAs
(Object other) Verifies that the actual value is not the same as the given one, ie using == comparison.void
Verifies that the actual group of values isnull
or empty.isOfAnyClassIn
(Class<?>... types) Verifies that the actual value type is in given types.Verifies that the actual value is the same as the given one, ie using == comparison.isSubsetOf
(ELEMENT... values) Verifies that all the elements of actual are present in the given values.isSubsetOf
(Iterable<? extends ELEMENT> values) Verifies that all the elements of actual are present in the givenIterable
.last()
Navigate and allow to perform assertions on the first element of theIterable
under test.private ELEMENT
protected String
navigationDescription
(String propertyName) protected <E> AbstractListAssert<?,
List<? extends E>, E, ObjectAssert<E>> newListAssertInstance
(List<? extends E> newActual) Create a friendly soft or "hard" assertion.overridingErrorMessage
(String newErrorMessage, Object... args) Overrides AssertJ default error message by the given one.private static String
removeAssert
(String text) size()
Returns anAssert
object that allows performing assertions on the size of theIterable
under test.startsWith
(ELEMENT... sequence) Verifies that the actual group starts with the given sequence of objects, without any other objects between them.protected abstract ELEMENT_ASSERT
protected static <T> Iterable<T>
toLazyIterable
(Iterator<T> actual) usingComparator
(Comparator<? super ACTUAL> customComparator) Use given custom comparator instead of relying on actual type A equals method for incoming assertion checks.<T> SELF
usingComparatorForElementFieldsWithNames
(Comparator<T> comparator, String... elementPropertyOrFieldNames) Allows to set a comparator to compare properties or fields of elements with the given names.<T> SELF
usingComparatorForElementFieldsWithType
(Comparator<T> comparator, Class<T> type) Allows to set a specific comparator to compare properties or fields of elements with the given type.protected SELF
usingComparisonStrategy
(ComparisonStrategy comparisonStrategy) Revert to standard comparison for incoming assertion checks.Revert to standard comparison for incoming assertion group element checks.usingElementComparator
(Comparator<? super ELEMENT> elementComparator) Use given custom comparator instead of relying on actual type Aequals
method to compare group elements for incoming assertion checks.usingElementComparatorIgnoringFields
(String... fields) Use field/property by field/property on all fields/properties except the given ones (including inherited fields/properties)instead of relying on actual type Aequals
method to compare group elements for incoming assertion checks.usingElementComparatorOnFields
(String... fields) Use field/property by field/property comparison on the given fields/properties only (including inherited fields/properties)instead of relying on actual type Aequals
method to compare group elements for incoming assertion checks.Use field/property by field/property comparison (including inherited fields/properties) instead of relying on actual type Aequals
method to compare group elements for incoming assertion checks.Use a recursive field/property by field/property comparison (including inherited fields/properties) instead of relying on actual typeequals
method to compare group elements for incoming assertion checks.withFailMessage
(String newErrorMessage, Object... args) Alternative method forAbstractAssert.overridingErrorMessage(java.lang.String, java.lang.Object...)
In case of an assertion error, a thread dump will be printed toSystem.err
.Methods inherited from class org.assertj.core.api.AbstractAssert
asList, asString, descriptionText, equals, failWithMessage, getWritableAssertionInfo, hashCode, isInstanceOfSatisfying, isNull, matches, matches, satisfies, setCustomRepresentation, throwAssertionError, withRepresentation
-
Field Details
-
ASSERT
- See Also:
-
comparatorsForElementPropertyOrFieldNames
-
comparatorsForElementPropertyOrFieldTypes
-
iterables
-
-
Constructor Details
-
AbstractIterableAssert
-
-
Method Details
-
toLazyIterable
-
newListAssertInstance
protected <E> AbstractListAssert<?,List<? extends E>, newListAssertInstanceE, ObjectAssert<E>> (List<? extends E> newActual) Create a friendly soft or "hard" assertion.Implementations need to redefine it so that some methods, such as
extracting(Extractor)
, are able to build the appropriate list assert (eg:ListAssert
versusSoftAssertionListAssert
).The default implementation will assume that this concrete implementation is NOT a soft assertion.
- Parameters:
newActual
- new value- Returns:
- a new
AbstractListAssert
.
-
isNullOrEmpty
public void isNullOrEmpty()Verifies that the actual group of values isnull
or empty.Example:
// assertions will pass List<String> strings = new ArrayList<>(); assertThat(strings).isNullOrEmpty(); assertThat(new int[] { }).isNullOrEmpty(); // assertions will fail assertThat(new String[] { "a", "b"}).isNullOrEmpty(); assertThat(Arrays.asList(1, 2, 3)).isNullOrEmpty();
- Specified by:
isNullOrEmpty
in interfaceEnumerableAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>>
-
isEmpty
public void isEmpty()Verifies that the actual group of values is empty.Example:
// assertions will pass assertThat(new ArrayList()).isEmpty(); assertThat(new int[] { }).isEmpty(); // assertions will fail assertThat(new String[] { "a", "b" }).isEmpty(); assertThat(Arrays.asList(1, 2, 3)).isEmpty();
- Specified by:
isEmpty
in interfaceEnumerableAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>>
-
isNotEmpty
Verifies that the actual group of values is not empty.Example:
// assertions will pass assertThat(new String[] { "a", "b" }).isNotEmpty(); assertThat(Arrays.asList(1, 2, 3)).isNotEmpty(); // assertions will fail assertThat(new ArrayList()).isNotEmpty(); assertThat(new int[] { }).isNotEmpty();
- Specified by:
isNotEmpty
in interfaceEnumerableAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Returns:
this
assertion object.
-
hasSize
Verifies that the number of values in the actual group is equal to the given one.Example:
// assertions will pass assertThat(new String[] { "a", "b" }).hasSize(2); assertThat(Arrays.asList(1, 2, 3)).hasSize(3); // assertions will fail assertThat(new ArrayList()).hasSize(1); assertThat(new int[] { 1, 2, 3 }).hasSize(2);
- Specified by:
hasSize
in interfaceEnumerableAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
expected
- the expected number of values in the actual group.- Returns:
this
assertion object.
-
hasOnlyOneElementSatisfying
Verifies that the unique element of theIterable
satifies the given assertions expressed as aConsumer
, if it does not, only the first error is reported, useSoftAssertions
to get all the errors.Example:
List<Jedi> jedis = asList(new Jedi("Yoda", "red")); // assertions will pass assertThat(jedis).hasOnlyOneElementSatisfying(yoda -> assertThat(yoda.getName()).startsWith("Y")); assertThat(jedis).hasOnlyOneElementSatisfying(yoda -> { assertThat(yoda.getName()).isEqualTo("Yoda"); assertThat(yoda.getLightSaberColor()).isEqualTo("red"); }); // assertions will fail assertThat(jedis).hasOnlyOneElementSatisfying(yoda -> assertThat(yoda.getName()).startsWith("Vad")); // fail as one the assertions is not satisfied assertThat(jedis).hasOnlyOneElementSatisfying(yoda -> { assertThat(yoda.getName()).isEqualTo("Yoda"); assertThat(yoda.getLightSaberColor()).isEqualTo("purple"); }); // fail but only report the first error assertThat(jedis).hasOnlyOneElementSatisfying(yoda -> { assertThat(yoda.getName()).isEqualTo("Luke"); assertThat(yoda.getLightSaberColor()).isEqualTo("green"); }); // fail and reports the errors thanks to Soft assertions assertThat(jedis).hasOnlyOneElementSatisfying(yoda -> { SoftAssertions softly = new SoftAssertions(); softly.assertThat(yoda.getName()).isEqualTo("Luke"); softly.assertThat(yoda.getLightSaberColor()).isEqualTo("green"); softly.assertAll(); }); // even if the assertion is correct, there are too many jedis ! jedis.add(new Jedi("Luke", "green")); assertThat(jedis).hasOnlyOneElementSatisfying(yoda -> assertThat(yoda.getName()).startsWith("Yo"));
- Parameters:
elementAssertions
- the assertions to perform on the unique element.- Throws:
AssertionError
- if theIterable
does not have a unique element.AssertionError
- if theIterable
's unique element does not satifies the given assertions.- Since:
- 3.5.0
-
hasSameSizeAs
Verifies that the actual group has the same size as given array.Parameter is declared as Object to accept both Object[] and primitive arrays (e.g. int[]).
Example:
int[] oneTwoThree = {1, 2, 3}; Iterable<Ring> elvesRings = newArrayList(vilya, nenya, narya); // assertion will pass assertThat(elvesRings).hasSameSizeAs(oneTwoThree); // assertions will fail assertThat(elvesRings).hasSameSizeAs(new int[] { 1, 2}); assertThat(elvesRings).hasSameSizeAs(new int[] { 1, 2, 3, 4});
- Specified by:
hasSameSizeAs
in interfaceEnumerableAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
other
- the array to compare size with actual group.- Returns:
this
assertion object.
-
hasSameSizeAs
Verifies that the actual group has the same size as givenIterable
.Example:
Iterable<String> abc = newArrayList("a", "b", "c"); Iterable<Ring> elvesRings = newArrayList(vilya, nenya, narya); // assertion will pass assertThat(elvesRings).hasSameSizeAs(abc); // assertions will fail assertThat(elvesRings).hasSameSizeAs(Arrays.asList(1, 2)); assertThat(elvesRings).hasSameSizeAs(Arrays.asList(1, 2, 3, 4));
- Specified by:
hasSameSizeAs
in interfaceEnumerableAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
other
- theIterable
to compare size with actual group.- Returns:
this
assertion object.
-
contains
Verifies that the actual group contains the given values, in any order.Example :
Iterable<String> abc = newArrayList("a", "b", "c"); // assertions will pass assertThat(abc).contains("b", "a"); assertThat(abc).contains("b", "a", "b"); // assertion will fail assertThat(abc).contains("d");
- Specified by:
contains
in interfaceObjectEnumerableAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
values
- the given values.- Returns:
this
assertion object.
-
containsOnly
Verifies that the actual group contains only the given values and nothing else, in any order.Example :
Iterable<String> abc = newArrayList("a", "b", "c"); // assertion will pass assertThat(abc).containsOnly("c", "b", "a"); // assertion will fail because "c" is missing assertThat(abc).containsOnly("a", "b");
- Specified by:
containsOnly
in interfaceObjectEnumerableAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
values
- the given values.- Returns:
this
assertion object.
-
containsOnlyOnce
Verifies that the actual group contains the given values only once.Examples :
// lists are used in the examples but it would also work with arrays // assertions will pass assertThat(newArrayList("winter", "is", "coming")).containsOnlyOnce("winter"); assertThat(newArrayList("winter", "is", "coming")).containsOnlyOnce("coming", "winter"); // assertions will fail assertThat(newArrayList("winter", "is", "coming")).containsOnlyOnce("Lannister"); assertThat(newArrayList("Arya", "Stark", "daughter", "of", "Ned", "Stark")).containsOnlyOnce("Stark"); assertThat(newArrayList("Arya", "Stark", "daughter", "of", "Ned", "Stark")).containsOnlyOnce("Stark", "Lannister", "Arya");
- Specified by:
containsOnlyOnce
in interfaceObjectEnumerableAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
values
- the given values.- Returns:
this
assertion object.
-
containsExactly
Verifies that the actual group contains only the given values and nothing else, in order.
This assertion should only be used with groups that have a consistent iteration order (i.e. don't use it withHashSet
, preferObjectEnumerableAssert.containsOnly(Object...)
in that case).Example :
// an Iterable is used in the example but it would also work with an array Iterable<Ring> elvesRings = newArrayList(vilya, nenya, narya); // assertion will pass assertThat(elvesRings).containsExactly(vilya, nenya, narya); // assertion will fail as actual and expected order differ assertThat(elvesRings).containsExactly(nenya, vilya, narya);
- Specified by:
containsExactly
in interfaceObjectEnumerableAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
values
- the given values.- Returns:
this
assertion object.
-
containsExactlyInAnyOrder
Verifies that the actual group contains exactly the given values and nothing else, in any order.
Example :
// an Iterable is used in the example but it would also work with an array Iterable<Ring> elvesRings = newArrayList(vilya, nenya, narya, vilya); // assertion will pass assertThat(elvesRings).containsExactlyInAnyOrder(vilya, vilya, nenya, narya); // assertion will fail as vilya is contained twice in elvesRings. assertThat(elvesRings).containsExactlyInAnyOrder(nenya, vilya, narya);
- Specified by:
containsExactlyInAnyOrder
in interfaceObjectEnumerableAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
values
- the given values.- Returns:
this
assertion object.
-
isSubsetOf
Verifies that all the elements of actual are present in the givenIterable
.Example:
// an Iterable is used in the example but it would also work with an array List<Ring> ringsOfPower = newArrayList(oneRing, vilya, nenya, narya, dwarfRing, manRing); Iterable<Ring> elvesRings = newArrayList(vilya, nenya, narya); // assertion will pass: assertThat(elvesRings).isSubsetOf(ringsOfPower); // assertion will fail: assertThat(elvesRings).isSubsetOf(newArrayList(nenya, narya));
- Specified by:
isSubsetOf
in interfaceObjectEnumerableAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
values
- theIterable
that should contain all actual elements.- Returns:
- this assertion object.
-
isSubsetOf
Verifies that all the elements of actual are present in the given values.Example:
// an Iterable is used in the example but it would also work with an array Iterable<Ring> elvesRings = newArrayList(vilya, nenya, narya); // assertions will pass: assertThat(elvesRings).isSubsetOf(vilya, nenya, narya) .isSubsetOf(vilya, nenya, narya, dwarfRing); // assertions will fail: assertThat(elvesRings).isSubsetOf(vilya, nenya); assertThat(elvesRings).isSubsetOf(vilya, nenya, dwarfRing);
- Specified by:
isSubsetOf
in interfaceObjectEnumerableAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
values
- the values that should be used for checking the elements of actual.- Returns:
- this assertion object.
-
containsSequence
Verifies that the actual group contains the given sequence in the correct order and without extra values between the sequence values.Use
ObjectEnumerableAssert.containsSubsequence(Object...)
to allow values between the expected sequence values.Example:
// an Iterable is used in the example but it would also work with an array Iterable<Ring> elvesRings = newArrayList(vilya, nenya, narya); // assertions will pass assertThat(elvesRings).containsSequence(vilya, nenya) .containsSequence(nenya, narya); // assertions will fail, the elements order is correct but there is a value between them (nenya) assertThat(elvesRings).containsSequence(vilya, narya); assertThat(elvesRings).containsSequence(nenya, vilya);
- Specified by:
containsSequence
in interfaceObjectEnumerableAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
sequence
- the sequence of objects to look for.- Returns:
- this assertion object.
-
containsSequence
Verifies that the actual group contains the given sequence in the correct order and without extra values between the sequence values.Use
ObjectEnumerableAssert.containsSubsequence(Iterable)
to allow values between the expected sequence values.Example:
Iterable<Ring> elvesRings = newArrayList(vilya, nenya, narya); // assertions will pass assertThat(elvesRings).containsSequence(newArrayList(vilya, nenya)) .containsSequence(newArrayList(nenya, narya)); // assertions will fail, the elements order is correct but there is a value between them (nenya) assertThat(elvesRings).containsSequence(newArrayList(vilya, narya)); assertThat(elvesRings).containsSequence(newArrayList(nenya, vilya));
- Specified by:
containsSequence
in interfaceObjectEnumerableAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
sequence
- the sequence of objects to look for.- Returns:
- this assertion object.
-
doesNotContainSequence
Verifies that the actual group does not contain the given sequence, a sequence is defined by an ordered group of values without extra values between them.Use
ObjectEnumerableAssert.doesNotContainSubsequence(Object...)
to also ensure the sequence does not exist with values between the expected sequence values.Example:
// an Iterable is used in the example but it would also work with an array Iterable<Ring> elvesRings = newArrayList(vilya, nenya, narya); // assertions will pass, the elements order is correct but there is a value between them (nenya) assertThat(elvesRings).doesNotContainSequence(vilya, narya) .doesNotContainSequence(nenya, vilya); // assertions will fail assertThat(elvesRings).doesNotContainSequence(vilya, nenya); assertThat(elvesRings).doesNotContainSequence(nenya, narya);
- Specified by:
doesNotContainSequence
in interfaceObjectEnumerableAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
sequence
- the sequence of objects to look for.- Returns:
- this assertion object.
-
doesNotContainSequence
Verifies that the actual group does not contain the given sequence, a sequence is defined by an ordered group of values without extra values between them.Use
ObjectEnumerableAssert.doesNotContainSubsequence(Iterable)
to also ensure the sequence does not exist with values between the sequence values.Example:
// an Iterable is used in the example but it would also work with an array Iterable<Ring> elvesRings = newArrayList(vilya, nenya, narya); // assertions will pass, the elements order is correct but there is a value between them (nenya) assertThat(elvesRings).doesNotContainSequence(newArrayList(vilya, narya)) .doesNotContainSequence(newArrayList(nenya, vilya)); // assertions will fail assertThat(elvesRings).doesNotContainSequence(newArrayList(vilya, nenya)); assertThat(elvesRings).doesNotContainSequence(newArrayList(nenya, narya));
- Specified by:
doesNotContainSequence
in interfaceObjectEnumerableAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
sequence
- the sequence of objects to look for.- Returns:
- this assertion object.
-
containsSubsequence
Verifies that the actual group contains the given subsequence in the correct order (possibly with other values between them).Example:
// an Iterable is used in the example but it would also work with an array Iterable<Ring> elvesRings = newArrayList(vilya, nenya, narya); // assertions will pass assertThat(elvesRings).containsSubsequence(vilya, nenya) .containsSubsequence(vilya, narya); // assertion will fail assertThat(elvesRings).containsSubsequence(nenya, vilya);
- Specified by:
containsSubsequence
in interfaceObjectEnumerableAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
subsequence
- the sequence of objects to look for.- Returns:
- this assertion object.
-
containsSubsequence
Verifies that the actual group contains the given subsequence in the correct order (possibly with other values between them).Example:
Iterable<Ring> elvesRings = newArrayList(vilya, nenya, narya); // assertions will pass assertThat(elvesRings).containsSubsequence(newArrayList(vilya, nenya)) .containsSubsequence(newArrayList(vilya, narya)); // assertion will fail assertThat(elvesRings).containsSubsequence(newArrayList(nenya, vilya));
- Specified by:
containsSubsequence
in interfaceObjectEnumerableAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
subsequence
- the sequence of objects to look for.- Returns:
- this assertion object.
-
doesNotContainSubsequence
Verifies that the actual group does not contain the given subsequence, a subsequence is defined by an ordered group of values with possibly extra values between them.Example:
// an Iterable is used in the example but it would also work with an array Iterable<Ring> elvesRings = newArrayList(vilya, nenya, narya); // assertions will pass assertThat(elvesRings).doesNotContainSubsequence(nenya, vilya) .doesNotContainSubsequence(narya, vilya); // assertion will fail assertThat(elvesRings).doesNotContainSubsequence(vilya, nenya); assertThat(elvesRings).doesNotContainSubsequence(vilya, narya);
- Specified by:
doesNotContainSubsequence
in interfaceObjectEnumerableAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
subsequence
- the sequence of objects to look for.- Returns:
- this assertion object.
-
doesNotContainSubsequence
Verifies that the actual group does not contain the given subsequence, a subsequence is defined by an ordered group of values with possibly extra values between them.Example:
Iterable<Ring> elvesRings = newArrayList(vilya, nenya, narya); // assertions will pass assertThat(elvesRings).doesNotContainSubsequence(newArrayList(nenya, vilya)); .doesNotContainSubsequence(newArrayList(narya, vilya)); // assertion will fail assertThat(elvesRings).doesNotContainSubsequence(newArrayList(vilya, nenya)); assertThat(elvesRings).doesNotContainSubsequence(newArrayList(vilya, narya));
- Specified by:
doesNotContainSubsequence
in interfaceObjectEnumerableAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
subsequence
- the sequence of objects to look for.- Returns:
- this assertion object.
-
doesNotContain
Description copied from interface:ObjectEnumerableAssert
Verifies that the actual group does not contain the given values.Example :
// an Iterable is used in the example but it would also work with an array Iterable<String> abc = newArrayList("a", "b", "c"); // assertions will pass assertThat(abc).doesNotContain("d") .doesNotContain("d", "e"); // assertions will fail assertThat(abc).doesNotContain("a"); assertThat(abc).doesNotContain("a", "b"); assertThat(abc).doesNotContain("c", "d");
- Specified by:
doesNotContain
in interfaceObjectEnumerableAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
values
- the given values.- Returns:
this
assertion object.
-
doesNotContainAnyElementsOf
Description copied from interface:ObjectEnumerableAssert
Verifies that actual does not contain any elements of the givenIterable
(i.e. none).Example:
Iterable<String> abc = newArrayList("a", "b", "c"); // assertion succeeds: assertThat(actual).doesNotContainAnyElementsOf(newArrayList("d", "e")); // assertion fails: assertThat(actual).doesNotContainAnyElementsOf(newArrayList("d", "e", "a"));
- Specified by:
doesNotContainAnyElementsOf
in interfaceObjectEnumerableAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
iterable
- theIterable
whose elements must not be in the actual group.- Returns:
this
assertion object.
-
doesNotHaveDuplicates
Verifies that the actual group does not contain duplicates.Example :
// an Iterable is used in the example but it would also work with an array Iterable<String> abc = newArrayList("a", "b", "c"); Iterable<String> lotsOfAs = newArrayList("a", "a", "a"); // assertion will pass assertThat(abc).doesNotHaveDuplicates(); // assertion will fail assertThat(lotsOfAs).doesNotHaveDuplicates();
- Specified by:
doesNotHaveDuplicates
in interfaceObjectEnumerableAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Returns:
this
assertion object.
-
startsWith
Verifies that the actual group starts with the given sequence of objects, without any other objects between them. Similar to
, but it also verifies that the first element in the sequence is also first element of the actual group.ObjectEnumerableAssert.containsSequence(Object...)
Example :
// an Iterable is used in the example but it would also work with an array Iterable<String> abc = newArrayList("a", "b", "c"); // assertions will pass assertThat(abc).startsWith("a") .startsWith("a", "b"); // assertion will fail assertThat(abc).startsWith("c");
- Specified by:
startsWith
in interfaceObjectEnumerableAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
sequence
- the sequence of objects to look for.- Returns:
- this assertion object.
-
endsWith
Verifies that the actual group ends with the given sequence of objects, without any other objects between them. Similar to
, but it also verifies that the last element in the sequence is also last element of the actual group.ObjectEnumerableAssert.containsSequence(Object...)
Example :
// an Iterable is used in the example but it would also work with an array Iterable<String> abc = newArrayList("a", "b", "c"); // assertions will pass assertThat(abc).endsWith("c") .endsWith("b", "c"); // assertions will fail assertThat(abc).endsWith("a"); assertThat(abc).endsWith("a", "b");
- Specified by:
endsWith
in interfaceObjectEnumerableAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
sequence
- the sequence of objects to look for.- Returns:
- this assertion object.
-
containsNull
Verifies that the actual group contains at least a null element.Example :
Iterable<String> abc = newArrayList("a", "b", "c"); Iterable<String> abNull = newArrayList("a", "b", null); // assertion will pass assertThat(abNull).containsNull(); // assertion will fail assertThat(abc).containsNull();
- Specified by:
containsNull
in interfaceObjectEnumerableAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Returns:
this
assertion object.
-
doesNotContainNull
Verifies that the actual group does not contain null elements.Example :
Iterable<String> abc = newArrayList("a", "b", "c"); Iterable<String> abNull = newArrayList("a", "b", null); // assertion will pass assertThat(abc).doesNotContainNull(); // assertion will fail assertThat(abNull).doesNotContainNull();
- Specified by:
doesNotContainNull
in interfaceObjectEnumerableAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Returns:
this
assertion object.
-
are
Verifies that each element value satisfies the given condition.Example :
Iterable<String> abc = newArrayList("a", "b", "c"); Iterable<String> abcc = newArrayList("a", "b", "cc"); Condition<String> singleCharacterString = new Condition<>(s -> s.length() == 1, "single character String"); // assertion will pass assertThat(abc).are(singleCharacterString); // assertion will fail assertThat(abcc).are(singleCharacterString);
- Specified by:
are
in interfaceObjectEnumerableAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
condition
- the given condition.- Returns:
this
object.
-
areNot
Verifies that each element value does not satisfy the given condition.Example :
Iterable<String> abc = newArrayList("a", "b", "c"); Iterable<String> abcc = newArrayList("a", "b", "cc"); Condition<String> moreThanOneCharacter = = new Condition<>(s -> s.length() > 1, "more than one character"); // assertion will pass assertThat(abc).areNot(moreThanOneCharacter); // assertion will fail assertThat(abcc).areNot(moreThanOneCharacter);
- Specified by:
areNot
in interfaceObjectEnumerableAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
condition
- the given condition.- Returns:
this
object.
-
have
Verifies that all elements satisfy the given condition.Example :
Iterable<String> abc = newArrayList("a", "b", "c"); Iterable<String> abcc = newArrayList("a", "b", "cc"); Condition<String> onlyOneCharacter = = new Condition<>(s -> s.length() == 1, "only one character"); // assertion will pass assertThat(abc).have(onlyOneCharacter); // assertion will fail assertThat(abcc).have(onlyOneCharacter);
- Specified by:
have
in interfaceObjectEnumerableAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
condition
- the given condition.- Returns:
this
object.
-
doNotHave
Verifies that all elements do not satisfy the given condition.Example :
Iterable<String> abc = newArrayList("a", "b", "c"); Iterable<String> abcc = newArrayList("a", "b", "cc"); Condition<String> moreThanOneCharacter = = new Condition<>(s -> s.length() > 1, "more than one character"); // assertion will pass assertThat(abc).doNotHave(moreThanOneCharacter); // assertion will fail assertThat(abcc).doNotHave(moreThanOneCharacter);
- Specified by:
doNotHave
in interfaceObjectEnumerableAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
condition
- the given condition.- Returns:
this
object.
-
areAtLeastOne
Verifies that there is at least one element in the actual group satisfying the given condition.This method is an alias for
areAtLeast(1, condition)
.Example:
// jedi is a Condition<String> assertThat(newLinkedHashSet("Luke", "Solo", "Leia")).areAtLeastOne(jedi);
- Specified by:
areAtLeastOne
in interfaceObjectEnumerableAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - See Also:
-
areAtLeast
Verifies that there are at least n elements in the actual group satisfying the given condition.Example :
Iterable<Integer> oneTwoThree = newArrayList(1, 2, 3); Condition<Integer> oddNumber = new Condition<>(value % 2 == 1, "odd number"); // assertion will pass oneTwoThree.areAtLeast(2, oddNumber); // assertion will fail oneTwoThree.areAtLeast(3, oddNumber);
- Specified by:
areAtLeast
in interfaceObjectEnumerableAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
times
- the minimum number of times the condition should be verified.condition
- the given condition.- Returns:
this
object.
-
areAtMost
Verifies that there are at most n elements in the actual group satisfying the given condition.Example :
Iterable<Integer> oneTwoThree = newArrayList(1, 2, 3); Condition<Integer> oddNumber = new Condition<>(value % 2 == 1, "odd number"); // assertions will pass oneTwoThree.areAtMost(2, oddNumber) .areAtMost(3, oddNumber); // assertion will fail oneTwoThree.areAtMost(1, oddNumber);
- Specified by:
areAtMost
in interfaceObjectEnumerableAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
times
- the number of times the condition should be at most verified.condition
- the given condition.- Returns:
this
object.
-
areExactly
Verifies that there are exactly n elements in the actual group satisfying the given condition.Example :
Iterable<Integer> oneTwoThree = newArrayList(1, 2, 3); Condition<Integer> oddNumber = new Condition<>(value % 2 == 1, "odd number"); // assertion will pass oneTwoThree.areExactly(2, oddNumber); // assertions will fail oneTwoThree.areExactly(1, oddNumber); oneTwoThree.areExactly(3, oddNumber);
- Specified by:
areExactly
in interfaceObjectEnumerableAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
times
- the exact number of times the condition should be verified.condition
- the given condition.- Returns:
this
object.
-
haveAtLeastOne
Verifies that there is at least one element in the actual group satisfying the given condition.This method is an alias for
haveAtLeast(1, condition)
.Example:
Iterable<BasketBallPlayer> bullsPlayers = newArrayList(butler, rose); // potentialMvp is a Condition<BasketBallPlayer> assertThat(bullsPlayers).haveAtLeastOne(potentialMvp);
- Specified by:
haveAtLeastOne
in interfaceObjectEnumerableAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - See Also:
-
haveAtLeast
Verifies that there are at least n elements in the actual group satisfying the given condition.Example :
This method is an alias forIterable<Integer> oneTwoThree = newArrayList(1, 2, 3); Condition<Integer> oddNumber = new Condition<>(value % 2 == 1, "odd number"); // assertion will pass oneTwoThree.haveAtLeast(2, oddNumber); // assertion will fail oneTwoThree.haveAtLeast(3, oddNumber);
ObjectEnumerableAssert.areAtLeast(int, Condition)
.- Specified by:
haveAtLeast
in interfaceObjectEnumerableAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>>
-
haveAtMost
Verifies that there are at most n elements in the actual group satisfying the given condition.Example :
This method is an aliasIterable<Integer> oneTwoThree = newArrayList(1, 2, 3); Condition<Integer> oddNumber = new Condition<>(value % 2 == 1, "odd number"); // assertions will pass oneTwoThree.haveAtMost(2, oddNumber); oneTwoThree.haveAtMost(3, oddNumber); // assertion will fail oneTwoThree.haveAtMost(1, oddNumber);
ObjectEnumerableAssert.areAtMost(int, Condition)
.- Specified by:
haveAtMost
in interfaceObjectEnumerableAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>>
-
haveExactly
Verifies that there are exactly n elements in the actual group satisfying the given condition.Example :
This method is an aliasIterable<Integer> oneTwoThree = newArrayList(1, 2, 3); Condition<Integer> oddNumber = new Condition<>(value % 2 == 1, "odd number"); // assertion will pass oneTwoThree.haveExactly(2, oddNumber); // assertions will fail oneTwoThree.haveExactly(1, oddNumber); oneTwoThree.haveExactly(3, oddNumber);
ObjectEnumerableAssert.areExactly(int, Condition)
.- Specified by:
haveExactly
in interfaceObjectEnumerableAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>>
-
hasAtLeastOneElementOfType
Verifies that at least one element in the actualIterable
has the specified type (matching includes subclasses of the given type).Example:
List<Number> numbers = new ArrayList<Number>(); numbers.add(1); numbers.add(2L); // successful assertion: assertThat(numbers).hasAtLeastOneElementOfType(Long.class); // assertion failure: assertThat(numbers).hasAtLeastOneElementOfType(Float.class);
- Specified by:
hasAtLeastOneElementOfType
in interfaceObjectEnumerableAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
expectedType
- the expected type.- Returns:
- this assertion object.
- Throws:
NullPointerException
- if the given type isnull
.AssertionError
- if the actualObject
group does not have any elements of the given type.
-
hasOnlyElementsOfType
Verifies that all elements in the actualIterable
have the specified type (matching includes subclasses of the given type).Example:
List<Number> numbers = new ArrayList<Number>(); numbers.add(1); numbers.add(2); numbers.add(3); // successful assertions: assertThat(numbers).hasOnlyElementsOfType(Number.class); assertThat(numbers).hasOnlyElementsOfType(Integer.class); // assertion failure: assertThat(numbers).hasOnlyElementsOfType(Long.class);
- Specified by:
hasOnlyElementsOfType
in interfaceObjectEnumerableAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
expectedType
- the expected type.- Returns:
- this assertion object.
- Throws:
NullPointerException
- if the given type isnull
.AssertionError
- if one element is not of the expected type.
-
hasOnlyElementsOfTypes
Verifies that all elements of the actual group are instances of the given types.Example :
Iterable<? extends Object> objects = Arrays.asList("foo", new StringBuilder()); // assertions will pass assertThat(objects).hasOnlyElementsOfTypes(CharSequence.class) .hasOnlyElementsOfTypes(String.class, StringBuilder.class); // assertions will fail assertThat(objects).hasOnlyElementsOfTypes(Number.class); assertThat(objects).hasOnlyElementsOfTypes(String.class, Number.class); assertThat(objects).hasOnlyElementsOfTypes(String.class);
- Specified by:
hasOnlyElementsOfTypes
in interfaceObjectEnumerableAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
types
- the expected classes and interfaces- Returns:
this
assertion object.
-
containsAll
Verifies that the actual group contains all the elements of givenIterable
, in any order.Example :
Iterable<String> abc = Arrays.asList("a", "b", "c"); // assertions will pass assertThat(abc).containsAll(Arrays.asList("b", "c")) .containsAll(Arrays.asList("a", "b", "c")); // assertions will fail assertThat(abc).containsAll(Arrays.asList("d")); assertThat(abc).containsAll(Arrays.asList("a", "b", "c", "d"));
- Specified by:
containsAll
in interfaceObjectEnumerableAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
iterable
- the givenIterable
we will get elements from.- Returns:
this
assertion object.
-
usingElementComparator
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<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
elementComparator
- the comparator to use for incoming assertion checks.- Returns:
this
assertion object.
-
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<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Returns:
this
assertion object.
-
extracting
public AbstractListAssert<?,List<? extends Object>, extractingObject, ObjectAssert<Object>> (String propertyOrField) Extract the values of the given field or property from the Iterable's elements under test into a new Iterable, this new Iterable becoming the Iterable under test.It allows you to test a property/field of the the Iterable's elements instead of testing the elements themselves, which can be be much less work !
Let's take a look at an example to make things clearer :
// build a list of TolkienCharacters: a TolkienCharacter has a name, and age and a Race (a specific class) // they can be public field or properties, both can be extracted. List<TolkienCharacter> fellowshipOfTheRing = new ArrayList<TolkienCharacter>(); fellowshipOfTheRing.add(new TolkienCharacter("Frodo", 33, HOBBIT)); fellowshipOfTheRing.add(new TolkienCharacter("Sam", 38, HOBBIT)); fellowshipOfTheRing.add(new TolkienCharacter("Gandalf", 2020, MAIA)); fellowshipOfTheRing.add(new TolkienCharacter("Legolas", 1000, ELF)); fellowshipOfTheRing.add(new TolkienCharacter("Pippin", 28, HOBBIT)); fellowshipOfTheRing.add(new TolkienCharacter("Gimli", 139, DWARF)); fellowshipOfTheRing.add(new TolkienCharacter("Aragorn", 87, MAN); fellowshipOfTheRing.add(new TolkienCharacter("Boromir", 37, MAN)); // let's verify the names of the TolkienCharacters in fellowshipOfTheRing : assertThat(fellowshipOfTheRing).extracting("name") .contains("Boromir", "Gandalf", "Frodo") .doesNotContain("Sauron", "Elrond"); // you can extract nested properties/fields like the name of the race : assertThat(fellowshipOfTheRing).extracting("race.name") .contains("Hobbit", "Elf") .doesNotContain("Orc");
A property with the given name is searched for first. If it doesn't exist a field with the given name is looked for. If the field does not exist an
IntrospectionError
is thrown. By default private fields are read but you can change this withAssertions.setAllowComparingPrivateFields(boolean)
. Trying to read a private field when it's not allowed leads to anIntrospectionError
.Note that the order of extracted property/field values is consistent with the iteration order of the Iterable under test, for example if it's a
HashSet
, you won't be able to make any assumptions on the extracted values order.
Extracting also support maps, that is, instead of extracting values from an Object, it extracts maps values corresponding to the given keys.
Example:
Employee yoda = new Employee(1L, new Name("Yoda"), 800); Employee luke = new Employee(2L, new Name("Luke"), 22); Employee han = new Employee(3L, new Name("Han"), 31); // build two maps Map<String, Employee> map1 = new HashMap<>(); map1.put("key1", yoda); map1.put("key2", luke); Map<String, Employee> map2 = new HashMap<>(); map2.put("key1", yoda); map2.put("key2", han); // instead of a list of objects, we have a list of maps List<Map<String, Employee>> maps = asList(map1, map2); // extracting a property in that case = get values from maps using the property as a key assertThat(maps).extracting("key2").containsExactly(luke, han); assertThat(maps).extracting("key1").containsExactly(yoda, yoda); // type safe version assertThat(maps).extracting(key2, Employee.class).containsExactly(luke, han); // it works with several keys, extracted values being wrapped in a Tuple assertThat(maps).extracting("key1", "key2").containsExactly(tuple(yoda, luke), tuple(yoda, han)); // unknown keys leads to null (map behavior) assertThat(maps).extracting("bad key").containsExactly(null, null);
- Parameters:
propertyOrField
- the property/field to extract from the elements of the Iterable under test- Returns:
- a new assertion object whose object under test is the list of extracted property/field values.
- Throws:
IntrospectionError
- if no field or property exists with the given name in one of the initial Iterable's element.
-
extractingResultOf
public AbstractListAssert<?,List<? extends Object>, extractingResultOfObject, ObjectAssert<Object>> (String method) Extract the result of given method invocation on the Iterable's elements under test into a new Iterable, this new Iterable becoming the Iterable under test.It allows you to test the method results of the Iterable's elements instead of testing the elements themselves. This is especially useful for classes that do not conform to the Java Bean's getter specification (i.e. public String toString() or public String status() instead of public String getStatus()).
Let's take a look at an example to make things clearer :
Following requirements have to be met to extract method results:// Build a array of WesterosHouse, a WesterosHouse has a method: public String sayTheWords() List<WesterosHouse> greatHouses = new ArrayList<WesterosHouse>(); greatHouses.add(new WesterosHouse("Stark", "Winter is Coming")); greatHouses.add(new WesterosHouse("Lannister", "Hear Me Roar!")); greatHouses.add(new WesterosHouse("Greyjoy", "We Do Not Sow")); greatHouses.add(new WesterosHouse("Baratheon", "Our is the Fury")); greatHouses.add(new WesterosHouse("Martell", "Unbowed, Unbent, Unbroken")); greatHouses.add(new WesterosHouse("Tyrell", "Growing Strong")); // let's verify the words of the great houses of Westeros: assertThat(greatHouses).extractingResultOf("sayTheWords") .contains("Winter is Coming", "We Do Not Sow", "Hear Me Roar") .doesNotContain("Lannisters always pay their debts");
- method has to be public,
- method cannot accept any arguments,
- method cannot return void.
Note that the order of extracted results is consistent with the iteration order of the Iterable under test, for example if it's a
HashSet
, you won't be able to make any assumptions on the extracted results order.- Parameters:
method
- the name of the method which result is to be extracted from the array under test- Returns:
- a new assertion object whose object under test is the Iterable of extracted values.
- Throws:
IllegalArgumentException
- if no method exists with the given name, or method is not public, or method does return void, or method accepts arguments.
-
extractingResultOf
public <P> AbstractListAssert<?,List<? extends P>, extractingResultOfP, ObjectAssert<P>> (String method, Class<P> extractedType) Extract the result of given method invocation on the Iterable's elements under test into a new list of the given class, this new List becoming the object under test.It allows you to test the method results of the Iterable's elements instead of testing the elements themselves, it is especially useful for classes that do not conform to the Java Bean's getter specification (i.e. public String toString() or public String status() instead of public String getStatus()).
Let's take an example to make things clearer :
Following requirements have to be met to extract method results:// Build a array of WesterosHouse, a WesterosHouse has a method: public String sayTheWords() List<WesterosHouse> greatHouses = new ArrayList<WesterosHouse>(); greatHouses.add(new WesterosHouse("Stark", "Winter is Coming")); greatHouses.add(new WesterosHouse("Lannister", "Hear Me Roar!")); greatHouses.add(new WesterosHouse("Greyjoy", "We Do Not Sow")); greatHouses.add(new WesterosHouse("Baratheon", "Our is the Fury")); greatHouses.add(new WesterosHouse("Martell", "Unbowed, Unbent, Unbroken")); greatHouses.add(new WesterosHouse("Tyrell", "Growing Strong")); // let's verify the words of the great houses of Westeros: assertThat(greatHouses).extractingResultOf("sayTheWords", String.class) .contains("Winter is Coming", "We Do Not Sow", "Hear Me Roar") .doesNotContain("Lannisters always pay their debts");
- method has to be public,
- method cannot accept any arguments,
- method cannot return void.
Note that the order of extracted property/field values is consistent with the iteration order of the Iterable under test, for example if it's a
HashSet
, you won't be able to make any assumptions of the extracted values order.- Parameters:
method
- the name of the method which result is to be extracted from the array under testextractedType
- type of element of the extracted List- Returns:
- a new assertion object whose object under test is the Iterable of extracted values.
- Throws:
IllegalArgumentException
- if no method exists with the given name, or method is not public, or method does return void or method accepts arguments.
-
extracting
public <P> AbstractListAssert<?,List<? extends P>, extractingP, ObjectAssert<P>> (String propertyOrField, Class<P> extractingType) Extract the values of given field or property from the Iterable's elements under test into a new Iterable, this new Iterable becoming the Iterable under test.It allows you to test a property/field of the the Iterable's elements instead of testing the elements themselves, which can be much less work !
Let's take an example to make things clearer :
A property with the given name is looked for first, if it doesn't exist then a field with the given name is looked for, if the field does not exist an// Build a list of TolkienCharacter, a TolkienCharacter has a name, and age and a Race (a specific class) // they can be public field or properties, both can be extracted. List<TolkienCharacter> fellowshipOfTheRing = new ArrayList<TolkienCharacter>(); fellowshipOfTheRing.add(new TolkienCharacter("Frodo", 33, HOBBIT)); fellowshipOfTheRing.add(new TolkienCharacter("Sam", 38, HOBBIT)); fellowshipOfTheRing.add(new TolkienCharacter("Gandalf", 2020, MAIA)); fellowshipOfTheRing.add(new TolkienCharacter("Legolas", 1000, ELF)); fellowshipOfTheRing.add(new TolkienCharacter("Pippin", 28, HOBBIT)); fellowshipOfTheRing.add(new TolkienCharacter("Gimli", 139, DWARF)); fellowshipOfTheRing.add(new TolkienCharacter("Aragorn", 87, MAN); fellowshipOfTheRing.add(new TolkienCharacter("Boromir", 37, MAN)); // let's verify the names of TolkienCharacter in fellowshipOfTheRing : assertThat(fellowshipOfTheRing).extracting("name", String.class) .contains("Boromir", "Gandalf", "Frodo") .doesNotContain("Sauron", "Elrond"); // you can extract nested property/field like the name of Race : assertThat(fellowshipOfTheRing).extracting("race.name", String.class) .contains("Hobbit", "Elf") .doesNotContain("Orc");
IntrospectionError
is thrown, by default private fields are read but you can change this withAssertions.setAllowComparingPrivateFields(boolean)
, trying to read a private field when it's not allowed leads to anIntrospectionError
.Note that the order of extracted property/field values is consistent with the iteration order of the Iterable under test, for example if it's a
HashSet
, you won't be able to make any assumptions on the extracted values order.
Extracting also support maps, that is, instead of extracting values from an Object, it extract maps values corresponding to the given keys.
Example:
Employee yoda = new Employee(1L, new Name("Yoda"), 800); Employee luke = new Employee(2L, new Name("Luke"), 22); Employee han = new Employee(3L, new Name("Han"), 31); // build two maps Map<String, Employee> map1 = new HashMap<>(); map1.put("key1", yoda); map1.put("key2", luke); Map<String, Employee> map2 = new HashMap<>(); map2.put("key1", yoda); map2.put("key2", han); // instead of a list of objects, we have a list of maps List<Map<String, Employee>> maps = asList(map1, map2); // extracting a property in that case = get values from maps using property as a key assertThat(maps).extracting(key2, Employee.class).containsExactly(luke, han); // non type safe version assertThat(maps).extracting("key2").containsExactly(luke, han); assertThat(maps).extracting("key1").containsExactly(yoda, yoda); // it works with several keys, extracted values being wrapped in a Tuple assertThat(maps).extracting("key1", "key2").containsExactly(tuple(yoda, luke), tuple(yoda, han)); // unknown keys leads to null (map behavior) assertThat(maps).extracting("bad key").containsExactly(null, null);
- Parameters:
propertyOrField
- the property/field to extract from the Iterable under testextractingType
- type to return- Returns:
- a new assertion object whose object under test is the list of extracted property/field values.
- Throws:
IntrospectionError
- if no field or property exists with the given name in one of the initial Iterable's element.
-
extracting
public AbstractListAssert<?,List<? extends Tuple>, extractingTuple, ObjectAssert<Tuple>> (String... propertiesOrFields) Extract the values of the given fields/properties from the Iterable's elements under test into a new Iterable composed of Tuples (a simple data structure), this new Iterable becoming the Iterable under test.It allows you to test fields/properties of the the Iterable's elements instead of testing the elements themselves, which can be much less work!
The Tuple data corresponds to the extracted values of the given fields/properties, for instance if you ask to extract "id", "name" and "email" then each Tuple data will be composed of id, name and email extracted from the element of the initial Iterable (the Tuple's data order is the same as the given fields/properties order).
Let's take an example to make things clearer :
A property with the given name is looked for first, if it doesn't exist then a field with the given name is looked for, if the field does not exist an// Build a list of TolkienCharacter, a TolkienCharacter has a name, and age and a Race (a specific class) // they can be public field or properties, both can be extracted. List<TolkienCharacter> fellowshipOfTheRing = new ArrayList<TolkienCharacter>(); fellowshipOfTheRing.add(new TolkienCharacter("Frodo", 33, HOBBIT)); fellowshipOfTheRing.add(new TolkienCharacter("Sam", 38, HOBBIT)); fellowshipOfTheRing.add(new TolkienCharacter("Gandalf", 2020, MAIA)); fellowshipOfTheRing.add(new TolkienCharacter("Legolas", 1000, ELF)); fellowshipOfTheRing.add(new TolkienCharacter("Pippin", 28, HOBBIT)); fellowshipOfTheRing.add(new TolkienCharacter("Gimli", 139, DWARF)); fellowshipOfTheRing.add(new TolkienCharacter("Aragorn", 87, MAN); fellowshipOfTheRing.add(new TolkienCharacter("Boromir", 37, MAN)); // let's verify 'name' and 'age' of some TolkienCharacter in fellowshipOfTheRing : assertThat(fellowshipOfTheRing).extracting("name", "age") .contains(tuple("Boromir", 37), tuple("Sam", 38), tuple("Legolas", 1000)); // extract 'name', 'age' and Race name values : assertThat(fellowshipOfTheRing).extracting("name", "age", "race.name") .contains(tuple("Boromir", 37, "Man"), tuple("Sam", 38, "Hobbit"), tuple("Legolas", 1000, "Elf"));
IntrospectionError
is thrown, by default private fields are read but you can change this withAssertions.setAllowComparingPrivateFields(boolean)
, trying to read a private field when it's not allowed leads to anIntrospectionError
.Note that the order of extracted property/field values is consistent with the iteration order of the Iterable under test, for example if it's a
HashSet
, you won't be able to make any assumptions on the extracted values order.
Extracting also support maps, that is, instead of extracting values from an Object, it extract maps values corresponding to the given keys.
Example:
Employee yoda = new Employee(1L, new Name("Yoda"), 800); Employee luke = new Employee(2L, new Name("Luke"), 22); Employee han = new Employee(3L, new Name("Han"), 31); // build two maps Map<String, Employee> map1 = new HashMap<>(); map1.put("key1", yoda); map1.put("key2", luke); Map<String, Employee> map2 = new HashMap<>(); map2.put("key1", yoda); map2.put("key2", han); // instead of a list of objects, we have a list of maps List<Map<String, Employee>> maps = asList(map1, map2); // extracting a property in that case = get values from maps using property as a key assertThat(maps).extracting("key2").containsExactly(luke, han); assertThat(maps).extracting("key1").containsExactly(yoda, yoda); // it works with several keys, extracted values being wrapped in a Tuple assertThat(maps).extracting("key1", "key2").containsExactly(tuple(yoda, luke), tuple(yoda, han)); // unknown keys leads to null (map behavior) assertThat(maps).extracting("bad key").containsExactly(null, null);
- Parameters:
propertiesOrFields
- the properties/fields to extract from the elements of the Iterable under test- Returns:
- a new assertion object whose object under test is the list of Tuple with extracted properties/fields values as data.
- Throws:
IntrospectionError
- if one of the given name does not match a field or property in one of the initial Iterable's element.
-
extracting
public <V> AbstractListAssert<?,List<? extends V>, extractingV, ObjectAssert<V>> (Extractor<? super ELEMENT, V> extractor) Extract the values from Iterable's elements under test by applying an extracting function on them. The returned iterable becomes a new object under test.It allows to test values from the elements in more safe way than by using
extracting(String)
, as it doesn't utilize introspection.Let's have a look at an example :
Note that the order of extracted property/field values is consistent with the iteration order of the Iterable under test, for example if it's a// Build a list of TolkienCharacter, a TolkienCharacter has a name, and age and a Race (a specific class) // they can be public field or properties, both can be extracted. List<TolkienCharacter> fellowshipOfTheRing = new ArrayList<TolkienCharacter>(); fellowshipOfTheRing.add(new TolkienCharacter("Frodo", 33, HOBBIT)); fellowshipOfTheRing.add(new TolkienCharacter("Sam", 38, HOBBIT)); fellowshipOfTheRing.add(new TolkienCharacter("Gandalf", 2020, MAIA)); fellowshipOfTheRing.add(new TolkienCharacter("Legolas", 1000, ELF)); fellowshipOfTheRing.add(new TolkienCharacter("Pippin", 28, HOBBIT)); fellowshipOfTheRing.add(new TolkienCharacter("Gimli", 139, DWARF)); fellowshipOfTheRing.add(new TolkienCharacter("Aragorn", 87, MAN); fellowshipOfTheRing.add(new TolkienCharacter("Boromir", 37, MAN)); // fellowship has hobbitses, right, my presioussss? assertThat(fellowshipOfTheRing).extracting(TolkienCharacter::getRace).contains(HOBBIT);
HashSet
, you won't be able to make any assumptions on the extracted values order.- Parameters:
extractor
- the object transforming input object to desired one- Returns:
- a new assertion object whose object under test is the list of values extracted
-
extracting
public <V,EXCEPTION extends Exception> AbstractListAssert<?,List<? extends V>, extractingV, ObjectAssert<V>> (ThrowingExtractor<? super ELEMENT, V, EXCEPTION> extractor) Extract the values from Iterable's elements under test by applying an extracting function (which might throw an exception) on them. The returned iterable becomes a new object under test.Any checked exception raised in the extractor is rethrown wrapped in a
RuntimeException
.It allows to test values from the elements in more safe way than by using
extracting(String)
, as it doesn't utilize introspection.Let's have a look at an example :
Note that the order of extracted property/field values is consistent with the iteration order of the Iterable under test, for example if it's a// Build a list of TolkienCharacter, a TolkienCharacter has a name, and age and a Race (a specific class) // they can be public field or properties, both can be extracted. List<TolkienCharacter> fellowshipOfTheRing = new ArrayList<TolkienCharacter>(); fellowshipOfTheRing.add(new TolkienCharacter("Frodo", 33, HOBBIT)); fellowshipOfTheRing.add(new TolkienCharacter("Sam", 38, HOBBIT)); fellowshipOfTheRing.add(new TolkienCharacter("Gandalf", 2020, MAIA)); fellowshipOfTheRing.add(new TolkienCharacter("Legolas", 1000, ELF)); fellowshipOfTheRing.add(new TolkienCharacter("Pippin", 28, HOBBIT)); fellowshipOfTheRing.add(new TolkienCharacter("Gimli", 139, DWARF)); fellowshipOfTheRing.add(new TolkienCharacter("Aragorn", 87, MAN); fellowshipOfTheRing.add(new TolkienCharacter("Boromir", 37, MAN)); assertThat(fellowshipOfTheRing).extracting(input -> { if (input.getAge() < 20) { throw new Exception("age < 20"); } return input.getName(); }).contains("Frodo");
HashSet
, you won't be able to make any assumptions on the extracted values order.- Parameters:
extractor
- the object transforming input object to desired one- Returns:
- a new assertion object whose object under test is the list of values extracted
- Since:
- 3.7.0
-
flatExtracting
public <V> AbstractListAssert<?,List<? extends V>, flatExtractingV, ObjectAssert<V>> (Extractor<? super ELEMENT, ? extends Collection<V>> extractor) Extract the Iterable values from Iterable's elements under test by applying an Iterable extracting function on them and concatenating the result lists. The returned iterable becomes a new object under test.It allows testing the results of extracting values that are represented by Iterables.
For example:
The order of extracted values is consistent with both the order of the collection itself, as well as the extracted collections.CartoonCharacter bart = new CartoonCharacter("Bart Simpson"); CartoonCharacter lisa = new CartoonCharacter("Lisa Simpson"); CartoonCharacter maggie = new CartoonCharacter("Maggie Simpson"); CartoonCharacter homer = new CartoonCharacter("Homer Simpson"); homer.addChildren(bart, lisa, maggie); CartoonCharacter pebbles = new CartoonCharacter("Pebbles Flintstone"); CartoonCharacter fred = new CartoonCharacter("Fred Flintstone"); fred.getChildren().add(pebbles); List<CartoonCharacter> parents = newArrayList(homer, fred); // check children assertThat(parent).flatExtracting(CartoonCharacter::getChildren) .containsOnly(bart, lisa, maggie, pebbles);
- Parameters:
extractor
- the object transforming input object to anIterable
of desired ones- Returns:
- a new assertion object whose object under test is the list of values extracted
- Throws:
NullPointerException
- if one of theIterable
's element is null.
-
flatExtracting
public <V,EXCEPTION extends Exception> AbstractListAssert<?,List<? extends V>, flatExtractingV, ObjectAssert<V>> (ThrowingExtractor<? super ELEMENT, ? extends Collection<V>, EXCEPTION> extractor) Extract the Iterable values from Iterable's elements under test by applying an Iterable extracting function (which might throw an exception) on them and concatenating the result lists. The returned iterable becomes a new object under test.It allows testing the results of extracting values that are represented by Iterables.
For example:
The order of extracted values is consistent with both the order of the collection itself, as well as the extracted collections.CartoonCharacter bart = new CartoonCharacter("Bart Simpson"); CartoonCharacter lisa = new CartoonCharacter("Lisa Simpson"); CartoonCharacter maggie = new CartoonCharacter("Maggie Simpson"); CartoonCharacter homer = new CartoonCharacter("Homer Simpson"); homer.addChildren(bart, lisa, maggie); CartoonCharacter pebbles = new CartoonCharacter("Pebbles Flintstone"); CartoonCharacter fred = new CartoonCharacter("Fred Flintstone"); fred.getChildren().add(pebbles); List<CartoonCharacter> parents = newArrayList(homer, fred); // check children assertThat(parent).flatExtracting((ThrowingExtractor<CartoonCharacter, List
, Exception>)input -> { if (input.getChildren().size() == 0) { throw new Exception("no children"); } return input.getChildren(); }).containsOnly(bart, lisa, maggie, pebbles); - Parameters:
extractor
- the object transforming input object to anIterable
of desired ones- Returns:
- a new assertion object whose object under test is the list of values extracted
- Throws:
NullPointerException
- if one of theIterable
's element is null.- Since:
- 3.7.0
-
doFlatExtracting
private <V> AbstractListAssert<?,List<? extends V>, doFlatExtractingV, ObjectAssert<V>> (Extractor<? super ELEMENT, ? extends Collection<V>> extractor) -
flatExtracting
@SafeVarargs public final ListAssert<Object> flatExtracting(Extractor<? super ELEMENT, ?>... extractors) Extract multiple values from eachIterable
's element according to the givenExtractor
s and concatenate/flatten the extracted values in a list that is used as the new object under test.If extracted values were not flattened, instead of a simple list like (given 2 extractors) :
element1.value1, element1.value2, element2.value1, element2.value2, ...
we would get a list of list like :list(element1.value1, element1.value2), list(element2.value1, element2.value2), ...
Code example:
The resulting extracted values list is ordered by// fellowshipOfTheRing is a List<TolkienCharacter> // values are extracted in order and flattened : age1, name1, age2, name2, age3 ... assertThat(fellowshipOfTheRing).flatExtracting(TolkienCharacter::getAge, TolkienCharacter::getName) .contains(33 ,"Frodo", 1000, "Legolas", 87, "Aragorn");
Iterable
's element first and then extracted values, this is why is in the example that age values come before names.- Parameters:
extractors
- all the extractors to apply on each actualIterable
's elements- Returns:
- a new assertion object whose object under test is a flattened list of all extracted values.
-
flatExtracting
@SafeVarargs public final <EXCEPTION extends Exception> ListAssert<Object> flatExtracting(ThrowingExtractor<? super ELEMENT, ?, EXCEPTION>... extractors) Extract multiple values from eachIterable
's element according to the givenThrowingExtractor
s and concatenate/flatten the extracted values in a list that is used as the new object under test.If extracted values were not flattened, instead of a simple list like (given 2 extractors) :
element1.value1, element1.value2, element2.value1, element2.value2, ...
we would get a list of list like :list(element1.value1, element1.value2), list(element2.value1, element2.value2), ...
Code example:
The resulting extracted values list is ordered by// fellowshipOfTheRing is a List<TolkienCharacter> // values are extracted in order and flattened : age1, name1, age2, name2, age3 ... assertThat(fellowshipOfTheRing).flatExtracting(input -> { if (input.getAge() < 20) { throw new Exception("age < 20"); } return input.getName(); }, input2 -> { if (input2.getAge() < 20) { throw new Exception("age < 20"); } return input2.getAge(); }).contains(33 ,"Frodo", 1000, "Legolas", 87, "Aragorn");
Iterable
's element first and then extracted values, this is why is in the example that age values come before names.- Parameters:
extractors
- all the extractors to apply on each actualIterable
's elements- Returns:
- a new assertion object whose object under test is a flattened list of all extracted values.
- Since:
- 3.7.0
-
flatExtracting
public AbstractListAssert<?,List<? extends Object>, flatExtractingObject, ObjectAssert<Object>> (String fieldOrPropertyName) Extract from Iterable's elements the Iterable/Array values corresponding to the given property/field name and concatenate them into a single list becoming the new object under test.It allows testing the elements of extracting values that are represented by iterables or arrays.
For example:
The order of extracted values is consisted with both the order of the collection itself, as well as the extracted collections.CartoonCharacter bart = new CartoonCharacter("Bart Simpson"); CartoonCharacter lisa = new CartoonCharacter("Lisa Simpson"); CartoonCharacter maggie = new CartoonCharacter("Maggie Simpson"); CartoonCharacter homer = new CartoonCharacter("Homer Simpson"); homer.addChildren(bart, lisa, maggie); CartoonCharacter pebbles = new CartoonCharacter("Pebbles Flintstone"); CartoonCharacter fred = new CartoonCharacter("Fred Flintstone"); fred.getChildren().add(pebbles); List<CartoonCharacter> parents = newArrayList(homer, fred); // check children assertThat(parents).flatExtracting("children") .containsOnly(bart, lisa, maggie, pebbles);
- Parameters:
fieldOrPropertyName
- the object transforming input object to an Iterable of desired ones- Returns:
- a new assertion object whose object under test is the list of values extracted
- Throws:
IllegalArgumentException
- if one of the extracted property value was not an array or an iterable.
-
extracting
Use the givenFunction
s to extract the values from theIterable
's elements into a newIterable
composed ofTuple
s (a simple data structure containing the extracted values), this newIterable
becoming the object under test.It allows you to test values from the
Iterable
's elements instead of testing the elements themselves, which sometimes can be much less work!The Tuple data corresponds to the extracted values from the Iterable's elements, for instance if you pass functions extracting "id", "name" and "email" values then each Tuple data will be composed of an id, a name and an email extracted from the element of the initial Iterable (the Tuple's data order is the same as the given functions order).
Let's take a look at an example to make things clearer :
You can use lambda expression or a method reference to extract the expected values.// Build a list of TolkienCharacter, a TolkienCharacter has a name, and age and a Race (a specific class) // they can be public field or properties, both can be extracted. List<TolkienCharacter> fellowshipOfTheRing = new ArrayList<TolkienCharacter>(); fellowshipOfTheRing.add(new TolkienCharacter("Frodo", 33, HOBBIT)); fellowshipOfTheRing.add(new TolkienCharacter("Sam", 38, HOBBIT)); fellowshipOfTheRing.add(new TolkienCharacter("Gandalf", 2020, MAIA)); fellowshipOfTheRing.add(new TolkienCharacter("Legolas", 1000, ELF)); fellowshipOfTheRing.add(new TolkienCharacter("Pippin", 28, HOBBIT)); fellowshipOfTheRing.add(new TolkienCharacter("Gimli", 139, DWARF)); fellowshipOfTheRing.add(new TolkienCharacter("Aragorn", 87, MAN); fellowshipOfTheRing.add(new TolkienCharacter("Boromir", 37, MAN)); // let's verify 'name', 'age' and Race of some TolkienCharacter in fellowshipOfTheRing : assertThat(fellowshipOfTheRing).extracting(TolkienCharacter::getName, character -> character.getAge(), TolkienCharacter::getRace) .containsOnly(tuple("Frodo", 33, HOBBIT), tuple("Sam", 38, HOBBIT), tuple("Gandalf", 2020, MAIA), tuple("Legolas", 1000, ELF), tuple("Pippin", 28, HOBBIT), tuple("Gimli", 139, DWARF), tuple("Aragorn", 87, MAN), tuple("Boromir", 37, MAN));
Use
Tuple.tuple(Object...)
to initialize the expected values.Note that the order of the extracted tuples list is consistent with the iteration order of the Iterable under test, for example if it's a
HashSet
, you won't be able to make any assumptions on the extracted tuples order.- Parameters:
extractors
- the extractor functions to extract a value from an element of the Iterable under test.- Returns:
- a new assertion object whose object under test is the list of Tuples containing the extracted values.
-
flatExtracting
public AbstractListAssert<?,List<? extends Object>, flatExtractingObject, ObjectAssert<Object>> (String... fieldOrPropertyNames) Extract the given property/field values from eachIterable
's element and flatten the extracted values in a list that is used as the new object under test.Given 2 properties, if the extracted values were not flattened, instead having a simple list like :
element1.value1, element1.value2, element2.value1, element2.value2, ...
... we would get a list of list :list(element1.value1, element1.value2), list(element2.value1, element2.value2), ...
Code example:
// fellowshipOfTheRing is a List<TolkienCharacter> // values are extracted in order and flattened : age1, name1, age2, name2, age3 ... assertThat(fellowshipOfTheRing).flatExtracting("age", "name") .contains(33 ,"Frodo", 1000, "Legolas", 87, "Aragorn");
- Parameters:
fieldOrPropertyNames
- the field and/or property names to extract from each actualIterable
's element- Returns:
- a new assertion object whose object under test is a flattened list of all extracted values.
- Throws:
IllegalArgumentException
- if fieldOrPropertyNames vararg is null or empty- Since:
- 2.5.0 / 3.5.0
-
containsExactlyElementsOf
Same asObjectEnumerableAssert.containsExactly(Object...)
but handle theIterable
to array conversion : verifies that actual contains all the elements of the given iterable and nothing else in the same order.Example :
Iterable<Ring> elvesRings = newArrayList(vilya, nenya, narya); // assertion will pass assertThat(elvesRings).containsExactlyElementsOf(newLinkedList(vilya, nenya, narya)); // assertion will fail as actual and expected order differ assertThat(elvesRings).containsExactlyElementsOf(newLinkedList(nenya, vilya, narya));
- Specified by:
containsExactlyElementsOf
in interfaceObjectEnumerableAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
iterable
- the givenIterable
we will get elements from.
-
containsOnlyElementsOf
Same semantic asObjectEnumerableAssert.containsOnly(Object[])
: verifies that actual contains all the elements of the given iterable and nothing else, in any order.Example :
Iterable<Ring> rings = newArrayList(nenya, vilya); // assertion will pass assertThat(rings).containsOnlyElementsOf(newLinkedList(nenya, vilya)) .containsOnlyElementsOf(newLinkedList(nenya, nenya, vilya, vilya)); // assertion will fail as actual does not contain narya assertThat(rings).containsOnlyElementsOf(newLinkedList(nenya, vilya, narya)); // assertion will fail as actual contains nenya assertThat(rings).containsOnlyElementsOf(newLinkedList(vilya));
- Specified by:
containsOnlyElementsOf
in interfaceObjectEnumerableAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
iterable
- the givenIterable
we will get elements from.
-
hasSameElementsAs
An alias ofObjectEnumerableAssert.containsOnlyElementsOf(Iterable)
: verifies that actual contains all the elements of the given iterable and nothing else, in any order. Example:Iterable<Ring> elvesRings = newArrayList(vilya, nenya, narya); // assertions will pass: assertThat(elvesRings).hasSameElementsAs(newArrayList(nenya, narya, vilya)) .hasSameElementsAs(newArrayList(nenya, narya, vilya, nenya)); // assertions will fail: assertThat(elvesRings).hasSameElementsAs(newArrayList(nenya, narya)); assertThat(elvesRings).hasSameElementsAs(newArrayList(nenya, narya, vilya, oneRing));
- Specified by:
hasSameElementsAs
in interfaceObjectEnumerableAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
iterable
- the Iterable whose elements we expect to be present- Returns:
- this assertion object
-
usingComparatorForElementFieldsWithNames
public <T> SELF usingComparatorForElementFieldsWithNames(Comparator<T> comparator, String... elementPropertyOrFieldNames) Allows to set a comparator to compare properties or fields of elements with the given names. A typical usage is for comparing fields of numeric type at a given precision.To be used, comparators need to be specified by this method before calling any of:
usingFieldByFieldElementComparator()
usingElementComparatorOnFields(java.lang.String...)
usingElementComparatorIgnoringFields(java.lang.String...)
usingRecursiveFieldByFieldElementComparator()
Comparators specified by this method have precedence over comparators specified by
usingComparatorForElementFieldsWithType
.Example:
public class TolkienCharacter { private String name; private double height; // constructor omitted } TolkienCharacter frodo = new TolkienCharacter("Frodo", 1.2); TolkienCharacter tallerFrodo = new TolkienCharacter("Frodo", 1.3); TolkienCharacter reallyTallFrodo = new TolkienCharacter("Frodo", 1.9); Comparator<Double> closeEnough = new Comparator<Double>() { double precision = 0.5; public int compare(Double d1, Double d2) { return Math.abs(d1 - d2) <= precision ? 0 : 1; } }; // assertions will pass assertThat(asList(frodo)).usingComparatorForElementFieldsWithNames(closeEnough, "height") .usingFieldByFieldElementComparator() .contains(tallerFrodo); assertThat(asList(frodo)).usingComparatorForElementFieldsWithNames(closeEnough, "height") .usingElementComparatorOnFields("height") .contains(tallerFrodo); assertThat(asList(frodo)).usingComparatorForElementFieldsWithNames(closeEnough, "height") .usingElementComparatorIgnoringFields("name") .contains(tallerFrodo); assertThat(asList(frodo)).usingComparatorForElementFieldsWithNames(closeEnough, "height") .usingRecursiveFieldByFieldElementComparator() .contains(tallerFrodo); // assertion will fail assertThat(asList(frodo)).usingComparatorForElementFieldsWithNames(closeEnough, "height") .usingFieldByFieldElementComparator() .containsExactly(reallyTallFrodo);
- Parameters:
comparator
- theComparator
to useelementPropertyOrFieldNames
- the names of the properties and/or fields of the elements the comparator should be used for- Returns:
this
assertions object- Since:
- 2.5.0 / 3.5.0
-
usingComparatorForElementFieldsWithType
Allows to set a specific comparator to compare properties or fields of elements with the given type. A typical usage is for comparing fields of numeric type at a given precision.To be used, comparators need to be specified by this method before calling any of:
usingFieldByFieldElementComparator()
usingElementComparatorOnFields(java.lang.String...)
usingElementComparatorIgnoringFields(java.lang.String...)
usingRecursiveFieldByFieldElementComparator()
Comparators specified by
usingComparatorForElementFieldsWithNames
have precedence over comparators specified by this method.Example:
public class TolkienCharacter { private String name; private double height; // constructor omitted } TolkienCharacter frodo = new TolkienCharacter("Frodo", 1.2); TolkienCharacter tallerFrodo = new TolkienCharacter("Frodo", 1.3); TolkienCharacter reallyTallFrodo = new TolkienCharacter("Frodo", 1.9); Comparator<Double> closeEnough = new Comparator<Double>() { double precision = 0.5; public int compare(Double d1, Double d2) { return Math.abs(d1 - d2) <= precision ? 0 : 1; } }; // assertions will pass assertThat(Arrays.asList(frodo)).usingComparatorForElementFieldsWithType(closeEnough, Double.class) .usingFieldByFieldElementComparator() .contains(tallerFrodo); assertThat(Arrays.asList(frodo)).usingComparatorForElementFieldsWithType(closeEnough, Double.class) .usingElementComparatorOnFields("height") .contains(tallerFrodo); assertThat(Arrays.asList(frodo)).usingComparatorForElementFieldsWithType(closeEnough, Double.class) .usingElementComparatorIgnoringFields("name") .contains(tallerFrodo); assertThat(Arrays.asList(frodo)).usingComparatorForElementFieldsWithType(closeEnough, Double.class) .usingRecursiveFieldByFieldElementComparator() .contains(tallerFrodo); // assertion will fail assertThat(Arrays.asList(frodo)).usingComparatorForElementFieldsWithType(closeEnough, Double.class) .usingFieldByFieldElementComparator() .contains(reallyTallFrodo);
- Parameters:
comparator
- theComparator
to usetype
- theClass
of the type of the element fields the comparator should be used for- Returns:
this
assertions object- Since:
- 2.5.0 / 3.5.0
-
usingFieldByFieldElementComparator
Use field/property by field/property comparison (including inherited fields/properties) instead of relying on actual type Aequals
method to compare group elements for incoming assertion checks. Private fields are included but this can be disabled usingAssertions.setAllowExtractingPrivateFields(boolean)
.This can be handy if
equals
method of the objects to compare does not suit you.Note that the comparison is not recursive, if one of the fields/properties is an Object, it will be compared to the other field/property using its
equals
method.You can specify a custom comparator per name or type of element field with
usingComparatorForElementFieldsWithNames(Comparator, String...)
andusingComparatorForElementFieldsWithType(Comparator, Class)
.Example:
TolkienCharacter frodo = new TolkienCharacter("Frodo", 33, HOBBIT); TolkienCharacter frodoClone = new TolkienCharacter("Frodo", 33, HOBBIT); // Fail if equals has not been overridden in TolkienCharacter as equals default implementation only compares references assertThat(newArrayList(frodo)).contains(frodoClone); // frodo and frodoClone are equals when doing a field by field comparison. assertThat(newArrayList(frodo)).usingFieldByFieldElementComparator().contains(frodoClone);
- Returns:
this
assertion object.
-
usingRecursiveFieldByFieldElementComparator
Use a recursive field/property by field/property comparison (including inherited fields/properties) instead of relying on actual typeequals
method to compare group elements for incoming assertion checks. This can be useful if actual'sequals
implementation does not suit you.The recursive property/field comparison is not applied on fields having a custom
equals
implementation, i.e. the overriddenequals
method will be used instead of a field/property by field/property comparison.The recursive comparison handles cycles.
You can specify a custom comparator per (nested) name or type of element field with
usingComparatorForElementFieldsWithNames
andusingComparatorForElementFieldsWithType
.The objects to compare can be of different types but must have the same properties/fields. For example if actual object has a
name
String field, the other object must also have one.If an object has a field and a property with the same name, the property value will be used over the field.
Example:
TolkienCharacter frodo = new TolkienCharacter("Frodo", 33, HOBBIT); TolkienCharacter pippin = new TolkienCharacter("Pippin", 28, HOBBIT); frodo.setFriend(pippin); pippin.setFriend(frodo); TolkienCharacter frodoClone = new TolkienCharacter("Frodo", 33, HOBBIT); TolkienCharacter pippinClone = new TolkienCharacter("Pippin", 28, HOBBIT); frodoClone.setFriend(pippinClone); pippinClone.setFriend(frodoClone); List<TolkienCharacter> hobbits = Arrays.asList(frodo, pippin); // fails if equals has not been overridden in TolkienCharacter as it would compares object references assertThat(hobbits).contains(frodoClone, pippinClone); // frodo/frodoClone and pippin/pippinClone are equals when doing a recursive property/field by property/field comparison assertThat(hobbits).usingRecursiveFieldByFieldElementComparator() .contains(frodoClone, pippinClone);
- Returns:
this
assertion object.- Since:
- 2.5.0 / 3.5.0
-
usingElementComparatorOnFields
Use field/property by field/property comparison on the given fields/properties only (including inherited fields/properties)instead of relying on actual type Aequals
method to compare group elements for incoming assertion checks. Private fields are included but this can be disabled usingAssertions.setAllowExtractingPrivateFields(boolean)
.This can be handy if
equals
method of the objects to compare does not suit you.You can specify a custom comparator per name or type of element field with
usingComparatorForElementFieldsWithNames(Comparator, String...)
andusingComparatorForElementFieldsWithType(Comparator, Class)
.Note that the comparison is not recursive, if one of the fields/properties is an Object, it will be compared to the other field/property using its
Example:equals
method.TolkienCharacter frodo = new TolkienCharacter("Frodo", 33, HOBBIT); TolkienCharacter sam = new TolkienCharacter("Sam", 38, HOBBIT); // frodo and sam both are hobbits, so they are equals when comparing only race assertThat(newArrayList(frodo)).usingElementComparatorOnFields("race").contains(sam); // OK // ... but not when comparing both name and race assertThat(newArrayList(frodo)).usingElementComparatorOnFields("name", "race").contains(sam); // FAIL
- Returns:
this
assertion object.
-
usingComparisonStrategy
-
usingElementComparatorIgnoringFields
Use field/property by field/property on all fields/properties except the given ones (including inherited fields/properties)instead of relying on actual type Aequals
method to compare group elements for incoming assertion checks. Private fields are included but this can be disabled usingAssertions.setAllowExtractingPrivateFields(boolean)
.This can be handy if
equals
method of the objects to compare does not suit you.You can specify a custom comparator per name or type of element field with
usingComparatorForElementFieldsWithNames(Comparator, String...)
andusingComparatorForElementFieldsWithType(Comparator, Class)
.Note that the comparison is not recursive, if one of the fields/properties is an Object, it will be compared to the other field/property using its
Example:equals
method.TolkienCharacter frodo = new TolkienCharacter("Frodo", 33, HOBBIT); TolkienCharacter sam = new TolkienCharacter("Sam", 38, HOBBIT); // frodo and sam both are hobbits, so they are equals when comparing only race (i.e. ignoring all other fields) assertThat(newArrayList(frodo)).usingElementComparatorIgnoringFields("name", "age").contains(sam); // OK // ... but not when comparing both name and race assertThat(newArrayList(frodo)).usingElementComparatorIgnoringFields("age").contains(sam); // FAIL
- Returns:
this
assertion object.
-
inHexadecimal
Enable hexadecimal representation of Iterable elements instead of standard representation in error messages.It can be useful to better understand what the error was with a more meaningful error message.
Example
With standard error message:final List<Byte> bytes = newArrayList((byte) 0x10, (byte) 0x20);
With Hexadecimal error message:assertThat(bytes).contains((byte)0x30); Expecting: <[16, 32]> to contain: <[48]> but could not find: <[48]>
assertThat(bytes).inHexadecimal().contains((byte)0x30); Expecting: <[0x10, 0x20]> to contain: <[0x30]> but could not find: <[0x30]>
- Overrides:
inHexadecimal
in classAbstractAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Returns:
this
assertion object.
-
inBinary
Enable binary representation of Iterable elements instead of standard representation in error messages.Example:
With standard error message:final List<Byte> bytes = newArrayList((byte) 0x10, (byte) 0x20);
With binary error message:assertThat(bytes).contains((byte)0x30); Expecting: <[16, 32]> to contain: <[48]> but could not find: <[48]>
assertThat(bytes).inBinary().contains((byte)0x30); Expecting: <[0b00010000, 0b00100000]> to contain: <[0b00110000]> but could not find: <[0b00110000]>
- Overrides:
inBinary
in classAbstractAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Returns:
this
assertion object.
-
filteredOn
public AbstractListAssert<?,List<? extends ELEMENT>, filteredOnELEMENT, ObjectAssert<ELEMENT>> (String propertyOrFieldName, Object expectedValue) Filter the iterable under test keeping only elements having a property or field equal toexpectedValue
, the property/field is specified bypropertyOrFieldName
parameter.The filter first tries to get the value from a property (named
propertyOrFieldName
), if no such property exists it tries to read the value from a field. Reading private fields is supported by default, this can be globally disabled by callingAssertions.setAllowExtractingPrivateFields(false)
.When reading nested property/field, if an intermediate value is null the whole nested property/field is considered to be null, thus reading "address.street.name" value will return null if "street" value is null.
As an example, let's check all employees 800 years old (yes, special employees):
Nested properties/fields are supported:Employee yoda = new Employee(1L, new Name("Yoda"), 800); Employee obiwan = new Employee(2L, new Name("Obiwan"), 800); Employee luke = new Employee(3L, new Name("Luke", "Skywalker"), 26); Employee noname = new Employee(4L, null, 50); List<Employee> employees = newArrayList(yoda, luke, obiwan, noname); assertThat(employees).filteredOn("age", 800) .containsOnly(yoda, obiwan);
// Name is bean class with 'first' and 'last' String properties // name is null for noname => it does not match the filter on "name.first" assertThat(employees).filteredOn("name.first", "Luke") .containsOnly(luke); assertThat(employees).filteredOn("name.last", "Vader") .isEmpty();
If you want to filter on null value, use
filteredOnNull(String)
as Java will resolve the call tofilteredOn(String, FilterOperator)
instead of this method.An
IntrospectionError
is thrown if the given propertyOrFieldName can't be found in one of the iterable elements.You can chain filters:
If you need more complex filter, use// fellowshipOfTheRing is a list of TolkienCharacter having race and name fields // 'not' filter is statically imported from Assertions.not assertThat(fellowshipOfTheRing).filteredOn("race.name", "Man") .filteredOn("name", not("Boromir")) .containsOnly(aragorn);
filteredOn(Predicate)
orfilteredOn(Condition)
.- Parameters:
propertyOrFieldName
- the name of the property or field to readexpectedValue
- the value to compare element's property or field with- Returns:
- a new assertion object with the filtered iterable under test
- Throws:
IllegalArgumentException
- if the given propertyOrFieldName isnull
or empty.IntrospectionError
- if the given propertyOrFieldName can't be found in one of the iterable elements.
-
filteredOnNull
public AbstractListAssert<?,List<? extends ELEMENT>, filteredOnNullELEMENT, ObjectAssert<ELEMENT>> (String propertyOrFieldName) Filter the iterable under test keeping only elements whose property or field specified bypropertyOrFieldName
is null.The filter first tries to get the value from a property (named
propertyOrFieldName
), if no such property exists it tries to read the value from a field. Reading private fields is supported by default, this can be globally disabled by callingAssertions.setAllowExtractingPrivateFields(false)
.When reading nested property/field, if an intermediate value is null the whole nested property/field is considered to be null, thus reading "address.street.name" value will return null if "street" value is null.
As an example, let's check all employees 800 years old (yes, special employees):
Nested properties/fields are supported:Employee yoda = new Employee(1L, new Name("Yoda"), 800); Employee obiwan = new Employee(2L, new Name("Obiwan"), 800); Employee luke = new Employee(3L, new Name("Luke", "Skywalker"), 26); Employee noname = new Employee(4L, null, 50); List<Employee> employees = newArrayList(yoda, luke, obiwan, noname); assertThat(employees).filteredOnNull("name") .containsOnly(noname);
An// Name is bean class with 'first' and 'last' String properties assertThat(employees).filteredOnNull("name.last") .containsOnly(yoda, obiwan, noname);
IntrospectionError
is thrown if the given propertyOrFieldName can't be found in one of the iterable elements.If you need more complex filter, use
filteredOn(Predicate)
orfilteredOn(Condition)
.- Parameters:
propertyOrFieldName
- the name of the property or field to read- Returns:
- a new assertion object with the filtered iterable under test
- Throws:
IntrospectionError
- if the given propertyOrFieldName can't be found in one of the iterable elements.
-
filteredOn
public AbstractListAssert<?,List<? extends ELEMENT>, filteredOnELEMENT, ObjectAssert<ELEMENT>> (String propertyOrFieldName, FilterOperator<?> filterOperator) Filter the iterable under test keeping only elements having a property or field matching the filter expressed with theFilterOperator
, the property/field is specified bypropertyOrFieldName
parameter.The existing filters are :
Whatever filter is applied, it first tries to get the value from a property (named
propertyOrFieldName
), if no such property exists it tries to read the value from a field. Reading private fields is supported by default, this can be globally disabled by callingAssertions.setAllowExtractingPrivateFields(false)
.When reading nested property/field, if an intermediate value is null the whole nested property/field is considered to be null, thus reading "address.street.name" value will return null if "street" value is null.
As an example, let's check stuff on some special employees :
AnEmployee yoda = new Employee(1L, new Name("Yoda"), 800); Employee obiwan = new Employee(2L, new Name("Obiwan"), 800); Employee luke = new Employee(3L, new Name("Luke", "Skywalker"), 26); List<Employee> employees = newArrayList(yoda, luke, obiwan, noname); // 'not' filter is statically imported from Assertions.not assertThat(employees).filteredOn("age", not(800)) .containsOnly(luke); // 'in' filter is statically imported from Assertions.in // Name is bean class with 'first' and 'last' String properties assertThat(employees).filteredOn("name.first", in("Yoda", "Luke")) .containsOnly(yoda, luke); // 'notIn' filter is statically imported from Assertions.notIn assertThat(employees).filteredOn("name.first", notIn("Yoda", "Luke")) .containsOnly(obiwan);
IntrospectionError
is thrown if the given propertyOrFieldName can't be found in one of the iterable elements.Note that combining filter operators is not supported, thus the following code is not correct:
// Combining filter operators like not(in(800)) is NOT supported // -> throws UnsupportedOperationException assertThat(employees).filteredOn("age", not(in(800))) .contains(luke);
You can chain filters:
If you need more complex filter, use// fellowshipOfTheRing is a list of TolkienCharacter having race and name fields // 'not' filter is statically imported from Assertions.not assertThat(fellowshipOfTheRing).filteredOn("race.name", "Man") .filteredOn("name", not("Boromir")) .containsOnly(aragorn);
filteredOn(Predicate)
orfilteredOn(Condition)
.- Parameters:
propertyOrFieldName
- the name of the property or field to readfilterOperator
- the filter operator to apply- Returns:
- a new assertion object with the filtered iterable under test
- Throws:
IllegalArgumentException
- if the given propertyOrFieldName isnull
or empty.
-
filteredOn
public AbstractListAssert<?,List<? extends ELEMENT>, filteredOnELEMENT, ObjectAssert<ELEMENT>> (Condition<? super ELEMENT> condition) Filter the iterable under test keeping only elements matching the givenCondition
.If you prefer
Predicate
overCondition
, usefilteredOn(Predicate)
.Example : check old employees whose age > 100:
You can combineEmployee yoda = new Employee(1L, new Name("Yoda"), 800); Employee obiwan = new Employee(2L, new Name("Obiwan"), 800); Employee luke = new Employee(3L, new Name("Luke", "Skywalker"), 26); Employee noname = new Employee(4L, null, 50); List<Employee> employees = newArrayList(yoda, luke, obiwan, noname); // old employee condition, "old employees" describes the condition in error message // you just have to implement 'matches' method Condition<Employee> oldEmployees = new Condition<Employee>("old employees") { @Override public boolean matches(Employee employee) { return employee.getAge() > 100; } }; } assertThat(employees).filteredOn(oldEmployees) .containsOnly(yoda, obiwan);
Condition
with condition operator likeNot
:// 'not' filter is statically imported from Assertions.not assertThat(employees).filteredOn(not(oldEmployees)) .contains(luke, noname);
- Parameters:
condition
- the filter condition / predicate- Returns:
- a new assertion object with the filtered iterable under test
- Throws:
IllegalArgumentException
- if the given condition isnull
.
-
first
Navigate and allow to perform assertions on the first element of theIterable
under test.By default available assertions after
first()
areObject
assertions, it is possible though to get more specific assertions if you createIterableAssert
with either:- the element assert class, see:
assertThat(Iterable, element assert class)
- an assert factory used that knows how to create elements assertion, see:
assertThat(Iterable, element assert factory)
Example: default
Object
assertions// default iterable assert => element assert is ObjectAssert Iterable<TolkienCharacter> hobbits = newArrayList(frodo, sam, pippin); // assertion succeeds, only Object assertions are available after first() assertThat(hobbits).first() .isEqualTo(frodo); // assertion fails assertThat(hobbits).first() .isEqualTo(pippin);
If you have created the Iterable assertion using an
AssertFactory
or the element assert class, you will be able to chainfirst()
with more specific typed assertion.Example: use of
String
assertions afterfirst()
Iterable<String> hobbits = newArrayList("frodo", "sam", "pippin"); // assertion succeeds // String assertions are available after first() assertThat(hobbits, StringAssert.class).first() .startsWith("fro") .endsWith("do"); // assertion fails assertThat(hobbits, StringAssert.class).first() .startsWith("pip");
- Returns:
- the assertion on the first element
- Throws:
AssertionError
- if the actualIterable
is empty.- Since:
- 2.5.0 / 3.5.0
- the element assert class, see:
-
last
Navigate and allow to perform assertions on the first element of theIterable
under test.By default available assertions after
last()
areObject
assertions, it is possible though to get more specific assertions if you createIterableAssert
with either:- the element assert class, see:
assertThat(Iterable, element assert class)
- an assert factory used that knows how to create elements assertion, see:
assertThat(Iterable, element assert factory)
Example: default
Object
assertions// default iterable assert => element assert is ObjectAssert Iterable<TolkienCharacter> hobbits = newArrayList(frodo, sam, pippin); // assertion succeeds, only Object assertions are available after last() assertThat(hobbits).last() .isEqualTo(pippin); // assertion fails assertThat(hobbits).last() .isEqualTo(frodo);
If you have created the Iterable assertion using an
AssertFactory
or the element assert class, you will be able to chainlast()
with more specific typed assertion.Example: use of
String
assertions afterlast()
Iterable<String> hobbits = newArrayList("frodo", "sam", "pippin"); // assertion succeeds // String assertions are available after last() assertThat(hobbits, StringAssert.class).last() .startsWith("pi") .endsWith("in"); // assertion fails assertThat(hobbits, StringAssert.class).last() .startsWith("fro");
- Returns:
- the assertion on the first element
- Throws:
AssertionError
- if the actualIterable
is empty.- Since:
- 2.5.0 / 3.5.0
- the element assert class, see:
-
lastElement
-
element
Navigate and allow to perform assertions on the chosen element of theIterable
under test.By default available assertions after
element(index)
areObject
assertions, it is possible though to get more specific assertions if you createIterableAssert
with either:- the element assert class, see:
assertThat(Iterable, element assert class)
- an assert factory used that knows how to create elements assertion, see:
assertThat(Iterable, element assert factory)
Example: default
Object
assertions// default iterable assert => element assert is ObjectAssert Iterable<TolkienCharacter> hobbits = newArrayList(frodo, sam, pippin); // assertion succeeds, only Object assertions are available after element(index) assertThat(hobbits).element(1) .isEqualTo(sam); // assertion fails assertThat(hobbits).element(1) .isEqualTo(pippin);
If you have created the Iterable assertion using an
AssertFactory
or the element assert class, you will be able to chainelement(index)
with more specific typed assertion.Example: use of
String
assertions afterelement(index)
Iterable<String> hobbits = newArrayList("frodo", "sam", "pippin"); // assertion succeeds // String assertions are available after element(index) assertThat(hobbits, StringAssert.class).element(1) .startsWith("sa") .endsWith("am"); // assertion fails assertThat(hobbits, StringAssert.class).element(1) .startsWith("fro");
- Returns:
- the assertion on the given element
- Throws:
AssertionError
- if the given index is out of bound.- Since:
- 2.5.0 / 3.5.0
- the element assert class, see:
-
toAssert
-
removeAssert
-
filteredOn
public AbstractListAssert<?,List<? extends ELEMENT>, filteredOnELEMENT, ObjectAssert<ELEMENT>> (Predicate<? super ELEMENT> predicate) Filter the iterable under test keeping only elements matching the givenPredicate
.Example : check old employees whose age > 100:
Employee yoda = new Employee(1L, new Name("Yoda"), 800); Employee obiwan = new Employee(2L, new Name("Obiwan"), 800); Employee luke = new Employee(3L, new Name("Luke", "Skywalker"), 26); List<Employee> employees = newArrayList(yoda, luke, obiwan); assertThat(employees).filteredOn(employee -> employee.getAge() > 100) .containsOnly(yoda, obiwan);
- Parameters:
predicate
- the filter predicate- Returns:
- a new assertion object with the filtered iterable under test
- Throws:
IllegalArgumentException
- if the given predicate isnull
.
-
allMatch
Verifies that all the elements of actual match the givenPredicate
.Example :
Note that you can achieve the same result withIterable<String> abc = newArrayList("a", "b", "c"); Iterable<String> abcc = newArrayList("a", "b", "cc"); // assertion will pass assertThat(abc).allMatch(s -> s.length() == 1); // assertion will fail assertThat(abcc).allMatch(s -> s.length() == 1);
are(Condition)
orhave(Condition)
.- Specified by:
allMatch
in interfaceObjectEnumerableAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
predicate
- the givenPredicate
.- Returns:
this
object.
-
allMatch
Verifies that all the elements of actual match the givenPredicate
. The predicate description is used to get an informative error message.Example :
The message of the failed assertion would be:Iterable<String> abc = newArrayList("a", "b", "c"); Iterable<String> abcc = newArrayList("a", "b", "cc"); // assertion will pass assertThat(abc).allMatch(s -> s.length() == 1, "length of 1"); // assertion will fail assertThat(abcc).allMatch(s -> s.length() == 1, "length of 1");
Expecting all elements of: <["a", "b", "cc"]> to match 'length of 1' predicate but this element did not: <"cc">
- Specified by:
allMatch
in interfaceObjectEnumerableAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
predicate
- the givenPredicate
.predicateDescription
- a description of thePredicate
used in the error message- Returns:
this
object.
-
allSatisfy
Verifies that all the elements satisfy given requirements expressed as aConsumer
.This is useful to perform a group of assertions on elements.
Example:
assertThat(myIcelanderFriends).allSatisfy(person -> { assertThat(person.getCountry()).isEqualTo("Iceland"); assertThat(person.getPhoneCountryCode()).isEqualTo("+354"); });
- Specified by:
allSatisfy
in interfaceObjectEnumerableAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
requirements
- the givenConsumer
.- Returns:
this
object.
-
anySatisfy
Verifies that at least one element satisfies the given requirements expressed as aConsumer
.This is useful to check that a group of assertions is verified by (at least) one element.
If the group of elements to assert is empty, the assertion will fail.
Example:
// assume that one icelander in myIcelanderFriends has a name finishing by 'son' assertThat(myIcelanderFriends).anySatisfy(person -> { assertThat(person.getCountry()).isEqualTo("Iceland"); assertThat(person.getSurname()).endsWith("son"); }); // assertion fails for empty group, whatever the requirements are. assertThat(emptyGroup).anySatisfy($ -> assertThat(true).isTrue());
- Specified by:
anySatisfy
in interfaceObjectEnumerableAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
requirements
- the givenConsumer
.- Returns:
this
object.
-
as
Description copied from class:AbstractAssert
Sets the description of the assertion that is going to be called after.You must set it before calling the assertion otherwise it is ignored as the failing assertion breaks the chained call by throwing an AssertionError.
The description follows
String.format(String, Object...)
syntax.Example :
try { // set a bad age to Mr Frodo which is really 33 years old. frodo.setAge(50); // specify a test description (call as() before the assertion !), it supports String format syntax. assertThat(frodo.getAge()).as("check %s's age", frodo.getName()).isEqualTo(33); } catch (AssertionError e) { assertThat(e).hasMessage("[check Frodo's age] expected:<[33]> but was:<[50]>"); }
- Specified by:
as
in interfaceDescriptable<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>> - Overrides:
as
in classAbstractAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
description
- the new description to set.args
- optional parameter if description is a format String.- Returns:
this
object.- See Also:
-
as
Description copied from class:AbstractAssert
Sets the description of the assertion that is going to be called after.You must set it before calling the assertion otherwise it is ignored as the failing assertion breaks the chained call by throwing an AssertionError.
This overloaded version of "describedAs" offers more flexibility than the one taking a
String
by allowing users to pass their own implementation of a description. For example, a description that creates its value lazily, only when an assertion failure occurs.- Specified by:
as
in interfaceDescriptable<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>> - Overrides:
as
in classAbstractAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
description
- the new description to set.- Returns:
this
object.- See Also:
-
describedAs
Description copied from class:AbstractAssert
Sets the description of the assertion that is going to be called after.You must set it before calling the assertion otherwise it is ignored as the failing assertion breaks the chained call by throwing an AssertionError.
This overloaded version of "describedAs" offers more flexibility than the one taking a
String
by allowing users to pass their own implementation of a description. For example, a description that creates its value lazily, only when an assertion failure occurs.- Specified by:
describedAs
in interfaceDescriptable<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>> - Overrides:
describedAs
in classAbstractAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
description
- the new description to set.- Returns:
this
object.
-
describedAs
Description copied from class:AbstractAssert
Sets the description of the assertion that is going to be called after.You must set it before calling the assertion otherwise it is ignored as the failing assertion breaks the chained call by throwing an AssertionError.
Alias for
since "as" is a keyword in Groovy.Descriptable.as(String, Object...)
- Specified by:
describedAs
in interfaceDescriptable<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>> - Overrides:
describedAs
in classAbstractAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
description
- the new description to set.- Returns:
this
object.
-
doesNotHave
Description copied from class:AbstractAssert
Verifies that the actual value does not satisfy the given condition. This method is an alias for
.ExtensionPoints.isNot(Condition)
- Specified by:
doesNotHave
in interfaceExtensionPoints<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Overrides:
doesNotHave
in classAbstractAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
condition
- the given condition.- Returns:
this ExtensionPoints
object.- See Also:
-
doesNotHaveSameClassAs
Description copied from class:AbstractAssert
Verifies that the actual value does not have the same class as the given object.Example:
// assertions will pass assertThat(1).doesNotHaveSameClassAs("abc"); assertThat(new ArrayList<String>()).doesNotHaveSameClassAs(new LinkedList<String>()); // assertions will fail assertThat(1).doesNotHaveSameClassAs(2); assertThat("abc").doesNotHaveSameClassAs("123"); assertThat(new ArrayList<String>()).doesNotHaveSameClassAs(new ArrayList<Integer>());
- Specified by:
doesNotHaveSameClassAs
in interfaceAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Overrides:
doesNotHaveSameClassAs
in classAbstractAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
other
- the object to check type against.- Returns:
- this assertion object.
-
has
Description copied from class:AbstractAssert
Verifies that the actual value satisfies the given condition. This method is an alias for
.ExtensionPoints.is(Condition)
- Specified by:
has
in interfaceExtensionPoints<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Overrides:
has
in classAbstractAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
condition
- the given condition.- Returns:
this ExtensionPoints
object.- See Also:
-
hasSameClassAs
Description copied from class:AbstractAssert
Verifies that the actual value has the same class as the given object.Example:
// assertions will pass assertThat(1).hasSameClassAs(2); assertThat("abc").hasSameClassAs("123"); assertThat(new ArrayList<String>()).hasSameClassAs(new ArrayList<Integer>()); // assertions will fail assertThat(1).hasSameClassAs("abc"); assertThat(new ArrayList<String>()).hasSameClassAs(new LinkedList<String>());
- Specified by:
hasSameClassAs
in interfaceAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Overrides:
hasSameClassAs
in classAbstractAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
other
- the object to check type against.- Returns:
- this assertion object.
-
hasToString
Description copied from class:AbstractAssert
Verifies that actualactual.toString()
is equal to the givenString
.Example :
CartoonCaracter homer = new CartoonCaracter("Homer"); // Instead of writing ... assertThat(homer.toString()).isEqualTo("Homer"); // ... you can simply write: assertThat(homer).hasToString("Homer");
- Specified by:
hasToString
in interfaceAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Overrides:
hasToString
in classAbstractAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
expectedToString
- the expected String description of actual.- Returns:
- this assertion object.
-
is
Description copied from class:AbstractAssert
Verifies that the actual value satisfies the given condition. This method is an alias for
.ExtensionPoints.has(Condition)
- Specified by:
is
in interfaceExtensionPoints<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Overrides:
is
in classAbstractAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
condition
- the given condition.- Returns:
this ExtensionPoints
object.- See Also:
-
isEqualTo
Description copied from class:AbstractAssert
Verifies that the actual value is equal to the given one.Example:
// assertions will pass assertThat("abc").isEqualTo("abc"); assertThat(new HashMap<String, Integer>()).isEqualTo(new HashMap<String, Integer>()); // assertions will fail assertThat("abc").isEqualTo("123"); assertThat(new ArrayList<String>()).isEqualTo(1);
- Specified by:
isEqualTo
in interfaceAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Overrides:
isEqualTo
in classAbstractAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
expected
- the given value to compare the actual value to.- Returns:
this
assertion object.
-
isExactlyInstanceOf
Description copied from class:AbstractAssert
Verifies that the actual value is exactly an instance of the given type.Example:
// assertions will pass assertThat("abc").isExactlyInstanceOf(String.class); assertThat(new ArrayList<String>()).isExactlyInstanceOf(ArrayList.class); assertThat(new HashMap<String, Integer>()).isExactlyInstanceOf(HashMap.class); // assertions will fail assertThat(1).isExactlyInstanceOf(String.class); assertThat(new ArrayList<String>()).isExactlyInstanceOf(List.class); assertThat(new HashMap<String, Integer>()).isExactlyInstanceOf(Map.class);
- Specified by:
isExactlyInstanceOf
in interfaceAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Overrides:
isExactlyInstanceOf
in classAbstractAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
type
- the type to check the actual value against.- Returns:
- this assertion object.
-
isIn
Description copied from class:AbstractAssert
Verifies that the actual value is present in the given values.Example:
Iterable<Ring> elvesRings = newArrayList(vilya, nenya, narya); // assertion will pass: assertThat(nenya).isIn(elvesRings); // assertion will fail: assertThat(oneRing).isIn(elvesRings);
- Specified by:
isIn
in interfaceAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Overrides:
isIn
in classAbstractAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
values
- the given iterable to search the actual value in.- Returns:
this
assertion object.
-
isIn
Description copied from class:AbstractAssert
Verifies that the actual value is present in the given array of values.Example:
Ring[] elvesRings = new Ring[] { vilya, nenya, narya }; // assertion will pass: assertThat(nenya).isIn(elvesRings); // assertion will fail: assertThat(oneRing).isIn(elvesRings);
- Specified by:
isIn
in interfaceAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Overrides:
isIn
in classAbstractAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
values
- the given array to search the actual value in.- Returns:
this
assertion object.
-
isInstanceOf
Description copied from class:AbstractAssert
Verifies that the actual value is an instance of the given type.Example:
// assertions will pass assertThat("abc").isInstanceOf(String.class); assertThat(new HashMap<String, Integer>()).isInstanceOf(HashMap.class); assertThat(new HashMap<String, Integer>()).isInstanceOf(Map.class); // assertions will fail assertThat(1).isInstanceOf(String.class); assertThat(new ArrayList<String>()).isInstanceOf(LinkedList.class);
- Specified by:
isInstanceOf
in interfaceAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Overrides:
isInstanceOf
in classAbstractAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
type
- the type to check the actual value against.- Returns:
- this assertion object.
-
isInstanceOfAny
Description copied from class:AbstractAssert
Verifies that the actual value is an instance of any of the given types.Example:
// assertions will pass assertThat("abc").isInstanceOfAny(String.class, Integer.class); assertThat(new ArrayList<String>()).isInstanceOfAny(LinkedList.class, ArrayList.class); assertThat(new HashMap<String, Integer>()).isInstanceOfAny(TreeMap.class, Map.class); // assertions will fail assertThat(1).isInstanceOfAny(Double.class, Float.class); assertThat(new ArrayList<String>()).isInstanceOfAny(LinkedList.class, Vector.class);
- Specified by:
isInstanceOfAny
in interfaceAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Overrides:
isInstanceOfAny
in classAbstractAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
types
- the types to check the actual value against.- Returns:
- this assertion object.
-
isNot
Description copied from class:AbstractAssert
Verifies that the actual value does not satisfy the given condition. This method is an alias for
.ExtensionPoints.doesNotHave(Condition)
- Specified by:
isNot
in interfaceExtensionPoints<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Overrides:
isNot
in classAbstractAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
condition
- the given condition.- Returns:
this ExtensionPoints
object.- See Also:
-
isNotEqualTo
Description copied from class:AbstractAssert
Verifies that the actual value is not equal to the given one.Example:
// assertions will pass assertThat("abc").isNotEqualTo("123"); assertThat(new ArrayList<String>()).isNotEqualTo(1); // assertions will fail assertThat("abc").isNotEqualTo("abc"); assertThat(new HashMap<String, Integer>()).isNotEqualTo(new HashMap<String, Integer>());
- Specified by:
isNotEqualTo
in interfaceAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Overrides:
isNotEqualTo
in classAbstractAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
other
- the given value to compare the actual value to.- Returns:
this
assertion object.
-
isNotExactlyInstanceOf
Description copied from class:AbstractAssert
Verifies that the actual value is not exactly an instance of given type.Example:
// assertions will pass assertThat(1).isNotExactlyInstanceOf(String.class); assertThat(new ArrayList<String>()).isNotExactlyInstanceOf(List.class); assertThat(new HashMap<String, Integer>()).isNotExactlyInstanceOf(Map.class); // assertions will fail assertThat("abc").isNotExactlyInstanceOf(String.class); assertThat(new ArrayList<String>()).isNotExactlyInstanceOf(ArrayList.class); assertThat(new HashMap<String, Integer>()).isNotExactlyInstanceOf(HashMap.class);
- Specified by:
isNotExactlyInstanceOf
in interfaceAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Overrides:
isNotExactlyInstanceOf
in classAbstractAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
type
- the type to check the actual value against.- Returns:
- this assertion object.
-
isNotIn
Description copied from class:AbstractAssert
Verifies that the actual value is not present in the given values.Example:
Iterable<Ring> elvesRings = newArrayList(vilya, nenya, narya); // assertion will pass: assertThat(oneRing).isNotIn(elvesRings); // assertion will fail: assertThat(nenya).isNotIn(elvesRings);
- Specified by:
isNotIn
in interfaceAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Overrides:
isNotIn
in classAbstractAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
values
- the given iterable to search the actual value in.- Returns:
this
assertion object.
-
isNotIn
Description copied from class:AbstractAssert
Verifies that the actual value is not present in the given array of values.Example:
Ring[] elvesRings = new Ring[] { vilya, nenya, narya }; // assertion will pass: assertThat(oneRing).isNotIn(elvesRings); // assertion will fail: assertThat(nenya).isNotIn(elvesRings);
- Specified by:
isNotIn
in interfaceAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Overrides:
isNotIn
in classAbstractAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
values
- the given array to search the actual value in.- Returns:
this
assertion object.
-
isNotInstanceOf
Description copied from class:AbstractAssert
Verifies that the actual value is not an instance of the given type.Example:
// assertions will pass assertThat(1).isNotInstanceOf(Double.class); assertThat(new ArrayList<String>()).isNotInstanceOf(LinkedList.class); // assertions will fail assertThat("abc").isNotInstanceOf(String.class); assertThat(new HashMap<String, Integer>()).isNotInstanceOf(HashMap.class); assertThat(new HashMap<String, Integer>()).isNotInstanceOf(Map.class);
- Specified by:
isNotInstanceOf
in interfaceAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Overrides:
isNotInstanceOf
in classAbstractAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
type
- the type to check the actual value against.- Returns:
- this assertion object.
-
isNotInstanceOfAny
Description copied from class:AbstractAssert
Verifies that the actual value is not an instance of any of the given types.Example:
// assertions will pass assertThat(1).isNotInstanceOfAny(Double.class, Float.class); assertThat(new ArrayList<String>()).isNotInstanceOfAny(LinkedList.class, Vector.class); // assertions will fail assertThat(1).isNotInstanceOfAny(Double.class, Integer.class); assertThat(new ArrayList<String>()).isNotInstanceOfAny(LinkedList.class, ArrayList.class); assertThat(new HashMap<String, Integer>()).isNotInstanceOfAny(TreeMap.class, Map.class);
- Specified by:
isNotInstanceOfAny
in interfaceAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Overrides:
isNotInstanceOfAny
in classAbstractAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
types
- the types to check the actual value against.- Returns:
- this assertion object.
-
isNotOfAnyClassIn
Description copied from class:AbstractAssert
Verifies that the actual value type is not in given types.Example:
// assertions will pass assertThat(new HashMap<String, Integer>()).isNotOfAnyClassIn(Map.class, TreeMap.class); assertThat(new ArrayList<String>()).isNotOfAnyClassIn(LinkedList.class, List.class); // assertions will fail assertThat(new HashMap<String, Integer>()).isNotOfAnyClassIn(HashMap.class, TreeMap.class); assertThat(new ArrayList<String>()).isNotOfAnyClassIn(ArrayList.class, LinkedList.class);
- Specified by:
isNotOfAnyClassIn
in interfaceAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Overrides:
isNotOfAnyClassIn
in classAbstractAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
types
- the types to check the actual value against.- Returns:
- this assertion object.
-
isNotNull
Description copied from class:AbstractAssert
Verifies that the actual value is notnull
.Example:
// assertion will pass assertThat("abc").isNotNull(); assertThat(new HashMap<String, Integer>()).isNotNull(); // assertion will fail String value = null; assertThat(value).isNotNull();
- Specified by:
isNotNull
in interfaceAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Overrides:
isNotNull
in classAbstractAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Returns:
this
assertion object.
-
isNotSameAs
Description copied from class:AbstractAssert
Verifies that the actual value is not the same as the given one, ie using == comparison.Example:
// Name is a class with first and last fields, two Names are equals if both first and last are equals. Name tyrion = new Name("Tyrion", "Lannister"); Name alias = tyrion; Name clone = new Name("Tyrion", "Lannister"); // assertions succeed: assertThat(clone).isNotSameAs(tyrion) .isEqualTo(tyrion); // assertion fails: assertThat(alias).isNotSameAs(tyrion);
- Specified by:
isNotSameAs
in interfaceAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Overrides:
isNotSameAs
in classAbstractAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
other
- the given value to compare the actual value to.- Returns:
this
assertion object.
-
isOfAnyClassIn
Description copied from class:AbstractAssert
Verifies that the actual value type is in given types.Example:
// assertions will pass assertThat(new HashMap<String, Integer>()).isOfAnyClassIn(HashMap.class, TreeMap.class); assertThat(new ArrayList<String>()).isOfAnyClassIn(ArrayList.class, LinkedList.class); // assertions will fail assertThat(new HashMap<String, Integer>()).isOfAnyClassIn(TreeMap.class, Map.class); assertThat(new ArrayList<String>()).isOfAnyClassIn(LinkedList.class, List.class);
- Specified by:
isOfAnyClassIn
in interfaceAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Overrides:
isOfAnyClassIn
in classAbstractAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
types
- the types to check the actual value against.- Returns:
- this assertion object.
-
isSameAs
Description copied from class:AbstractAssert
Verifies that the actual value is the same as the given one, ie using == comparison.Example:
// Name is a class with first and last fields, two Names are equals if both first and last are equals. Name tyrion = new Name("Tyrion", "Lannister"); Name alias = tyrion; Name clone = new Name("Tyrion", "Lannister"); // assertions succeed: assertThat(tyrion).isSameAs(alias) .isEqualTo(clone); // assertion fails: assertThat(tyrion).isSameAs(clone);
- Specified by:
isSameAs
in interfaceAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Overrides:
isSameAs
in classAbstractAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
expected
- the given value to compare the actual value to.- Returns:
this
assertion object.
-
overridingErrorMessage
Description copied from class:AbstractAssert
Overrides AssertJ default error message by the given one.The new error message is built using
String.format(String, Object...)
if you provide args parameter (if you don't, the error message is taken as it is).Example :
assertThat(player.isRookie()).overridingErrorMessage("Expecting Player <%s> to be a rookie but was not.", player) .isTrue();
- Overrides:
overridingErrorMessage
in classAbstractAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
newErrorMessage
- the error message that will replace the default one provided by Assertj.args
- the args used to fill error message as inString.format(String, Object...)
.- Returns:
- this assertion object.
-
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<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Overrides:
usingDefaultComparator
in classAbstractAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Returns:
this
assertion object.
-
usingComparator
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<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Overrides:
usingComparator
in classAbstractAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
customComparator
- the comparator to use for incoming assertion checks.- Returns:
this
assertion object.
-
withFailMessage
Description copied from class:AbstractAssert
Alternative method forAbstractAssert.overridingErrorMessage(java.lang.String, java.lang.Object...)
- Overrides:
withFailMessage
in classAbstractAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
newErrorMessage
- the error message that will replace the default one provided by Assertj.args
- the args used to fill error message as inString.format(String, Object...)
.- Returns:
- this assertion object.
-
withThreadDumpOnError
Description copied from class:AbstractAssert
In case of an assertion error, a thread dump will be printed toSystem.err
.Example :
will print a thread dump, something similar to this:assertThat("Messi").withThreadDumpOnError().isEqualTo("Ronaldo");
"JDWP Command Reader" java.lang.Thread.State: RUNNABLE "JDWP Event Helper Thread" java.lang.Thread.State: RUNNABLE "JDWP Transport Listener: dt_socket" java.lang.Thread.State: RUNNABLE "Signal Dispatcher" java.lang.Thread.State: RUNNABLE "Finalizer" java.lang.Thread.State: WAITING at java.lang.Object.wait(Native Method) at java.lang.ref.ReferenceQueue.remove(ReferenceQueue.java:135) at java.lang.ref.ReferenceQueue.remove(ReferenceQueue.java:151) at java.lang.ref.Finalizer$FinalizerThread.run(Finalizer.java:189) "Reference Handler" java.lang.Thread.State: WAITING at java.lang.Object.wait(Native Method) at java.lang.Object.wait(Object.java:503) at java.lang.ref.Reference$ReferenceHandler.run(Reference.java:133) "main" java.lang.Thread.State: RUNNABLE at sun.management.ThreadImpl.dumpThreads0(Native Method) at sun.management.ThreadImpl.dumpAllThreads(ThreadImpl.java:446) at org.assertj.core.internal.Failures.threadDumpDescription(Failures.java:193) at org.assertj.core.internal.Failures.printThreadDumpIfNeeded(Failures.java:141) at org.assertj.core.internal.Failures.failure(Failures.java:91) at org.assertj.core.internal.Objects.assertEqual(Objects.java:314) at org.assertj.core.api.AbstractAssert.isEqualTo(AbstractAssert.java:198) at org.assertj.examples.ThreadDumpOnErrorExample.main(ThreadDumpOnErrorExample.java:28)
- Specified by:
withThreadDumpOnError
in interfaceAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Overrides:
withThreadDumpOnError
in classAbstractAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Returns:
- this assertion object.
-
size
Returns anAssert
object that allows performing assertions on the size of theIterable
under test.Once this method is called, the object under test is no longer the
Iterable
but its size, to perform assertions on theIterable
, callAbstractIterableSizeAssert.returnToIterable()
.Example:
Iterable<Ring> elvesRings = newArrayList(vilya, nenya, narya); // assertion will pass: assertThat(elvesRings).size().isGreaterThan(1) .isLessThanOrEqualTo(3) .returnToIterable().contains(narya) .doesNotContain(oneRing); // assertion will fail: assertThat(elvesRings).size().isGreaterThan(3);
- Returns:
- AbstractIterableSizeAssert built with the
Iterable
's size. - Throws:
NullPointerException
- if the givenIterable
isnull
.
-