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:
AbstractCollectionAssert
,ClassBasedNavigableIterableAssert
,FactoryBasedNavigableIterableAssert
ObjectEnumerableAssert
whose actual value type is
Collection
.- Author:
- Yvonne Wang, Alex Ruiz, Mathieu Baechler, Joel Costigliola, Maciej Jaskowski, Nicolas François, Mikhail Mazursky, Mateusz Haligowski, Lovro Pandzic, Marko Bekhta
-
Field Summary
Fields inherited from class org.assertj.core.api.AbstractAssert
actual, info, myself, objects, throwUnsupportedExceptionOnEquals
-
Constructor Summary
-
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 the given requirements expressed as aConsumer
.allSatisfy
(ThrowingConsumer<? super ELEMENT> requirements) Verifies that all the elements satisfy the given requirements expressed as aThrowingConsumer
.Verifies whether any elements match the providedPredicate
.anySatisfy
(Consumer<? super ELEMENT> requirements) Verifies that at least one element satisfies the given requirements expressed as aConsumer
.anySatisfy
(ThrowingConsumer<? super ELEMENT> requirements) Verifies that at least one element satisfies the given requirements expressed as aThrowingConsumer
.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.final SELF
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.containsAnyElementsOf
(Iterable<? extends ELEMENT> iterable) final SELF
containsAnyOf
(ELEMENT... values) Verifies that the actualIterable
contains at least one of the given values.protected SELF
containsAnyOfForProxy
(ELEMENT[] values) final SELF
containsExactly
(ELEMENT... values) Verifies that the actual group contains exactly 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 exactly the elements of the given iterable and nothing else in the same order.protected SELF
containsExactlyForProxy
(ELEMENT[] values) final SELF
containsExactlyInAnyOrder
(ELEMENT... values) Verifies that the actual group contains exactly the given values and nothing else, in any order.containsExactlyInAnyOrderElementsOf
(Iterable<? extends ELEMENT> values) Verifies that the actual group contains exactly the given values and nothing else, in any order.protected SELF
containsExactlyInAnyOrderForProxy
(ELEMENT[] values) protected SELF
containsForProxy
(ELEMENT[] values) Verifies that the actual group contains at least a null element.final SELF
containsOnly
(ELEMENT... values) Verifies that the actual group contains only the given values and nothing else, in any order and ignoring duplicates (i.e.containsOnlyElementsOf
(Iterable<? extends ELEMENT> iterable) Deprecated.protected SELF
containsOnlyForProxy
(ELEMENT[] values) Verifies that the actual group contains only null elements and nothing else.final SELF
containsOnlyOnce
(ELEMENT... values) Verifies that the actual group contains the given values only once.containsOnlyOnceElementsOf
(Iterable<? extends ELEMENT> iterable) Same semantic asObjectEnumerableAssert.containsOnlyOnce(Object...)
: verifies that the actual group contains the elements of the given iterable only once.protected SELF
containsOnlyOnceForProxy
(ELEMENT[] values) final SELF
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.protected SELF
containsSequenceForProxy
(ELEMENT[] sequence) final SELF
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).protected SELF
containsSubsequenceForProxy
(ELEMENT[] subsequence) 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.final SELF
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.protected SELF
doesNotContainForProxy
(ELEMENT[] values) Verifies that the actual group does not contain null elements.final SELF
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.protected SELF
doesNotContainSequenceForProxy
(ELEMENT[] sequence) final SELF
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.protected SELF
doesNotContainSubsequenceForProxy
(ELEMENT[] subsequence) doesNotHave
(Condition<? super ACTUAL> condition) Verifies that the actual value does not satisfy the given condition.doesNotHaveAnyElementsOfTypes
(Class<?>... unexpectedTypes) Verifies that all elements in the actualIterable
do not have the specified types (including subclasses).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.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.<ASSERT extends AbstractAssert<?,
?>>
ASSERTelement
(int index, InstanceOfAssertFactory<?, ASSERT> assertFactory) Navigate and allow to perform assertions on the chosen element of theIterable
under test.elements
(int... indices) Allow to perform assertions on the elements corresponding to the given indices (the iterableIterable
under test is changed to an iterable with the selected elements).Verifies that the actual group ends with the given sequence of objects, without any other objects between them.final SELF
Verifies that the actual group ends with the given sequence of objects, without any other objects between them.protected SELF
endsWithForProxy
(ELEMENT first, ELEMENT[] rest) 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 AbstractListAssert
<?, List<? extends Tuple>, Tuple, ObjectAssert<Tuple>> extracting
(Function<? super ELEMENT, ?>... extractors) <V> AbstractListAssert
<?, List<? extends V>, V, ObjectAssert<V>> extracting
(Function<? 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.protected AbstractListAssert
<?, List<? extends Tuple>, Tuple, ObjectAssert<Tuple>> extractingForProxy
(Function<? super ELEMENT, ?>[] extractors) 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.filteredOn
(String propertyOrFieldName, Object expectedValue) Filters the iterable under test keeping only elements having a property or field equal toexpectedValue
, the property/field is specified bypropertyOrFieldName
parameter.filteredOn
(String propertyOrFieldName, FilterOperator<?> filterOperator) Filters 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.<T> SELF
filteredOn
(Function<? super ELEMENT, T> function, T expectedValue) Filters the iterable under test keeping only elements for which the result of thefunction
is equal toexpectedValue
.filteredOn
(Predicate<? super ELEMENT> predicate) Filters the iterable under test keeping only elements matching the givenPredicate
.filteredOn
(Condition<? super ELEMENT> condition) Filters the iterable under test keeping only elements matching the givenCondition
.filteredOnAssertions
(Consumer<? super ELEMENT> elementAssertions) Filters the iterable under test keeping only elements matching the given assertions specified with aConsumer
.filteredOnAssertions
(ThrowingConsumer<? super ELEMENT> elementAssertions) Filters the iterable under test keeping only elements matching the given assertions specified with aThrowingConsumer
.filteredOnNull
(String propertyOrFieldName) Filters 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.<ASSERT extends AbstractAssert<?,
?>>
ASSERTfirst
(InstanceOfAssertFactory<?, ASSERT> assertFactory) 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 Iterable's elements values corresponding to the given property/field name and concatenates them into a list becoming the new instance 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 AbstractListAssert
<?, List<? extends Object>, Object, ObjectAssert<Object>> flatExtracting
(Function<? super ELEMENT, ?>... extractors) Extracts multiple values from eachIterable
's element according to the givenFunction
s and concatenates/flattens them in a list that becomes the instance under test.<V> AbstractListAssert
<?, List<? extends V>, V, ObjectAssert<V>> flatExtracting
(Function<? super ELEMENT, ? extends Collection<V>> extractor) Extracts Iterable elements values by applying a function and concatenates the result into a list that becomes the instance under test.final <EXCEPTION extends Exception>
AbstractListAssert<?, List<? extends Object>, Object, ObjectAssert<Object>> flatExtracting
(ThrowingExtractor<? super ELEMENT, ?, EXCEPTION>... extractors) Extracts multiple values from eachIterable
's element according to the givenThrowingExtractor
s and concatenates/flattens them in a list that becomes the object under test.<V,
EXCEPTION extends Exception>
AbstractListAssert<?, List<? extends V>, V, ObjectAssert<V>> flatExtracting
(ThrowingExtractor<? super ELEMENT, ? extends Collection<V>, EXCEPTION> extractor) Extracts Iterable elements values by applying a function (which might throw a checked exception) on them and concatenates/flattens the result into a single list that becomes the instance under test.protected AbstractListAssert
<?, List<? extends Object>, Object, ObjectAssert<Object>> flatExtractingForProxy
(Function<? super ELEMENT, ?>[] extractors) final AbstractListAssert
<?, List<? extends Object>, Object, ObjectAssert<Object>> Maps multiple values from eachIterable
's element according to the givenFunction
s and concatenates/flattens them in a list that becomes the instance under test.<V> AbstractListAssert
<?, List<? extends V>, V, ObjectAssert<V>> flatMap
(Function<? super ELEMENT, ? extends Collection<V>> mapper) Maps the Iterable's elements under test by applying the givenFunction
and flattens the resulting collections in a list becoming the object under test.final <EXCEPTION extends Exception>
AbstractListAssert<?, List<? extends Object>, Object, ObjectAssert<Object>> flatMap
(ThrowingExtractor<? super ELEMENT, ?, EXCEPTION>... mappers) Maps multiple values from eachIterable
's element according to the givenThrowingExtractor
s and concatenates/flattens them in a list that becomes the object under test.<V,
EXCEPTION extends Exception>
AbstractListAssert<?, List<? extends V>, V, ObjectAssert<V>> flatMap
(ThrowingExtractor<? super ELEMENT, ? extends Collection<V>, EXCEPTION> mapper) Maps the Iterable's elements under test by applying a mapping function (which might throw a checked exception) and concatenates/flattens the result into a single list that becomes the instance under test.protected org.assertj.core.internal.TypeComparators
protected org.assertj.core.internal.TypeComparators
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).hasExactlyElementsOfTypes
(Class<?>... types) Verifies that the actual elements are of the given types in the given order, there should be as many expected types as there are actual elements.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.hasOnlyOneElementSatisfying
(Consumer<? super ELEMENT> elementAssertions) Deprecated.hasSameClassAs
(Object other) Verifies that the actual value has the same class as the given object.hasSameElementsAs
(Iterable<? extends ELEMENT> iterable) Verifies that actual contains all the elements of the given iterable and nothing else, in any order and ignoring duplicates (i.e.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.hasSizeBetween
(int lowerBoundary, int higherBoundary) Verifies that the number of values in the actual iterable is between the given boundaries (inclusive).hasSizeGreaterThan
(int boundary) Verifies that the number of values in the actual iterable is greater than the given boundary.hasSizeGreaterThanOrEqualTo
(int boundary) Verifies that the number of values in the actual iterable is greater than or equal to the given boundary.hasSizeLessThan
(int boundary) Verifies that the number of values in the actual iterable is less than the given boundary.hasSizeLessThanOrEqualTo
(int boundary) Verifies that the number of values in the actual iterable is less than or equal to the given boundary.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 iterable.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 iterable.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, i.e., 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, i.e., using == comparison.final SELF
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
.protected SELF
isSubsetOfForProxy
(ELEMENT[] values) last()
Navigate and allow to perform assertions on the last element of theIterable
under test.<ASSERT extends AbstractAssert<?,
?>>
ASSERTlast
(InstanceOfAssertFactory<?, ASSERT> assertFactory) Navigate and allow to perform assertions on the last element of theIterable
under test.final AbstractListAssert
<?, List<? extends Tuple>, Tuple, ObjectAssert<Tuple>> <V> AbstractListAssert
<?, List<? extends V>, V, ObjectAssert<V>> Maps the Iterable's elements under test by applying a mapping function, the resulting list becomes the instance under test.<V,
EXCEPTION extends Exception>
AbstractListAssert<?, List<? extends V>, V, ObjectAssert<V>> map
(ThrowingExtractor<? super ELEMENT, V, EXCEPTION> mapper) Maps the Iterable's elements by applying the given mapping function (which might throw an exception), the returned list becomes the instance under test.protected String
navigationDescription
(String propertyName) protected abstract SELF
newAbstractIterableAssert
(Iterable<? extends ELEMENT> iterable) This methods is needed to build a new concrete instance of AbstractIterableAssert after a filtering operation is executed.protected SELF
newAbstractIterableAssertForProxy
(List<ELEMENT> filteredIterable) Verifies that no elements match the givenPredicate
.noneSatisfy
(Consumer<? super ELEMENT> restrictions) Verifies that no elements satisfy the given restrictions expressed as aConsumer
.noneSatisfy
(ThrowingConsumer<? super ELEMENT> restrictions) Verifies that no elements satisfy the given restrictions expressed as aConsumer
.overridingErrorMessage
(String newErrorMessage, Object... args) Overrides AssertJ default error message by the given one.final SELF
satisfiesExactly
(Consumer<? super ELEMENT>... requirements) Verifies that each element satisfies the requirements corresponding to its index, so the first element must satisfy the first requirements, the second element the second requirements etc...final SELF
satisfiesExactly
(ThrowingConsumer<? super ELEMENT>... requirements) Verifies that each element satisfies the requirements corresponding to its index, so the first element must satisfy the first requirements, the second element the second requirements etc...protected SELF
satisfiesExactlyForProxy
(Consumer<? super ELEMENT>[] requirements) final SELF
satisfiesExactlyInAnyOrder
(Consumer<? super ELEMENT>... requirements) Verifies that at least one combination of iterable elements exists that satisfies the consumers in order (there must be as many consumers as iterable elements and once a consumer is matched it cannot be reused to match other elements).final SELF
satisfiesExactlyInAnyOrder
(ThrowingConsumer<? super ELEMENT>... requirements) Verifies that at least one combination of iterable elements exists that satisfies theThrowingConsumer
s in order (there must be as many consumers as iterable elements and once a consumer is matched it cannot be reused to match other elements).protected SELF
satisfiesExactlyInAnyOrderForProxy
(Consumer<? super ELEMENT>[] requirements) satisfiesOnlyOnce
(Consumer<? super ELEMENT> requirements) Verifies that there is exactly one element in the iterable under tests that satisfies theConsumer
.satisfiesOnlyOnce
(ThrowingConsumer<? super ELEMENT> requirements) Verifies that there is exactly one element in the iterable under tests that satisfies theThrowingConsumer
.protected SELF
satisfiesOnlyOnceForProxy
(Consumer<? super ELEMENT> requirements) Verifies that theIterable
under test contains a single element and allows to perform assertions on that element.<ASSERT extends AbstractAssert<?,
?>>
ASSERTsingleElement
(InstanceOfAssertFactory<?, ASSERT> assertFactory) Verifies that theIterable
under test contains a single element and allows to perform assertions on that element, the assertions are strongly typed according to the givenAssertFactory
parameter.size()
Returns anAssert
object that allows performing assertions on the size of theIterable
under test.final SELF
startsWith
(ELEMENT... sequence) Verifies that the actual group starts with the given sequence of objects, without any other objects between them.protected SELF
startsWithForProxy
(ELEMENT[] sequence) protected abstract ELEMENT_ASSERT
This method is used in navigating assertions likefirst()
,last()
andelement(int)
to build the assertion for the given element navigated to.usingComparator
(Comparator<? super ACTUAL> customComparator) Use the given custom comparator instead of relying on actual type A equals method for incoming assertion checks.usingComparator
(Comparator<? super ACTUAL> customComparator, String customComparatorDescription) Use the given custom comparator instead of relying on actual type A equals method for incoming assertion checks.<T> SELF
usingComparatorForElementFieldsWithNames
(Comparator<T> comparator, String... elementPropertyOrFieldNames) Deprecated.This method is used withusingFieldByFieldElementComparator()
which is deprecated in favor ofusingRecursiveFieldByFieldElementComparator(RecursiveComparisonConfiguration)
orusingRecursiveComparison()
.<T> SELF
usingComparatorForElementFieldsWithType
(Comparator<T> comparator, Class<T> type) Deprecated.This method is used withusingFieldByFieldElementComparator()
which is deprecated in favor ofusingRecursiveFieldByFieldElementComparator(RecursiveComparisonConfiguration)
orusingRecursiveComparison()
.<T> SELF
usingComparatorForType
(Comparator<T> comparator, Class<T> type) Allows to set a specific comparator for the given type of elements or their fields.protected SELF
usingComparisonStrategy
(org.assertj.core.internal.ComparisonStrategy comparisonStrategy) Revert to standard comparison for the 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) Deprecated.This method is deprecated because it performs a shallow field by field comparison, i.e.usingElementComparatorOnFields
(String... fields) Deprecated.This method is deprecated because it performs a shallow field by field comparison, i.e.Deprecated.This method is deprecated because it performs a shallow field by field comparison, i.e.Asserts that the given predicate is met for all fields of the object under test recursively (but not the object itself).usingRecursiveAssertion
(org.assertj.core.api.recursive.assertion.RecursiveAssertionConfiguration recursiveAssertionConfiguration) The same asusingRecursiveAssertion()
, but this method allows the developer to pass in an explicit recursion configuration.Enable using a recursive field by field comparison strategy when calling the chainedRecursiveComparisonAssert
,usingRecursiveComparison
(RecursiveComparisonConfiguration recursiveComparisonConfiguration) Same asusingRecursiveComparison()
but allows to specify your ownRecursiveComparisonConfiguration
.Enable using a recursive field by field comparison strategy similar tousingRecursiveComparison()
but contrary to the latter you can chain any iterable assertions after this method (this is why this method exists).Enable using a recursive field by field comparison strategy similar tousingRecursiveComparison()
but contrary to the latter you can chain any iterable assertions after this method (this is why this method exists).The assertions chained after this method will use a recursive field by field comparison on all fields (including inherited fields) except the given ones instead of relying on the elementequals
method.The assertions chained after this method will use a recursive field by field comparison on the given fields (including inherited fields) instead of relying on the elementequals
method.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
.<OTHER_ELEMENT>
SELFzipSatisfy
(Iterable<OTHER_ELEMENT> other, BiConsumer<? super ELEMENT, OTHER_ELEMENT> zipRequirements) Verifies that the zipped pairs of actual and other elements, i.e: (actual 1st element, other 1st element), (actual 2nd element, other 2nd element), ...Methods inherited from class org.assertj.core.api.AbstractAssert
areEqual, asInstanceOf, asList, assertionError, asString, descriptionText, doesNotHaveSameHashCodeAs, doesNotHaveToString, doesNotHaveToString, equals, extracting, extracting, failure, failureWithActualExpected, failWithActualExpectedAndMessage, failWithMessage, getWritableAssertionInfo, hashCode, hasSameHashCodeAs, hasToString, isElementOfCustomAssert, isInstanceOfSatisfying, isNull, matches, matches, newListAssertInstance, overridingErrorMessage, satisfies, satisfies, satisfies, satisfiesAnyOf, satisfiesAnyOf, satisfiesAnyOfForProxy, satisfiesForProxy, setCustomRepresentation, setDescriptionConsumer, setPrintAssertionsDescription, throwAssertionError, withFailMessage, withRepresentation
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.assertj.core.api.Descriptable
as, describedAs
-
Field Details
-
iterables
protected org.assertj.core.internal.Iterables iterables
-
-
Constructor Details
-
AbstractIterableAssert
-
-
Method Details
-
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.
-
hasSizeGreaterThan
Verifies that the number of values in the actual iterable is greater than the given boundary.Example:
// assertion will pass assertThat(Arrays.asList(1, 2, 3)).hasSizeGreaterThan(2); // assertion will fail assertThat(Arrays.asList(1, 2, 3)).hasSizeGreaterThan(3);
- Specified by:
hasSizeGreaterThan
in interfaceEnumerableAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
boundary
- the given value to compare the actual size to.- Returns:
this
assertion object.- Throws:
AssertionError
- if the number of values of the actual iterable is not greater than the boundary.- Since:
- 3.12.0
-
hasSizeGreaterThanOrEqualTo
Verifies that the number of values in the actual iterable is greater than or equal to the given boundary.Example:
// assertions will pass assertThat(Arrays.asList(1, 2, 3)).hasSizeGreaterThanOrEqualTo(1) .hasSizeGreaterThanOrEqualTo(3); // assertion will fail assertThat(Arrays.asList(1, 2, 3)).hasSizeGreaterThanOrEqualTo(4);
- Specified by:
hasSizeGreaterThanOrEqualTo
in interfaceEnumerableAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
boundary
- the given value to compare the actual size to.- Returns:
this
assertion object.- Throws:
AssertionError
- if the number of values of the actual iterable is not greater than or equal to the boundary.- Since:
- 3.12.0
-
hasSizeLessThan
Verifies that the number of values in the actual iterable is less than the given boundary.Example:
// assertion will pass assertThat(Arrays.asList(1, 2, 3)).hasSizeLessThan(4); // assertion will fail assertThat(Arrays.asList(1, 2, 3)).hasSizeLessThan(3);
- Specified by:
hasSizeLessThan
in interfaceEnumerableAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
boundary
- the given value to compare the actual size to.- Returns:
this
assertion object.- Throws:
AssertionError
- if the number of values of the actual iterable is not less than the boundary.- Since:
- 3.12.0
-
hasSizeLessThanOrEqualTo
Verifies that the number of values in the actual iterable is less than or equal to the given boundary.Example:
// assertions will pass assertThat(Arrays.asList(1, 2, 3)).hasSizeLessThanOrEqualTo(5) .hasSizeLessThanOrEqualTo(3); // assertion will fail assertThat(Arrays.asList(1, 2, 3)).hasSizeLessThanOrEqualTo(2);
- Specified by:
hasSizeLessThanOrEqualTo
in interfaceEnumerableAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
boundary
- the given value to compare the actual size to.- Returns:
this
assertion object.- Throws:
AssertionError
- if the number of values of the actual iterable is not less than or equal to the boundary.- Since:
- 3.12.0
-
hasSizeBetween
Verifies that the number of values in the actual iterable is between the given boundaries (inclusive).Example:
// assertions will pass assertThat(Arrays.asList(1, 2, 3)).hasSizeBetween(2, 3) .hasSizeBetween(3, 4) .hasSizeBetween(3, 3); // assertion will fail assertThat(Arrays.asList(1, 2, 3)).hasSizeBetween(4, 6);
- Specified by:
hasSizeBetween
in interfaceEnumerableAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
lowerBoundary
- the lower boundary compared to which actual size should be greater than or equal to.higherBoundary
- the higher boundary compared to which actual size should be less than or equal to.- Returns:
this
assertion object.- Throws:
AssertionError
- if the number of values of the actual iterable is not between the boundaries.- Since:
- 3.12.0
-
hasOnlyOneElementSatisfying
Deprecated.usesingleElement()
insteadVerifies that the unique element of theIterable
satisfies 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"));
- Specified by:
hasOnlyOneElementSatisfying
in interfaceObjectEnumerableAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
elementAssertions
- the assertions to perform on the unique element.- Returns:
this
assertion object.- Throws:
AssertionError
- if theIterable
does not have a unique element.AssertionError
- if theIterable
's unique element does not satisfy 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");
If you want to specify the elements to check with an
Iterable
, usecontainsAll(Iterable)
instead.- 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.
-
containsForProxy
-
containsOnly
Verifies that the actual group contains only the given values and nothing else, in any order and ignoring duplicates (i.e. once a value is found, its duplicates are also considered found).If you need to check exactly the elements and their duplicates use:
containsExactly(Object...)
if the order does mattercontainsExactlyInAnyOrder(Object...)
if the order does not matter
Example:
Iterable<String> abc = newArrayList("a", "b", "c"); // assertions will pass as order does not matter assertThat(abc).containsOnly("c", "b", "a"); // duplicates are ignored assertThat(abc).containsOnly("a", "a", "b", "c", "c"); // ... on both actual and expected values assertThat(asList("a", "a", "b")).containsOnly("a", "b") .containsOnly("a", "a", "b", "b"); // assertion will fail because "c" is missing in the given values assertThat(abc).containsOnly("a", "b"); // assertion will fail because "d" is missing in abc (use isSubsetOf if you want this assertion to pass) assertThat(abc).containsOnly("a", "b", "c", "d");
If you need to check that actual is a subset of the given values, use
ObjectEnumerableAssert.isSubsetOf(Object...)
.If you want to specify the elements to check with an
Iterable
, usecontainsOnlyElementsOf(Iterable)
instead.- 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.
-
containsOnlyForProxy
-
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.
-
containsOnlyOnceForProxy
-
containsOnlyNulls
Verifies that the actual group contains only null elements and nothing else.Example:
// assertion will pass Iterable<String> items = Arrays.asList(null, null, null); assertThat(items).containsOnlyNulls(); // assertion will fail because items2 contains a not null element Iterable<String> items2 = Arrays.asList(null, null, "notNull"); assertThat(items2).containsOnlyNulls(); // assertion will fail since an empty iterable does not contain any elements and therefore no null ones. Iterable<String> empty = new ArrayList<>(); assertThat(empty).containsOnlyNulls();
- Specified by:
containsOnlyNulls
in interfaceObjectEnumerableAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Returns:
this
assertion object.
-
containsExactly
Verifies that the actual group contains exactly 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);
If you want to specify the elements to check with an
Iterable
, usecontainsExactlyElementsOf(Iterable)
instead.- 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.
-
containsExactlyForProxy
-
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);
If you want to specify the elements to check with an
Iterable
, usecontainsExactlyInAnyOrderElementsOf(Iterable)
instead.- 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.
-
containsExactlyInAnyOrderForProxy
-
containsExactlyInAnyOrderElementsOf
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); Iterable<Ring> elvesRingsSomeMissing = newArrayList(vilya, nenya, narya); Iterable<Ring> elvesRingsDifferentOrder = newArrayList(nenya, narya, vilya, vilya); // assertion will pass assertThat(elvesRings).containsExactlyInAnyOrderElementsOf(elvesRingsDifferentOrder); // assertion will fail as vilya is contained twice in elvesRings. assertThat(elvesRings).containsExactlyInAnyOrderElementsOf(elvesRingsSomeMissing);
If you want to directly specify the elements to check, use
containsExactlyInAnyOrder(Object...)
instead.- Specified by:
containsExactlyInAnyOrderElementsOf
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));
If you want to directly specify the set of elements, use
isSubsetOf(Object...)
instead.- 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);
If you want to specify the set of elements an
Iterable
, useisSubsetOf(Iterable)
instead.- 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.
-
isSubsetOfForProxy
-
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);
If you want to specify the sequence to check with an
Iterable
, usecontainsSequence(Iterable)
instead.- 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.
-
containsSequenceForProxy
-
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));
If you want to directly specify the elements of the sequence to check, use
containsSequence(Object...)
instead.- 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);
If you want to specify the sequence not to find with an
Iterable
, usedoesNotContainSequence(Iterable)
instead.- 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.
-
doesNotContainSequenceForProxy
-
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));
If you want to directly specify the elements of the sequence not to find, use
doesNotContainSequence(Object...)
instead.- 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);
If you want to specify the elements of the subsequence to check with an
Iterable
, usecontainsSubsequence(Iterable)
instead.- 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.
-
containsSubsequenceForProxy
-
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));
If you want to directly specify the subsequence to check, use
containsSubsequence(Object...)
instead.- 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);
If you want to specify the subsequence not to find with an
Iterable
, usedoesNotContainSubsequence(Iterable)
instead.- 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.
-
doesNotContainSubsequenceForProxy
-
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));
If you want to directly specify the elements of the subsequence not to find, use
doesNotContainSubsequence(Object...)
instead.- 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");
If you want to specify the elements not to find with an
Iterable
, usedoesNotContainAnyElementsOf(Iterable)
instead.- 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.
-
doesNotContainForProxy
-
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"));
If you want to directly specify the elements not to find, use
doesNotContain(Object...)
instead.- 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.
-
startsWithForProxy
-
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:
first
- the first element of the sequence of objects to look for.rest
- the rest of the sequence of objects to look for.- Returns:
- this assertion object.
-
endsWithForProxy
-
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(new String[0]) .endsWith(new String[] {"c"}) .endsWith(new String[] {"b", "c"}); // assertions will fail assertThat(abc).endsWith(new String[] {"a"}); assertThat(abc).endsWith(new String[] {"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>> - Parameters:
condition
- the given condition.- Returns:
this
assertion object.- 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>> - Parameters:
condition
- the given condition.- Returns:
this
assertion object.- 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>> - Parameters:
times
- the minimum number of times the condition must hold.condition
- the given condition.- Returns:
this
assertion object.
-
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>> - Parameters:
times
- the maximum number of times the condition must hold.condition
- the given condition.- Returns:
this
assertion object.
-
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>> - Parameters:
times
- the exact number of times the condition must hold.condition
- the given condition.- Returns:
this
assertion object.
-
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.
-
doesNotHaveAnyElementsOfTypes
Verifies that all elements in the actualIterable
do not have the specified types (including subclasses).Example:
List<Number> numbers = new ArrayList<>(); numbers.add(1); numbers.add(2); numbers.add(3.0); // successful assertions: assertThat(numbers).doesNotHaveAnyElementsOfTypes(Long.class, Float.class); // assertion failure: assertThat(numbers).doesNotHaveAnyElementsOfTypes(Long.class, Integer.class);
- Specified by:
doesNotHaveAnyElementsOfTypes
in interfaceObjectEnumerableAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
unexpectedTypes
- the not expected types.- Returns:
- this assertion object.
- Throws:
NullPointerException
- if the given type isnull
.AssertionError
- if one element's type matches the given types.- Since:
- 2.9.0 / 3.9.0
-
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 types- Returns:
this
assertion object.
-
hasExactlyElementsOfTypes
Verifies that the actual elements are of the given types in the given order, there should be as many expected types as there are actual elements.Example:
Iterable<Object> list = Arrays.asList(1, "a", "b", 1.00); // assertion succeeds assertThat(list).hasExactlyElementsOfTypes(Integer.class, String.class, String.class, Double.class); // assertions fail // missing second String type assertThat(list).hasExactlyElementsOfTypes(Integer.class, String.class, Double.class); // no Float type in actual assertThat(list).hasExactlyElementsOfTypes(Float.class, String.class, String.class, Double.class); // correct types but wrong order assertThat(list).hasExactlyElementsOfTypes(String.class, Integer.class, String.class, Double.class); // actual has more elements than the specified expected types assertThat(list).hasExactlyElementsOfTypes(String.class);
- Specified by:
hasExactlyElementsOfTypes
in interfaceObjectEnumerableAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
types
- the expected types- 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"));
If you want to directly specify the elements to check, use
contains(Object...)
instead.- 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.
-
containsAnyOf
Verifies that the actualIterable
contains at least one of the given values.Example:
Iterable<String> abc = Arrays.asList("a", "b", "c"); // assertions will pass assertThat(abc).containsAnyOf("b") .containsAnyOf("b", "c") .containsAnyOf("a", "b", "c") .containsAnyOf("a", "b", "c", "d") .containsAnyOf("e", "f", "g", "b"); // assertions will fail assertThat(abc).containsAnyOf("d"); assertThat(abc).containsAnyOf("d", "e", "f", "g");
- Specified by:
containsAnyOf
in interfaceObjectEnumerableAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
values
- the values whose at least one which is expected to be in theIterable
under test.- Returns:
this
assertion object.- Throws:
NullPointerException
- if the array of values isnull
.IllegalArgumentException
- if the array of values is empty and theIterable
under test is not empty.AssertionError
- if theIterable
under test isnull
.AssertionError
- if theIterable
under test does not contain any of the givenvalues
.- Since:
- 2.9.0 / 3.9.0
-
containsAnyOfForProxy
-
containsAnyElementsOf
Verifies that theIterable
under test contains at least one of the givenIterable
elements.Example:
Iterable<String> abc = Arrays.asList("a", "b", "c"); // assertions will pass assertThat(abc).containsAnyElementsOf(Arrays.asList("b")) .containsAnyElementsOf(Arrays.asList("b", "c")) .containsAnyElementsOf(Arrays.asList("a", "b", "c")) .containsAnyElementsOf(Arrays.asList("a", "b", "c", "d")) .containsAnyElementsOf(Arrays.asList("e", "f", "g", "b")); // assertions will fail assertThat(abc).containsAnyElementsOf(Arrays.asList("d")); assertThat(abc).containsAnyElementsOf(Arrays.asList("d", "e", "f", "g"));
- Specified by:
containsAnyElementsOf
in interfaceObjectEnumerableAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
iterable
- the iterable whose at least one element is expected to be in theIterable
under test.- Returns:
this
assertion object.- Throws:
NullPointerException
- if the iterable of expected values isnull
.IllegalArgumentException
- if the iterable of expected values is empty and theIterable
under test is not empty.AssertionError
- if theIterable
under test isnull
.AssertionError
- if theIterable
under test does not contain any of elements from the givenIterable
.- Since:
- 2.9.0 / 3.9.0
-
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 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 an 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 an 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.- Type Parameters:
P
- the type of elements extracted.- 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 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);
- Type Parameters:
P
- the type of elements extracted.- 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 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>> (Function<? super ELEMENT, V> extractor) Extract the values from Iterable's elements under test by applying an extracting function on them. The returned iterable becomes the instance under test.It allows to test values from the elements more safely 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.- Type Parameters:
V
- the type of elements extracted.- 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
-
map
public <V> AbstractListAssert<?,List<? extends V>, mapV, ObjectAssert<V>> (Function<? super ELEMENT, V> mapper) Maps the Iterable's elements under test by applying a mapping function, the resulting list becomes the instance under test.This allows to test values from the elements more safely than by using
extracting(String)
.Let's have a look at an example:
Note that the order of mapped values is consistent with the 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) 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 precioussss? assertThat(fellowshipOfTheRing).map(TolkienCharacter::getRace) .contains(HOBBIT);
HashSet
, you won't be able to make any assumptions on the extracted values order.- Type Parameters:
V
- the type of elements resulting of the map operation.- Parameters:
mapper
- theFunction
transforming input object to desired one- Returns:
- a new assertion object whose object under test is the list of values extracted
- Since:
- 3.19.0
-
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 the instance under test.Any checked exception raised in the extractor is rethrown wrapped in a
RuntimeException
.It allows to test values from the elements more safely 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.- Type Parameters:
V
- the type of elements extracted.EXCEPTION
- the exception type ofThrowingExtractor
- 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
-
map
public <V,EXCEPTION extends Exception> AbstractListAssert<?,List<? extends V>, mapV, ObjectAssert<V>> (ThrowingExtractor<? super ELEMENT, V, EXCEPTION> mapper) Maps the Iterable's elements by applying the given mapping function (which might throw an exception), the returned list becomes the instance under test.Any checked exception raised in the function is rethrown wrapped in a
RuntimeException
.This allows to test values from the elements more safely than by using
extracting(String)
.Let's have a look at an example:
Note that the order of mapped values is consistent with the 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) 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).map(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.- Type Parameters:
V
- the type of elements extracted.EXCEPTION
- the exception type ofThrowingExtractor
- Parameters:
mapper
- the function transforming input object to desired one- Returns:
- a new assertion object whose object under test is the list of values extracted
- Since:
- 3.19.0
-
flatExtracting
public <V> AbstractListAssert<?,List<? extends V>, flatExtractingV, ObjectAssert<V>> (Function<? super ELEMENT, ? extends Collection<V>> extractor) Extracts Iterable elements values by applying a function and concatenates the result into a list that becomes the instance under test.Example:
The extracted values order is consistent with both the order of the iterable 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.getChildren().add(bart); homer.getChildren().add(lisa); homer.getChildren().add(maggie); CartoonCharacter pebbles = new CartoonCharacter("Pebbles Flintstone"); CartoonCharacter fred = new CartoonCharacter("Fred Flintstone"); fred.getChildren().add(pebbles); List<CartoonCharacter> parents = list(homer, fred); // check children property which is a List<CartoonCharacter> assertThat(parents).flatExtracting(CartoonCharacter::getChildren) .containsOnly(bart, lisa, maggie, pebbles);
- Type Parameters:
V
- the type of extracted elements.- Parameters:
extractor
- theFunction
transforming input object to anIterable
of desired ones- Returns:
- a new assertion object whose object under test is the list of values extracted
-
flatMap
public <V> AbstractListAssert<?,List<? extends V>, flatMapV, ObjectAssert<V>> (Function<? super ELEMENT, ? extends Collection<V>> mapper) Maps the Iterable's elements under test by applying the givenFunction
and flattens the resulting collections in a list becoming the object under test.Example:
The mapped values order is consistent with both the order of the iterable itself as well as the mapped 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.getChildren().add(bart); homer.getChildren().add(lisa); homer.getChildren().add(maggie); CartoonCharacter pebbles = new CartoonCharacter("Pebbles Flintstone"); CartoonCharacter fred = new CartoonCharacter("Fred Flintstone"); fred.getChildren().add(pebbles); List<CartoonCharacter> parents = list(homer, fred); // check children property which is a List<CartoonCharacter> assertThat(parents).flatMap(CartoonCharacter::getChildren) .containsOnly(bart, lisa, maggie, pebbles);
- Type Parameters:
V
- the type of mapped elements.- Parameters:
mapper
- theFunction
transforming input object to anIterable
of desired ones- Returns:
- a new assertion object whose object under test is the list of values extracted
- Since:
- 3.19.0
-
flatExtracting
public <V,EXCEPTION extends Exception> AbstractListAssert<?,List<? extends V>, flatExtractingV, ObjectAssert<V>> (ThrowingExtractor<? super ELEMENT, ? extends Collection<V>, EXCEPTION> extractor) Extracts Iterable elements values by applying a function (which might throw a checked exception) on them and concatenates/flattens the result into a single list that becomes the instance under test.Example:
The extracted values order is consistent with both the order of the iterable 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.getChildren().add(bart); homer.getChildren().add(lisa); homer.getChildren().add(maggie); CartoonCharacter pebbles = new CartoonCharacter("Pebbles Flintstone"); CartoonCharacter fred = new CartoonCharacter("Fred Flintstone"); fred.getChildren().add(pebbles); List<CartoonCharacter> parents = list(homer, fred); // check children property where getChildren() can throw an Exception! assertThat(parents).flatExtracting(CartoonCharacter::getChildren) .containsOnly(bart, lisa, maggie, pebbles);
- Type Parameters:
V
- the type of extracted values.EXCEPTION
- the exception type ofThrowingExtractor
- 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
- Since:
- 3.7.0
-
flatMap
public <V,EXCEPTION extends Exception> AbstractListAssert<?,List<? extends V>, flatMapV, ObjectAssert<V>> (ThrowingExtractor<? super ELEMENT, ? extends Collection<V>, EXCEPTION> mapper) Maps the Iterable's elements under test by applying a mapping function (which might throw a checked exception) and concatenates/flattens the result into a single list that becomes the instance under test.Example:
The mapped values order is consistent with both the order of the iterable itself as well as the mapped 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.getChildren().add(bart); homer.getChildren().add(lisa); homer.getChildren().add(maggie); CartoonCharacter pebbles = new CartoonCharacter("Pebbles Flintstone"); CartoonCharacter fred = new CartoonCharacter("Fred Flintstone"); fred.getChildren().add(pebbles); List<CartoonCharacter> parents = list(homer, fred); // check children property where getChildren() can throw an Exception! assertThat(parents).flatMap(CartoonCharacter::getChildren) .containsOnly(bart, lisa, maggie, pebbles);
- Type Parameters:
V
- the type of mapped values.EXCEPTION
- the exception type ofThrowingExtractor
- Parameters:
mapper
- 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
- Since:
- 3.19.0
-
flatExtracting
@SafeVarargs public final AbstractListAssert<?,List<? extends Object>, flatExtractingObject, ObjectAssert<Object>> (Function<? super ELEMENT, ?>... extractors) Extracts multiple values from eachIterable
's element according to the givenFunction
s and concatenates/flattens them in a list that becomes the instance 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), ...
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 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.
-
flatMap
@SafeVarargs public final AbstractListAssert<?,List<? extends Object>, flatMapObject, ObjectAssert<Object>> (Function<? super ELEMENT, ?>... mappers) Maps multiple values from eachIterable
's element according to the givenFunction
s and concatenates/flattens them in a list that becomes the instance under test.If mapped 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), ...
Example:
The resulting mapped values list is ordered by// fellowshipOfTheRing is a List<TolkienCharacter> // values are extracted in order and flattened: age1, name1, age2, name2, age3 ... assertThat(fellowshipOfTheRing).flatMap(TolkienCharacter::getAge, TolkienCharacter::getName) .contains(33 ,"Frodo", 1000, "Legolas", 87, "Aragorn");
Iterable
's element first and then mapped values, this is why is in the example age values come before names.- Parameters:
mappers
- all the mappers to apply on each actualIterable
's elements- Returns:
- a new assertion object whose object under test is a flattened list of all mapped values.
- Since:
- 3.19.0
-
flatExtractingForProxy
protected AbstractListAssert<?,List<? extends Object>, flatExtractingForProxyObject, ObjectAssert<Object>> (Function<? super ELEMENT, ?>[] extractors) -
flatExtracting
@SafeVarargs public final <EXCEPTION extends Exception> AbstractListAssert<?,List<? extends Object>, flatExtractingObject, ObjectAssert<Object>> (ThrowingExtractor<? super ELEMENT, ?, EXCEPTION>... extractors) Extracts multiple values from eachIterable
's element according to the givenThrowingExtractor
s and concatenates/flattens them in a list that becomes the 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), ...
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 age values come before names.- Type Parameters:
EXCEPTION
- the exception type ofThrowingExtractor
- 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
-
flatMap
@SafeVarargs public final <EXCEPTION extends Exception> AbstractListAssert<?,List<? extends Object>, flatMapObject, ObjectAssert<Object>> (ThrowingExtractor<? super ELEMENT, ?, EXCEPTION>... mappers) Maps multiple values from eachIterable
's element according to the givenThrowingExtractor
s and concatenates/flattens them in a list that becomes the object under test.If mapped values were not flattened, instead of a simple list like (given 2 mappers):
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), ...
Example:
The resulting mapped values list is ordered by// fellowshipOfTheRing is a List<TolkienCharacter> // values are extracted in order and flattened: age1, name1, age2, name2, age3 ... assertThat(fellowshipOfTheRing).flatMap(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 mapped values, this is why is in the example age values come before names.- Type Parameters:
EXCEPTION
- the exception type ofThrowingExtractor
- Parameters:
mappers
- all the mappers 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.19.0
-
flatExtracting
public AbstractListAssert<?,List<? extends Object>, flatExtractingObject, ObjectAssert<Object>> (String fieldOrPropertyName) Extract Iterable's elements values corresponding to the given property/field name and concatenates them into a list becoming the new instance under test.This allows testing the elements extracted values that are iterables or arrays.
For example:
The order of extracted values is consisted with both the order of the iterable 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.getChildren().add(bart); homer.getChildren().add(lisa); homer.getChildren().add(maggie); CartoonCharacter pebbles = new CartoonCharacter("Pebbles Flintstone"); CartoonCharacter fred = new CartoonCharacter("Fred Flintstone"); fred.getChildren().add(pebbles); List<CartoonCharacter> parents = list(homer, fred); // check children which is a List<CartoonCharacter> 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
@SafeVarargs public final AbstractListAssert<?,List<? extends Tuple>, extractingTuple, ObjectAssert<Tuple>> (Function<? super ELEMENT, ?>... extractors) 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 correspond 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.
-
extractingForProxy
protected AbstractListAssert<?,List<? extends Tuple>, extractingForProxyTuple, ObjectAssert<Tuple>> (Function<? super ELEMENT, ?>[] extractors) -
map
@SafeVarargs public final AbstractListAssert<?,List<? extends Tuple>, mapTuple, ObjectAssert<Tuple>> (Function<? super ELEMENT, ?>... mappers) Use the givenFunction
s to map theIterable
's elements into aList
ofTuple
s (a simple data structure containing the mapped values), this new list becoming the object under test.This 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 correspond to the extracted values from the Iterable's elements, for instance if you pass functions mapping "id", "name" and "email" values then eachTuple
data will be composed of an id, a name and an email mapped 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).map(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:
mappers
- the mapper 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.
- Since:
- 3.19.0
-
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), ...
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 exactly 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));
If you want to directly specify the elements to check, use
containsExactly(Object...)
instead.- 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.- Returns:
this
assertion object.
-
containsOnlyElementsOf
Deprecated.Same semantic asObjectEnumerableAssert.containsOnly(Object[])
: verifies that actual contains all the elements of the given iterable and nothing else, in any order and ignoring duplicates (i.e. once a value is found, its duplicates are also considered found).This assertion has been deprecated because its name is confusing, users were expecting it to behave like
ObjectEnumerableAssert.isSubsetOf(Iterable)
.For example this assertion fails when users expected it to pass:
Iterable<Ring> rings = list(nenya, vilya); // assertion fails because narya is not in rings, confusing! assertThat(rings).containsOnlyElementsOf(list(nenya, vilya, narya));
Use
ObjectEnumerableAssert.isSubsetOf(Iterable)
to check that actual is a subset of given iterable, or if you need to same assertion semantics useObjectEnumerableAssert.hasSameElementsAs(Iterable)
.Examples:
Iterable<Ring> rings = newArrayList(nenya, vilya); // assertion will pass assertThat(rings).containsOnlyElementsOf(list(nenya, vilya)) .containsOnlyElementsOf(list(nenya, nenya, vilya, vilya)); assertThat(list(nenya, nenya, vilya, vilya)).containsOnlyElementsOf(rings); // assertion will fail as actual does not contain narya assertThat(rings).containsOnlyElementsOf(list(nenya, vilya, narya)); // assertion will fail as actual contains nenya assertThat(rings).containsOnlyElementsOf(list(vilya));
If you want to directly specify the elements to check, use
containsOnly(Object...)
instead.- 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.- Returns:
this
assertion object.
-
containsOnlyOnceElementsOf
Same semantic asObjectEnumerableAssert.containsOnlyOnce(Object...)
: verifies that the actual group contains the elements of the given iterable only once.Examples :
// assertions will pass assertThat(list("winter", "is", "coming")).containsOnlyOnceElementsOf(list("winter")) .containsOnlyOnceElementsOf(list("coming", "winter")); // assertions will fail assertThat(list("winter", "is", "coming")).containsOnlyOnceElementsOf(list("Lannister")); assertThat(list("Arya", "Stark", "daughter", "of", "Ned", "Stark")).containsOnlyOnceElementsOf(list("Stark")); assertThat(list("Arya", "Stark", "daughter", "of", "Ned", "Stark")).containsOnlyOnceElementsOf(list("Stark", "Lannister", "Arya"));
If you want to directly specify the elements to check with, use
ObjectEnumerableAssert.containsOnlyOnce(Object...)
instead.- Specified by:
containsOnlyOnceElementsOf
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.
-
hasSameElementsAs
Verifies that actual contains all the elements of the given iterable and nothing else, in any order and ignoring duplicates (i.e. once a value is found, its duplicates are also considered found).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
@Deprecated public <T> SELF usingComparatorForElementFieldsWithNames(Comparator<T> comparator, String... elementPropertyOrFieldNames) Deprecated.This method is used withusingFieldByFieldElementComparator()
which is deprecated in favor ofusingRecursiveFieldByFieldElementComparator(RecursiveComparisonConfiguration)
orusingRecursiveComparison()
.When using
usingRecursiveComparison()
the equivalent is:RecursiveComparisonAssert.withEqualsForFields(java.util.function.BiPredicate, String...)
RecursiveComparisonAssert.withComparatorForFields(Comparator, String...)
and when using
RecursiveComparisonConfiguration
:Deprecated javadocAllows 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...)
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);
- Type Parameters:
T
- the type of elements to compare.- 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
@Deprecated public <T> SELF usingComparatorForElementFieldsWithType(Comparator<T> comparator, Class<T> type) Deprecated.This method is used withusingFieldByFieldElementComparator()
which is deprecated in favor ofusingRecursiveFieldByFieldElementComparator(RecursiveComparisonConfiguration)
orusingRecursiveComparison()
.When using
usingRecursiveComparison()
the equivalent is:RecursiveComparisonAssert.withEqualsForType(java.util.function.BiPredicate, Class)
RecursiveComparisonAssert.withComparatorForType(Comparator, Class)
and when using
RecursiveComparisonConfiguration
:Deprecated javadocAllows 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...)
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);
- Type Parameters:
T
- the type of elements to compare.- 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
-
usingComparatorForType
Allows to set a specific comparator for the given type of elements or their fields. ExtendsusingComparatorForElementFieldsWithType(java.util.Comparator<T>, java.lang.Class<T>)
by applying comparator specified for given type to elements themselves, not only to their fields.Usage of this method affects comparators set by next methods:
usingFieldByFieldElementComparator()
usingElementComparatorOnFields(java.lang.String...)
usingElementComparatorIgnoringFields(java.lang.String...)
Example:
// assertion will pass assertThat(asList("some", new BigDecimal("4.2"))) .usingComparatorForType(BIG_DECIMAL_COMPARATOR, BigDecimal.class) .contains(new BigDecimal("4.20"));
- Type Parameters:
T
- the type of elements to compare.- Parameters:
comparator
- theComparator
to usetype
- theClass
of the type of the element or element fields the comparator should be used for- Returns:
this
assertions object- Since:
- 2.9.0 / 3.9.0
-
usingFieldByFieldElementComparator
Deprecated.This method is deprecated because it performs a shallow field by field comparison, i.e. elements are compared field by field but the fields are compared with equals, useusingRecursiveFieldByFieldElementComparator()
orusingRecursiveComparison()
instead to perform a true recursive comparison.
See https://assertj.github.io/doc/#assertj-core-recursive-comparisonDeprecated javadocUse field/property by field/property comparison (including inherited fields/properties) instead of relying on actual type A
equals
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
Enable using a recursive field by field comparison strategy similar tousingRecursiveComparison()
but contrary to the latter you can chain any iterable assertions after this method (this is why this method exists).This method uses the default
RecursiveComparisonConfiguration
, if you need to customize it useusingRecursiveFieldByFieldElementComparator(RecursiveComparisonConfiguration)
instead.Breaking change: since 3.20.0 the comparison won't use any comparators set with:
usingComparatorForType(Comparator, Class)
withTypeComparators(TypeComparators)
usingComparatorForElementFieldsWithType(Comparator, Class)
withComparatorsForElementPropertyOrFieldTypes(TypeComparators)
usingComparatorForElementFieldsWithNames(Comparator, String...)
withComparatorsForElementPropertyOrFieldNames(Map)
These features (and many more) are provided through
usingRecursiveFieldByFieldElementComparator(RecursiveComparisonConfiguration)
with a customizedRecursiveComparisonConfiguration
where there methods are called:registerComparatorForType(Comparator, Class)
/withComparatorForType(Comparator, Class)
(usingRecursiveComparisonConfiguration.Builder
)registerEqualsForType(BiPredicate, Class)
/withComparatorForType(Comparator, Class)
(usingRecursiveComparisonConfiguration.Builder
)registerComparatorForFields(Comparator comparator, String... fields)
/withComparatorForField(Comparator comparator, String... fields)
(usingRecursiveComparisonConfiguration.Builder
)
There are differences between this approach and
usingRecursiveComparison()
:- contrary to
RecursiveComparisonAssert
, you can chain any iterable assertions after this method. - no comparators registered with
usingComparatorForType(Comparator, Class)
will be used, you need to register them in the configuration object. - the assertion errors won't be as detailed as
RecursiveComparisonAssert.isEqualTo(Object)
which shows the field differences.
This last point makes sense, take the
contains(Object...)
assertion, it would not be relevant to report the differences of all the iterable's elements differing from the values to look for.Example:
public class Person { String name; boolean hasPhd; } public class Doctor { String name; boolean hasPhd; } Doctor drSheldon = new Doctor("Sheldon Cooper", true); Doctor drLeonard = new Doctor("Leonard Hofstadter", true); Doctor drRaj = new Doctor("Raj Koothrappali", true); Person sheldon = new Person("Sheldon Cooper", true); Person leonard = new Person("Leonard Hofstadter", true); Person raj = new Person("Raj Koothrappali", true); Person howard = new Person("Howard Wolowitz", true); List<Doctor> doctors = list(drSheldon, drLeonard, drRaj); List<Person> people = list(sheldon, leonard, raj); // assertion succeeds as both lists contains equivalent items in order. assertThat(doctors).usingRecursiveFieldByFieldElementComparator() .contains(sheldon); // assertion fails because leonard names are different. leonard.setName("Leonard Ofstater"); assertThat(doctors).usingRecursiveFieldByFieldElementComparator() .contains(leonard); // assertion fails because howard is missing and leonard is not expected. people = list(howard, sheldon, raj) assertThat(doctors).usingRecursiveFieldByFieldElementComparator() .contains(howard);
Another point worth mentioning: elements order does matter if the expected iterable is ordered, for example comparing a
Set<Person>
to aList<Person>
fails asList
is ordered andSet
is not.
The ordering can be ignored by callingignoringCollectionOrder
allowing ordered/unordered iterable comparison, note thatignoringCollectionOrder
is applied recursively on any nested iterable fields, if this behavior is too generic, use the more fine grainedignoringCollectionOrderInFields
orignoringCollectionOrderInFieldsMatchingRegexes
.- Returns:
this
assertion object.- Since:
- 2.5.0 / 3.5.0 - breaking change in 3.20.0
- See Also:
-
usingRecursiveFieldByFieldElementComparator
public SELF usingRecursiveFieldByFieldElementComparator(RecursiveComparisonConfiguration configuration) Enable using a recursive field by field comparison strategy similar tousingRecursiveComparison()
but contrary to the latter you can chain any iterable assertions after this method (this is why this method exists).The given
RecursiveComparisonConfiguration
is used to tweak the comparison behavior, for example byignoring collection order
.Warning: the comparison won't use any comparators set with:
usingComparatorForType(Comparator, Class)
withTypeComparators(TypeComparators)
usingComparatorForElementFieldsWithType(Comparator, Class)
withComparatorsForElementPropertyOrFieldTypes(TypeComparators)
usingComparatorForElementFieldsWithNames(Comparator, String...)
withComparatorsForElementPropertyOrFieldNames(Map)
These features (and many more) are provided through
RecursiveComparisonConfiguration
with:registerComparatorForType(Comparator, Class)
/withComparatorForType(Comparator, Class)
(usingRecursiveComparisonConfiguration.Builder
)registerEqualsForType(BiPredicate, Class)
/withComparatorForType(Comparator, Class)
(usingRecursiveComparisonConfiguration.Builder
)registerComparatorForFields(Comparator comparator, String... fields)
/withComparatorForField(Comparator comparator, String... fields)
(usingRecursiveComparisonConfiguration.Builder
)
RecursiveComparisonConfiguration exposes a
builder
to ease setting the comparison behaviour, callRecursiveComparisonConfiguration.builder()
to start building your configuration.There are differences between this approach and
usingRecursiveComparison()
:- contrary to
RecursiveComparisonAssert
, you can chain any iterable assertions after this method. - no comparators registered with
usingComparatorForType(Comparator, Class)
will be used, you need to register them in the configuration object. - the assertion errors won't be as detailed as
RecursiveComparisonAssert.isEqualTo(Object)
which shows the field differences.
This last point makes sense, take the
contains(Object...)
assertion, it would not be relevant to report the differences of all the iterable's elements differing from the values to look for.Example:
A detailed documentation for the recursive comparison is available here: https://assertj.github.io/doc/#assertj-core-recursive-comparison.public class Person { String name; boolean hasPhd; } public class Doctor { String name; boolean hasPhd; } Doctor drSheldon = new Doctor("Sheldon Cooper", true); Doctor drLeonard = new Doctor("Leonard Hofstadter", true); Doctor drRaj = new Doctor("Raj Koothrappali", true); Person sheldon = new Person("Sheldon Cooper", false); Person leonard = new Person("Leonard Hofstadter", false); Person raj = new Person("Raj Koothrappali", false); Person howard = new Person("Howard Wolowitz", false); List<Doctor> doctors = list(drSheldon, drLeonard, drRaj); List<Person> people = list(sheldon, leonard, raj); RecursiveComparisonConfiguration configuration = RecursiveComparisonConfiguration.builder() .withIgnoredFields("hasPhd"); // assertion succeeds as both lists contains equivalent items in order. assertThat(doctors).usingRecursiveFieldByFieldElementComparator(configuration) .contains(sheldon); // assertion fails because leonard names are different. leonard.setName("Leonard Ofstater"); assertThat(doctors).usingRecursiveFieldByFieldElementComparator(configuration) .contains(leonard); // assertion fails because howard is missing and leonard is not expected. people = list(howard, sheldon, raj) assertThat(doctors).usingRecursiveFieldByFieldElementComparator(configuration) .contains(howard);
The default recursive comparison behavior is
configured
as follows:- different types of iterable can be compared by default, this allows to compare for example an
List<Person>
and aLinkedHashSet<PersonDto>
.
This behavior can be turned off by callingwithStrictTypeChecking
. - overridden equals methods are used in the comparison (unless stated otherwise - see https://assertj.github.io/doc/#assertj-core-recursive-comparison-ignoring-equals)
- the following types are compared with these comparators:
java.lang.Double
:DoubleComparator
with precision of 1.0E-15java.lang.Float
:FloatComparator
with precision of 1.0E-6
Another point worth mentioning: elements order does matter if the expected iterable is ordered, for example comparing a
Set<Person>
to aList<Person>
fails asList
is ordered andSet
is not.
The ordering can be ignored by callingignoringCollectionOrder
allowing ordered/unordered iterable comparison, note thatignoringCollectionOrder
is applied recursively on any nested iterable fields, if this behavior is too generic, use the more fine grainedignoringCollectionOrderInFields
orignoringCollectionOrderInFieldsMatchingRegexes
.- Parameters:
configuration
- the recursive comparison configuration.- Returns:
this
assertion object.- Since:
- 3.17.0
- See Also:
-
usingRecursiveComparison
Enable using a recursive field by field comparison strategy when calling the chainedRecursiveComparisonAssert
,There are differences between this approach and
usingRecursiveFieldByFieldElementComparator(RecursiveComparisonConfiguration)
:- you can only chain
RecursiveComparisonAssert
assertions (basicallyisEqualTo
) and (basicallyisNotEqualTo
), no iterable assertions. isEqualTo
assertion error will report all field differences (very detailed).- no comparators registered with
usingComparatorForType(Comparator, Class)
will be used, you need to register them in chained call likeRecursiveComparisonAssert.withComparatorForType(Comparator, Class)
.
If you need to chain iterable assertions using recursive comparisons call
usingRecursiveFieldByFieldElementComparator(RecursiveComparisonConfiguration)
instead.Example:
A detailed documentation for the recursive comparison is available here: https://assertj.github.io/doc/#assertj-core-recursive-comparison.public class Person { String name; boolean hasPhd; } public class Doctor { String name; boolean hasPhd; } Doctor drSheldon = new Doctor("Sheldon Cooper", true); Doctor drLeonard = new Doctor("Leonard Hofstadter", true); Doctor drRaj = new Doctor("Raj Koothrappali", true); Person sheldon = new Person("Sheldon Cooper", true); Person leonard = new Person("Leonard Hofstadter", true); Person raj = new Person("Raj Koothrappali", true); Person howard = new Person("Howard Wolowitz", false); List<Doctor> doctors = Arrays.asList(drSheldon, drLeonard, drRaj); List<Person> people = Arrays.asList(sheldon, leonard, raj); // assertion succeeds as both lists contains equivalent items in order. assertThat(doctors).usingRecursiveComparison() .isEqualTo(people); // assertion fails because leonard names are different. leonard.setName("Leonard Ofstater"); assertThat(doctors).usingRecursiveComparison() .isEqualTo(people); // assertion fails because howard is missing and leonard is not expected. people = Arrays.asList(howard, sheldon, raj) assertThat(doctors).usingRecursiveComparison() .isEqualTo(people);
The default recursive comparison behavior is
configured
as follows:- different types of iterable can be compared by default, this allows to compare for example an
List<Person>
and aLinkedHashSet<PersonDto>
.
This behavior can be turned off by callingwithStrictTypeChecking
. - overridden equals methods are used in the comparison (unless stated otherwise - see https://assertj.github.io/doc/#assertj-core-recursive-comparison-ignoring-equals)
- the following types are compared with these comparators:
java.lang.Double
:DoubleComparator
with precision of 1.0E-15java.lang.Float
:FloatComparator
with precision of 1.0E-6
Another point worth mentioning: elements order does matter if the expected iterable is ordered, for example comparing a
Set<Person>
to aList<Person>
fails asList
is ordered andSet
is not.
The ordering can be ignored by callingignoringCollectionOrder
allowing ordered/unordered iterable comparison, note thatignoringCollectionOrder
is applied recursively on any nested iterable fields, if this behavior is too generic, use the more fine grainedignoringCollectionOrderInFields
orignoringCollectionOrderInFieldsMatchingRegexes
.At the moment, only `isEqualTo` can be chained after this method but there are plans to provide assertions.
- Overrides:
usingRecursiveComparison
in classAbstractAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Returns:
- a new
RecursiveComparisonAssert
instance - Since:
- 3.15.0
- See Also:
- you can only chain
-
usingRecursiveComparison
public RecursiveComparisonAssert<?> usingRecursiveComparison(RecursiveComparisonConfiguration recursiveComparisonConfiguration) Same asusingRecursiveComparison()
but allows to specify your ownRecursiveComparisonConfiguration
.Another difference is that any comparators previously registered with
usingComparatorForType(Comparator, Class)
will be used in the comparison.- Overrides:
usingRecursiveComparison
in classAbstractAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
recursiveComparisonConfiguration
- theRecursiveComparisonConfiguration
used in the chainedisEqualTo
assertion.- Returns:
- a new
RecursiveComparisonAssert
instance built with the givenRecursiveComparisonConfiguration
. - Since:
- 3.15.0
-
usingRecursiveAssertion
Asserts that the given predicate is met for all fields of the object under test recursively (but not the object itself).
For example if the object under test is an instance of class A, A has a B field and B a C field then the assertion checks A's B field and B's C field and all C's fields.
The recursive algorithm employs cycle detection, so object graphs with cyclic references can safely be asserted over without causing looping.
This method enables recursive asserting using default configuration, which means all fields of all objects have the
Predicate
applied to them (including primitive fields), no fields are excluded, but:- The recursion does not enter into Java Class Library types (java.*, javax.*)
- The
Predicate
is applied toCollection
and array elements (but not the collection/array itself) - The
Predicate
is applied toMap
values but not the map itself or its keys - The
Predicate
is applied toOptional
and primitive optional values
You can change how the recursive assertion deals with arrays, collections, maps and optionals, see:
RecursiveAssertionAssert.withCollectionAssertionPolicy(RecursiveAssertionConfiguration.CollectionAssertionPolicy)
for collections and arraysRecursiveAssertionAssert.withMapAssertionPolicy(RecursiveAssertionConfiguration.MapAssertionPolicy)
for mapsRecursiveAssertionAssert.withOptionalAssertionPolicy(RecursiveAssertionConfiguration.OptionalAssertionPolicy)
for optionals
It is possible to assert several predicates over the object graph in a row.
The classes used in recursive asserting are not thread safe. Care must be taken when running tests in parallel not to run assertions over object graphs that are being shared between tests.
Example
class Author { String name; String email; List<Book> books = new ArrayList<>(); Author(String name, String email) { this.name = name; this.email = email; } } class Book { String title; Author[] authors; Book(String title, Author[] authors) { this.title = title; this.authors = authors; } } Author pramodSadalage = new Author("Pramod Sadalage", "[email protected]"); Author martinFowler = new Author("Martin Fowler", "[email protected]"); Author kentBeck = new Author("Kent Beck", "[email protected]"); Book noSqlDistilled = new Book("NoSql Distilled", new Author[] {pramodSadalage, martinFowler}); pramodSadalage.books.add(noSqlDistilled); martinFowler.books.add(noSqlDistilled); Book refactoring = new Book("Refactoring", new Author[] {martinFowler, kentBeck}); martinFowler.books.add(refactoring); kentBeck.books.add(refactoring); // assertion succeeds List<Author> authors = Arrays.asList(pramodSadalage, kentBeck); assertThat(authors).usingRecursiveAssertion() .allFieldsSatisfy(field -> field != null);
In case one or more fields in the object graph fails the predicate test, the entire assertion will fail. Failing fields will be listed in the failure report using a JSON path-ish notation.
- Overrides:
usingRecursiveAssertion
in classAbstractAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Returns:
- A new instance of
RecursiveAssertionAssert
built with a defaultRecursiveAssertionConfiguration
.
-
usingRecursiveAssertion
public RecursiveAssertionAssert usingRecursiveAssertion(org.assertj.core.api.recursive.assertion.RecursiveAssertionConfiguration recursiveAssertionConfiguration) The same as
usingRecursiveAssertion()
, but this method allows the developer to pass in an explicit recursion configuration. This configuration gives fine-grained control over what to include in the recursion, such as:- Exclusion of fields that are null
- Exclusion of fields by path
- Exclusion of fields by type
- Exclusion of primitive fields
- Inclusion of Java Class Library types in the recursive execution
- Treatment of
Collection
and array objects - Treatment of
Map
objects - Treatment of Optional and primitive Optional objects
Please refer to the documentation of
RecursiveAssertionConfiguration.Builder
for more details.- Overrides:
usingRecursiveAssertion
in classAbstractAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
recursiveAssertionConfiguration
- The recursion configuration described above.- Returns:
- A new instance of
RecursiveAssertionAssert
built with a defaultRecursiveAssertionConfiguration
.
-
usingElementComparatorOnFields
Deprecated.This method is deprecated because it performs a shallow field by field comparison, i.e. elements are compared field by field but the fields are compared with equals, useusingRecursiveFieldByFieldElementComparatorOnFields(String...)
instead.
See https://assertj.github.io/doc/#assertj-core-recursive-comparisonDeprecated javadocUse field/property by field/property comparison on the given fields/properties only (including inherited fields/properties) instead of relying on actual type A
equals
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
- Parameters:
fields
- the fields/properties to compare using element comparators- Returns:
this
assertion object.- See Also:
-
usingRecursiveFieldByFieldElementComparatorOnFields
The assertions chained after this method will use a recursive field by field comparison on the given fields (including inherited fields) instead of relying on the elementequals
method. This is handy when the elementequals
method is not overridden or implemented as you expect.Nested fields are supported and are expressed like:
name.first
The comparison is recursive: elements are compared field by field, if a field type has fields they are also compared field by field (and so on).
Example:
Player derrickRose = new Player(new Name("Derrick", "Rose"), "Chicago Bulls"); derrickRose.nickname = new Name("Crazy", "Dunks"); Player jalenRose = new Player(new Name("Jalen", "Rose"), "Chicago Bulls"); jalenRose.nickname = new Name("Crazy", "Defense"); // assertion succeeds as all compared fields match assertThat(list(derrickRose)).usingRecursiveFieldByFieldElementComparatorOnFields("name.last", "team", "nickname.first") .contains(jalenRose); // assertion fails, name.first values differ assertThat(list(derrickRose)).usingRecursiveFieldByFieldElementComparatorOnFields("name") .contains(jalenRose);
This method is actually a shortcut of
usingRecursiveFieldByFieldElementComparator(RecursiveComparisonConfiguration)
with a configuration comparing only the given fields, the previous example can be written as:
The recursive comparison is documented here: https://assertj.github.io/doc/#assertj-core-recursive-comparisonRecursiveComparisonConfiguration configuration = RecursiveComparisonConfiguration.builder() .withComparedFields("name.last", "team", "nickname.first") .build(); assertThat(list(derrickRose)).usingRecursiveFieldByFieldElementComparator(configuration) .contains(jalenRose);
- Parameters:
fields
- the field names to exclude in the elements comparison.- Returns:
this
assertion object.- Since:
- 3.20.0
- See Also:
-
usingComparisonStrategy
protected SELF usingComparisonStrategy(org.assertj.core.internal.ComparisonStrategy comparisonStrategy) -
usingElementComparatorIgnoringFields
Deprecated.This method is deprecated because it performs a shallow field by field comparison, i.e. elements are compared field by field but the fields are compared with equals, useusingRecursiveFieldByFieldElementComparatorIgnoringFields(String...)
instead.
See https://assertj.github.io/doc/#assertj-core-recursive-comparisonDeprecated javadocUse field/property by field/property comparison on all fields/properties except the given ones (including inherited fields/properties) instead of relying on actual type A
equals
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
- Parameters:
fields
- the field names to exclude in the elements comparison.- Returns:
this
assertion object.- See Also:
-
usingRecursiveFieldByFieldElementComparatorIgnoringFields
The assertions chained after this method will use a recursive field by field comparison on all fields (including inherited fields) except the given ones instead of relying on the elementequals
method. This is handy when the elementequals
method is not overridden or implemented as you expect.Nested fields are supported and are expressed like:
name.first
The comparison is recursive: elements are compared field by field, if a field type has fields they are also compared field by field (and so on).
Example:
Player derrickRose = new Player(new Name("Derrick", "Rose"), "Chicago Bulls"); derrickRose.nickname = new Name("Crazy", "Dunks"); Player jalenRose = new Player(new Name("Jalen", "Rose"), "Chicago Bulls"); jalenRose.nickname = new Name("Crazy", "Defense"); // assertion succeeds assertThat(list(derrickRose)).usingRecursiveFieldByFieldElementComparatorIgnoringFields("name.first", "nickname.last") .contains(jalenRose); // assertion fails, names are ignored but nicknames are not and nickname.last values differ assertThat(list(derrickRose)).usingRecursiveFieldByFieldElementComparatorIgnoringFields("name") .contains(jalenRose);
This method is actually a shortcut of
usingRecursiveFieldByFieldElementComparator(RecursiveComparisonConfiguration)
with a configuration ignoring the given fields, the previous example can be written as:
The recursive comparison is documented here: https://assertj.github.io/doc/#assertj-core-recursive-comparisonRecursiveComparisonConfiguration configuration = RecursiveComparisonConfiguration.builder() .withIgnoredFields("name.first", "nickname.last") .build(); assertThat(list(derrickRose)).usingRecursiveFieldByFieldElementComparator(configuration) .contains(jalenRose);
- Parameters:
fields
- the field names to exclude in the elements comparison.- Returns:
this
assertion object.- Since:
- 3.20.0
- See Also:
-
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
Filters 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
Filters 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
Filters 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
Filters 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
.
-
filteredOn
Filters the iterable under test keeping only elements for which the result of thefunction
is equal toexpectedValue
.It allows to filter elements more safely than by using
filteredOn(String, Object)
as it doesn't utilize introspection.As an example, let's check all employees 800 years old (yes, special employees):
If you need more complex filter, useEmployee 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(Employee::getAge, 800) .containsOnly(yoda, obiwan); assertThat(employees).filteredOn(e -> e.getName(), null) .containsOnly(noname);
filteredOn(Predicate)
orfilteredOn(Condition)
.- Type Parameters:
T
- result type of the filter function- Parameters:
function
- the filter functionexpectedValue
- the expected value of the filter function- Returns:
- a new assertion object with the filtered iterable under test
- Throws:
IllegalArgumentException
- if the given function isnull
.- Since:
- 3.17.0
-
filteredOnAssertions
Filters the iterable under test keeping only elements matching the given assertions specified with aConsumer
.Example: check young hobbits whose age < 34:
TolkienCharacter pippin = new TolkienCharacter("Pippin", 28, HOBBIT); TolkienCharacter frodo = new TolkienCharacter("Frodo", 33, HOBBIT); TolkienCharacter merry = new TolkienCharacter("Merry", 36, HOBBIT); TolkienCharacter sam = new TolkienCharacter("Sam", 38, HOBBIT); List<TolkienCharacter> hobbits = list(frodo, sam, merry, pippin); assertThat(hobbits).filteredOnAssertions(hobbit -> assertThat(hobbit.age).isLessThan(34)) .containsOnly(frodo, pippin);
- Parameters:
elementAssertions
- containing AssertJ assertions to filter on- Returns:
- a new assertion object with the filtered iterable under test
- Throws:
IllegalArgumentException
- if the givenConsumer
isnull
.- Since:
- 3.11.0
-
filteredOnAssertions
Filters the iterable under test keeping only elements matching the given assertions specified with aThrowingConsumer
.This is the same assertion as
filteredOnAssertions(Consumer)
but the given consumer can throw checked exceptions.
More precisely,RuntimeException
andAssertionError
are rethrown as they are andThrowable
wrapped in aRuntimeException
.Example: check young hobbits whose age < 34:
TolkienCharacter pippin = new TolkienCharacter("Pippin", 28, HOBBIT); TolkienCharacter frodo = new TolkienCharacter("Frodo", 33, HOBBIT); TolkienCharacter merry = new TolkienCharacter("Merry", 36, HOBBIT); TolkienCharacter sam = new TolkienCharacter("Sam", 38, HOBBIT); List<TolkienCharacter> hobbits = list(frodo, sam, merry, pippin); // the code would compile even if getAge() threw a checked exception assertThat(hobbits).filteredOnAssertions(hobbit -> assertThat(hobbit.getAge()).isLessThan(34)) .containsOnly(frodo, pippin);
- Parameters:
elementAssertions
- containing AssertJ assertions to filter on- Returns:
- a new assertion object with the filtered iterable under test
- Throws:
IllegalArgumentException
- if the givenThrowingConsumer
isnull
.- Since:
- 3.21.0
-
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
- See Also:
- the element assert class, see:
-
first
public <ASSERT extends AbstractAssert<?,?>> ASSERT first(InstanceOfAssertFactory<?, ASSERT> assertFactory) Navigate and allow to perform assertions on the first element of theIterable
under test.The
assertFactory
parameter allows to specify anInstanceOfAssertFactory
, which is used to get the assertions narrowed to the factory type.Example: use of
String
assertions afterfirst(as(InstanceOfAssertFactories.STRING)
Iterable<String> hobbits = newArrayList("Frodo", "Sam", "Pippin"); // assertion succeeds assertThat(hobbits).first(as(InstanceOfAssertFactories.STRING)) .startsWith("Fro") .endsWith("do"); // assertion fails assertThat(hobbits).first(as(InstanceOfAssertFactories.STRING)) .startsWith("Pip"); // assertion fails because of wrong factory type assertThat(hobbits).first(as(InstanceOfAssertFactories.INTEGER)) .isZero();
- Type Parameters:
ASSERT
- the type of the resultingAssert
- Parameters:
assertFactory
- the factory which verifies the type and creates the newAssert
- Returns:
- a new narrowed
Assert
instance for assertions chaining on the first element - Throws:
AssertionError
- if the actualIterable
is empty.NullPointerException
- if the given factory isnull
- Since:
- 3.14.0
-
last
Navigate and allow to perform assertions on the last 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 last element
- Throws:
AssertionError
- if the actualIterable
is empty.- Since:
- 2.5.0 / 3.5.0
- See Also:
- the element assert class, see:
-
last
public <ASSERT extends AbstractAssert<?,?>> ASSERT last(InstanceOfAssertFactory<?, ASSERT> assertFactory) Navigate and allow to perform assertions on the last element of theIterable
under test.The
assertFactory
parameter allows to specify anInstanceOfAssertFactory
, which is used to get the assertions narrowed to the factory type.Example: use of
String
assertions afterlast(as(InstanceOfAssertFactories.STRING)
Iterable<String> hobbits = newArrayList("Frodo", "Sam", "Pippin"); // assertion succeeds assertThat(hobbits).last(as(InstanceOfAssertFactories.STRING)) .startsWith("Pip") .endsWith("pin"); // assertion fails assertThat(hobbits).last(as(InstanceOfAssertFactories.STRING)) .startsWith("Fro"); // assertion fails because of wrong factory type assertThat(hobbits).last(as(InstanceOfAssertFactories.INTEGER)) .isZero();
- Type Parameters:
ASSERT
- the type of the resultingAssert
- Parameters:
assertFactory
- the factory which verifies the type and creates the newAssert
- Returns:
- a new narrowed
Assert
instance for assertions chaining on the last element - Throws:
AssertionError
- if the actualIterable
is empty.NullPointerException
- if the given factory isnull
- Since:
- 3.14.0
-
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");
- Parameters:
index
- the element's index- Returns:
- the assertion on the given element
- Throws:
AssertionError
- if the given index is out of bound.- Since:
- 2.5.0 / 3.5.0
- See Also:
- the element assert class, see:
-
elements
Allow to perform assertions on the elements corresponding to the given indices (the iterableIterable
under test is changed to an iterable with the selected elements).Example:
Iterable<TolkienCharacter> hobbits = newArrayList(frodo, sam, pippin); // assertion succeeds assertThat(hobbits).elements(1, 2) .hasSize(2) .containsExactly(sam, pippin); // assertion fails assertThat(hobbits).element(1, 2) .containsExactly(frodo, pippin);
- Parameters:
indices
- the elements indices- Returns:
- the assertion on the given elements
- Throws:
IllegalArgumentException
- if indices array is null or emptyAssertionError
- if one of the given indices is out of bound or if the actual is empty- Since:
- 3.20
-
newAbstractIterableAssertForProxy
-
element
public <ASSERT extends AbstractAssert<?,?>> ASSERT element(int index, InstanceOfAssertFactory<?, ASSERT> assertFactory) Navigate and allow to perform assertions on the chosen element of theIterable
under test.The
assertFactory
parameter allows to specify anInstanceOfAssertFactory
, which is used to get the assertions narrowed to the factory type.Example: use of
String
assertions afterelement(index, as(InstanceOfAssertFactories.STRING)
Iterable<String> hobbits = newArrayList("Frodo", "Sam", "Pippin"); // assertion succeeds assertThat(hobbits).element(1, as(InstanceOfAssertFactories.STRING)) .startsWith("Sa") .endsWith("am"); // assertion fails assertThat(hobbits).element(1, as(InstanceOfAssertFactories.STRING)) .startsWith("Fro"); // assertion fails because of wrong factory type assertThat(hobbits).element(1, as(InstanceOfAssertFactories.INTEGER)) .isZero();
- Type Parameters:
ASSERT
- the type of the resultingAssert
- Parameters:
index
- the element's indexassertFactory
- the factory which verifies the type and creates the newAssert
- Returns:
- a new narrowed
Assert
instance for assertions chaining on the element at the given index - Throws:
AssertionError
- if the given index is out of bound.NullPointerException
- if the given factory isnull
- Since:
- 3.14.0
-
singleElement
Verifies that theIterable
under test contains a single element and allows to perform assertions on that element.This is a shorthand for
hasSize(1).first()
.By default available assertions after
singleElement()
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)
- the general
assertThat(Iterable)
and narrow down the single element with an assert factory, see:singleElement(element assert factory)
Example:
List<String> babySimpsons = list("Maggie"); // assertion succeeds, only Object assertions are available after singleElement() assertThat(babySimpsons).singleElement() .isEqualTo("Maggie"); // assertion fails assertThat(babySimpsons).singleElement() .isEqualTo("Homer"); // assertion fails because list contains no elements assertThat(emptyList()).singleElement(); // assertion fails because list contains more than one element List<String> simpsons = list("Homer", "Marge", "Lisa", "Bart", "Maggie"); assertThat(simpsons).singleElement();
If you have created the Iterable assertion using an
AssertFactory
or the element assert class, you will be able to chainsingleElement()
with more specific typed assertion.Example: use of
String
assertions aftersingleElement()
List<String> babySimpsons = list("Maggie"); // assertion succeeds // String assertions are available after singleElement() assertThat(babySimpsons, StringAssert.class).singleElement() .startsWith("Mag"); // InstanceOfAssertFactories.STRING is an AssertFactory for String assertions assertThat(babySimpsons, InstanceOfAssertFactories.STRING).singleElement() .startsWith("Mag"); // better readability with import static InstanceOfAssertFactories.STRING and Assertions.as assertThat(babySimpsons, as(STRING)).singleElement() .startsWith("Mag"); // assertions fail assertThat(babySimpsons, StringAssert.class).singleElement() .startsWith("Lis"); // failure as the single element is not an int/Integer assertThat(babySimpsons, IntegerAssert.class).singleElement() .startsWith("Lis");
- Returns:
- the assertion on the first element
- Throws:
AssertionError
- if the actualIterable
does not contain exactly one element.- Since:
- 3.17.0
- See Also:
- the element assert class, see:
-
singleElement
public <ASSERT extends AbstractAssert<?,?>> ASSERT singleElement(InstanceOfAssertFactory<?, ASSERT> assertFactory) Verifies that theIterable
under test contains a single element and allows to perform assertions on that element, the assertions are strongly typed according to the givenAssertFactory
parameter.This is a shorthand for
hasSize(1).first(assertFactory)
.Example: use of
String
assertions aftersingleElement(as(STRING))
import static org.assertj.core.api.InstanceOfAssertFactories.STRING; import static org.assertj.core.api.InstanceOfAssertFactories.INTEGER; import static org.assertj.core.api.Assertions.as; // syntactic sugar List<String> babySimpsons = list("Maggie"); // assertion succeeds assertThat(babySimpsons).singleElement(as(STRING)) .startsWith("Mag"); // assertion fails assertThat(babySimpsons).singleElement(as(STRING)) .startsWith("Lis"); // assertion fails because of wrong factory type assertThat(babySimpsons).singleElement(as(INTEGER)) .isZero(); // assertion fails because list contains no elements assertThat(emptyList()).singleElement(as(STRING)); // assertion fails because list contains more than one element List<String> simpsons = list("Homer", "Marge", "Lisa", "Bart", "Maggie"); assertThat(simpsons).singleElement(as(STRING));
- Type Parameters:
ASSERT
- the type of the resultingAssert
- Parameters:
assertFactory
- the factory which verifies the type and creates the newAssert
- Returns:
- a new narrowed
Assert
instance for assertions chaining on the single element - Throws:
AssertionError
- if the actualIterable
does not contain exactly one element.NullPointerException
- if the given factory isnull
.- Since:
- 3.17.0
-
toAssert
This method is used in navigating assertions likefirst()
,last()
andelement(int)
to build the assertion for the given element navigated to.Typical implementation is returning an
ObjectAssert
but it is possible to return a more specialized assertions should you know what type of elements the iterables contain.- Parameters:
value
- the element valuedescription
- describes the element, ex: "check first element" forfirst()
, used in assertion description.- Returns:
- the assertion for the given element
-
filteredOn
Filters 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 the 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"); });
If the actual iterable is empty, this assertion succeeds as there is no elements to check.
- 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.
-
allSatisfy
Verifies that all the elements satisfy the given requirements expressed as aThrowingConsumer
.This is useful to perform a group of assertions on elements.
This is the same assertion as
ObjectEnumerableAssert.allSatisfy(Consumer)
but the given consumer can throw checked exceptions.
More precisely,RuntimeException
andAssertionError
are rethrown as they are andThrowable
wrapped in aRuntimeException
.Example:
// read() throws IOException // note that the code would not compile if isNotEmpty, startsWithA or startsWithZ were declared as a Consumer<Reader> ThrowingConsumer<Reader> isNotEmpty = reader -> assertThat(reader.read()).isEqualTo(-1); ThrowingConsumer<Reader> startsWithA = reader -> assertThat(reader.read()).isEqualTo('A'); // ABC.txt contains: ABC // XYZ.txt contains: XYZ Iterable<FileReader> fileReaders = Arrays.asList(new FileReader("ABC.txt"), new FileReader("XYZ.txt")); // assertion succeeds as none of the files are empty assertThat(fileReaders).allSatisfy(isNotEmpty); // assertion fails as XYZ.txt does not start with 'A': assertThat(fileReaders).allSatisfy(startsWithA);
If the actual iterable is empty, this assertion succeeds as there is nothing to check.
- Specified by:
allSatisfy
in interfaceObjectEnumerableAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
requirements
- the givenThrowingConsumer
.- Returns:
this
object.
-
anyMatch
Verifies whether any elements match the providedPredicate
.Example :
Note that you can achieve the same result withIterable<String> abcc = newArrayList("a", "b", "cc"); // assertion will pass assertThat(abcc).anyMatch(s -> s.length() == 2); // assertion will fail assertThat(abcc).anyMatch(s -> s.length() > 2);
areAtLeastOne(Condition)
orhaveAtLeastOne(Condition)
.- Specified by:
anyMatch
in interfaceObjectEnumerableAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
predicate
- the givenPredicate
.- Returns:
this
object.
-
zipSatisfy
public <OTHER_ELEMENT> SELF zipSatisfy(Iterable<OTHER_ELEMENT> other, BiConsumer<? super ELEMENT, OTHER_ELEMENT> zipRequirements) Verifies that the zipped pairs of actual and other elements, i.e: (actual 1st element, other 1st element), (actual 2nd element, other 2nd element), ... all satisfy the givenzipRequirements
.This assertion assumes that actual and other have the same size but they can contain different type of elements making it handy to compare objects converted to another type, for example Domain and View/DTO objects.
Example:
List<Adress> addressModels = findGoodRestaurants(); List<AdressView> addressViews = convertToView(addressModels); // compare addressViews and addressModels respective paired elements. assertThat(addressViews).zipSatisfy(addressModels, (AdressView view, Adress model) -> { assertThat(view.getZipcode() + ' ' + view.getCity()).isEqualTo(model.getCityLine()); assertThat(view.getStreet()).isEqualTo(model.getStreet().toUpperCase()); });
- Type Parameters:
OTHER_ELEMENT
- the type of the other iterable elements.- Parameters:
other
- the iterable to zip actual with.zipRequirements
- the given requirements that each pair must satisfy.- Returns:
this
assertion object.- Throws:
NullPointerException
- if the given zipRequirementsBiConsumer
isnull
.NullPointerException
- if the other iterable to zip actual with isnull
.AssertionError
- if theIterable
under test isnull
.AssertionError
- if actual and other don't have the same size.AssertionError
- if one or more pairs don't satisfy the given requirements.- Since:
- 3.9.0
-
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.
-
anySatisfy
Verifies that at least one element satisfies the given requirements expressed as aThrowingConsumer
.This is useful to check that a group of assertions is verified by (at least) one element.
This is the same assertion as
ObjectEnumerableAssert.anySatisfy(Consumer)
but the given consumer can throw checked exceptions.
More precisely,RuntimeException
andAssertionError
are rethrown as they are andThrowable
wrapped in aRuntimeException
.Example:
// read() throws IOException // note that the code would not compile if startsWithA, startsWithY or startsWithZ were declared as a Consumer<Reader> ThrowingConsumer<Reader> startsWithA = reader -> assertThat(reader.read()).isEqualTo('A'); ThrowingConsumer<Reader> startsWithZ = reader -> assertThat(reader.read()).isEqualTo('Z'); // ABC.txt contains: ABC // XYZ.txt contains: XYZ Iterable<FileReader> fileReaders = Arrays.asList(new FileReader("ABC.txt"), new FileReader("XYZ.txt")); // assertion succeeds as ABC.txt starts with 'A' assertThat(fileReaders).anySatisfy(startsWithA); // assertion fails none of the files starts with 'Z': assertThat(fileReaders).anySatisfy(startsWithZ);
If the actual iterable is empty, this assertion succeeds as there is nothing to check.
- Specified by:
anySatisfy
in interfaceObjectEnumerableAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
requirements
- the givenThrowingConsumer
.- Returns:
this
object.
-
noneSatisfy
Verifies that no elements satisfy the given restrictions expressed as aConsumer
.Example:
Note that this assertion succeeds if the group (collection, array, ...) is empty whatever the restrictions are.// assume that all icelander in myIcelanderFriends are not from Brazil assertThat(myIcelanderFriends).noneSatisfy(person -> { assertThat(person.getCountry()).isEqualTo("Brazil"); });
- Specified by:
noneSatisfy
in interfaceObjectEnumerableAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
restrictions
- the given restrictions asConsumer
that no elements should met.- Returns:
this
object.
-
noneSatisfy
Verifies that no elements satisfy the given restrictions expressed as aConsumer
.This is useful to check that a group of assertions is verified by (at least) one element.
This is the same assertion as
ObjectEnumerableAssert.anySatisfy(Consumer)
but the given consumer can throw checked exceptions.
More precisely,RuntimeException
andAssertionError
are rethrown as they are andThrowable
wrapped in aRuntimeException
.Example:
// read() throws IOException // note that the code would not compile if startsWithA, startsWithY or startsWithZ were declared as a Consumer<Reader> ThrowingConsumer<Reader> startsWithA = reader -> assertThat(reader.read()).isEqualTo('A'); ThrowingConsumer<Reader> startsWithZ = reader -> assertThat(reader.read()).isEqualTo('Z'); // ABC.txt contains: ABC // XYZ.txt contains: XYZ Iterable<FileReader> fileReaders = Arrays.asList(new FileReader("ABC.txt"), new FileReader("XYZ.txt")); // assertion succeeds as none of the file starts 'Z' assertThat(fileReaders).noneSatisfy(startsWithZ); // assertion fails as ABC.txt starts with 'A': assertThat(fileReaders).noneSatisfy(startsWithA);
Note that this assertion succeeds if the group (collection, array, ...) is empty whatever the restrictions are.
- Specified by:
noneSatisfy
in interfaceObjectEnumerableAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
restrictions
- the givenThrowingConsumer
.- Returns:
this
object.
-
satisfiesExactly
Verifies that each element satisfies the requirements corresponding to its index, so the first element must satisfy the first requirements, the second element the second requirements etc...Each requirements are expressed as a
Consumer
, there must be as many requirements as there are iterable elements.Example:
Iterable<TolkienCharacter> characters = list(frodo, aragorn, legolas); // assertions succeed assertThat(characters).satisfiesExactly(character -> assertThat(character.getRace()).isEqualTo("Hobbit"), character -> assertThat(character.isMortal()).isTrue(), character -> assertThat(character.getName()).isEqualTo("Legolas")); // you can specify more than one assertion per requirement assertThat(characters).satisfiesExactly(character -> { assertThat(character.getRace()).isEqualTo("Hobbit"); assertThat(character.getName()).isEqualTo("Frodo"); }, character -> { assertThat(character.isMortal()).isTrue(); assertThat(character.getName()).isEqualTo("Aragorn"); }, character -> { assertThat(character.getRace()).isEqualTo("Elf"); assertThat(character.getName()).isEqualTo("Legolas"); }); // assertion fails as aragorn does not meet the second requirements assertThat(characters).satisfiesExactly(character -> assertThat(character.getRace()).isEqualTo("Hobbit"), character -> assertThat(character.isMortal()).isFalse(), character -> assertThat(character.getName()).isEqualTo("Legolas"));
- Specified by:
satisfiesExactly
in interfaceObjectEnumerableAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
requirements
- the requirements to meet.- Returns:
this
to chain assertions.
-
satisfiesExactly
Verifies that each element satisfies the requirements corresponding to its index, so the first element must satisfy the first requirements, the second element the second requirements etc...Each requirements are expressed as a
ThrowingConsumer
, there must be as many requirements as there are iterable elements.This is the same assertion as
ObjectEnumerableAssert.satisfiesExactly(Consumer...)
but the given consumers can throw checked exceptions.
More precisely,RuntimeException
andAssertionError
are rethrown as they are andThrowable
wrapped in aRuntimeException
.Example:
Iterable<TolkienCharacter> characters = list(frodo, aragorn, legolas); // the code would compile even if TolkienCharacter.getRace(), isMortal() or getName() threw a checked exception // assertions succeed assertThat(characters).satisfiesExactly(character -> assertThat(character.getRace()).isEqualTo("Hobbit"), character -> assertThat(character.isMortal()).isTrue(), character -> assertThat(character.getName()).isEqualTo("Legolas")); // you can specify more than one assertion per requirement assertThat(characters).satisfiesExactly(character -> { assertThat(character.getRace()).isEqualTo("Hobbit"); assertThat(character.getName()).isEqualTo("Frodo"); }, character -> { assertThat(character.isMortal()).isTrue(); assertThat(character.getName()).isEqualTo("Aragorn"); }, character -> { assertThat(character.getRace()).isEqualTo("Elf"); assertThat(character.getName()).isEqualTo("Legolas"); }); // assertion fails as aragorn does not meet the second requirements assertThat(characters).satisfiesExactly(character -> assertThat(character.getRace()).isEqualTo("Hobbit"), character -> assertThat(character.isMortal()).isFalse(), character -> assertThat(character.getName()).isEqualTo("Legolas"));
- Specified by:
satisfiesExactly
in interfaceObjectEnumerableAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
requirements
- the requirements to meet.- Returns:
this
to chain assertions.
-
satisfiesExactlyForProxy
-
satisfiesExactlyInAnyOrder
@SafeVarargs public final SELF satisfiesExactlyInAnyOrder(Consumer<? super ELEMENT>... requirements) Verifies that at least one combination of iterable elements exists that satisfies the consumers in order (there must be as many consumers as iterable elements and once a consumer is matched it cannot be reused to match other elements).This is a variation of
ObjectEnumerableAssert.satisfiesExactly(Consumer...)
where order does not matter.Examples:
List<String> starWarsCharacterNames = list("Luke", "Leia", "Yoda"); // these assertions succeed: assertThat(starWarsCharacterNames).satisfiesExactlyInAnyOrder(name -> assertThat(name).contains("Y"), // matches "Yoda" name -> assertThat(name).contains("L"), // matches "Luke" and "Leia" name -> { assertThat(name).hasSize(4); assertThat(name).doesNotContain("a"); // matches "Luke" but not "Leia" }) .satisfiesExactlyInAnyOrder(name -> assertThat(name).contains("Yo"), name -> assertThat(name).contains("Lu"), name -> assertThat(name).contains("Le")) .satisfiesExactlyInAnyOrder(name -> assertThat(name).contains("Le"), name -> assertThat(name).contains("Yo"), name -> assertThat(name).contains("Lu")); // this assertion fails as 3 consumer/requirements are expected assertThat(starWarsCharacterNames).satisfiesExactlyInAnyOrder(name -> assertThat(name).contains("Y"), name -> assertThat(name).contains("L")); // this assertion fails as no element contains "Han" (first consumer/requirements can't be met) assertThat(starWarsCharacterNames).satisfiesExactlyInAnyOrder(name -> assertThat(name).contains("Han"), name -> assertThat(name).contains("L"), name -> assertThat(name).contains("Y")); // this assertion fails as "Yoda" element can't satisfy any consumers/requirements (even though all consumers/requirements are met) assertThat(starWarsCharacterNames).satisfiesExactlyInAnyOrder(name -> assertThat(name).contains("L"), name -> assertThat(name).contains("L"), name -> assertThat(name).contains("L")); // this assertion fails as no combination of elements can satisfy the consumers in order // the problem is if the last consumer is matched by Leia then no other consumer can match Luke (and vice versa) assertThat(starWarsCharacterNames).satisfiesExactlyInAnyOrder(name -> assertThat(name).contains("Y"), name -> assertThat(name).contains("o"), name -> assertThat(name).contains("L"));
- Specified by:
satisfiesExactlyInAnyOrder
in interfaceObjectEnumerableAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
requirements
- the consumers that are expected to be satisfied by the elements of the givenIterable
.- Returns:
- this assertion object.
-
satisfiesExactlyInAnyOrder
@SafeVarargs public final SELF satisfiesExactlyInAnyOrder(ThrowingConsumer<? super ELEMENT>... requirements) Verifies that at least one combination of iterable elements exists that satisfies theThrowingConsumer
s in order (there must be as many consumers as iterable elements and once a consumer is matched it cannot be reused to match other elements).This is a variation of
ObjectEnumerableAssert.satisfiesExactly(ThrowingConsumer...)
where order does not matter.Examples:
List<String> starWarsCharacterNames = list("Luke", "Leia", "Yoda"); // these assertions succeed: assertThat(starWarsCharacterNames).satisfiesExactlyInAnyOrder(name -> assertThat(name).contains("Y"), // matches "Yoda" name -> assertThat(name).contains("L"), // matches "Luke" and "Leia" name -> { assertThat(name).hasSize(4); assertThat(name).doesNotContain("a"); // matches "Luke" but not "Leia" }) .satisfiesExactlyInAnyOrder(name -> assertThat(name).contains("Yo"), name -> assertThat(name).contains("Lu"), name -> assertThat(name).contains("Le")) .satisfiesExactlyInAnyOrder(name -> assertThat(name).contains("Le"), name -> assertThat(name).contains("Yo"), name -> assertThat(name).contains("Lu")); // this assertion fails as 3 consumers/requirements are expected assertThat(starWarsCharacterNames).satisfiesExactlyInAnyOrder(name -> assertThat(name).contains("Y"), name -> assertThat(name).contains("L")); // this assertion fails as no element contains "Han" (first consumer/requirements can't be met) assertThat(starWarsCharacterNames).satisfiesExactlyInAnyOrder(name -> assertThat(name).contains("Han"), name -> assertThat(name).contains("L"), name -> assertThat(name).contains("Y")); // this assertion fails as "Yoda" element can't satisfy any consumers/requirements (even though all consumers/requirements are met) assertThat(starWarsCharacterNames).satisfiesExactlyInAnyOrder(name -> assertThat(name).contains("L"), name -> assertThat(name).contains("L"), name -> assertThat(name).contains("L")); // this assertion fails as no combination of elements can satisfy the consumers in order // the problem is if the last consumer is matched by Leia then no other consumer can match Luke (and vice versa) assertThat(starWarsCharacterNames).satisfiesExactlyInAnyOrder(name -> assertThat(name).contains("Y"), name -> assertThat(name).contains("o"), name -> assertThat(name).contains("L"));
- Specified by:
satisfiesExactlyInAnyOrder
in interfaceObjectEnumerableAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
requirements
- the consumers that are expected to be satisfied by the elements of the givenIterable
.- Returns:
- this assertion object.
-
satisfiesExactlyInAnyOrderForProxy
-
satisfiesOnlyOnce
Verifies that there is exactly one element in the iterable under tests that satisfies theConsumer
.Examples:
List<String> starWarsCharacterNames = list("Luke", "Leia", "Yoda"); // these assertions succeed: assertThat(starWarsCharacterNames).satisfiesOnlyOnce(name -> assertThat(name).contains("Y")) // matches only "Yoda" .satisfiesOnlyOnce(name -> assertThat(name).contains("Lu")) // matches only "Luke" .satisfiesOnlyOnce(name -> assertThat(name).contains("Le")); // matches only "Leia" // this assertion fails because the requirements are satisfied two times assertThat(starWarsCharacterNames).satisfiesOnlyOnce(name -> assertThat(name).contains("a")); // matches "Leia" and "Yoda" // this assertion fails because no element contains "Han" assertThat(starWarsCharacterNames).satisfiesOnlyOnce(name -> assertThat(name).contains("Han"));
- Specified by:
satisfiesOnlyOnce
in interfaceObjectEnumerableAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
requirements
- theConsumer
that is expected to be satisfied only once by the elements of the givenIterable
.- Returns:
- this assertion object.
-
satisfiesOnlyOnce
Verifies that there is exactly one element in the iterable under tests that satisfies theThrowingConsumer
.Examples:
List<String> starWarsCharacterNames = list("Luke", "Leia", "Yoda"); // these assertions succeed: assertThat(starWarsCharacterNames).satisfiesOnlyOnce(name -> assertThat(name).contains("Y")) // matches only "Yoda" .satisfiesOnlyOnce(name -> assertThat(name).contains("Lu")) // matches only "Luke" .satisfiesOnlyOnce(name -> assertThat(name).contains("Le")); // matches only "Leia" // this assertion fails because the requirements are satisfied two times assertThat(starWarsCharacterNames).satisfiesOnlyOnce(name -> assertThat(name).contains("a")); // matches "Leia" and "Yoda" // this assertion fails because no element contains "Han" assertThat(starWarsCharacterNames).satisfiesOnlyOnce(name -> assertThat(name).contains("Han"));
- Specified by:
satisfiesOnlyOnce
in interfaceObjectEnumerableAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
requirements
- theThrowingConsumer
that is expected to be satisfied only once by the elements of the givenIterable
.- Returns:
- this assertion object.
-
satisfiesOnlyOnceForProxy
-
as
Description copied from interface:Descriptable
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 an incorrect 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]\n expected: 33\n but was: 50"); }
- Specified by:
as
in interfaceDescriptable<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>> - 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 interface:Descriptable
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>> - 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 interface:Descriptable
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>> - Parameters:
description
- the new description to set.args
- optional parameter if description is a format String.- 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 succeed assertThat(1).doesNotHaveSameClassAs("abc"); assertThat(new ArrayList<String>()).doesNotHaveSameClassAs(new LinkedList<String>()); // assertions 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 succeed assertThat(1).hasSameClassAs(2); assertThat("abc").hasSameClassAs("123"); assertThat(new ArrayList<String>()).hasSameClassAs(new ArrayList<Integer>()); // assertions 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 :
CartoonCharacter homer = new CartoonCharacter("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 succeed assertThat("abc").isEqualTo("abc"); assertThat(new HashMap<String, Integer>()).isEqualTo(new HashMap<String, Integer>()); // assertions 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 succeed assertThat("abc").isExactlyInstanceOf(String.class); assertThat(new ArrayList<String>()).isExactlyInstanceOf(ArrayList.class); assertThat(new HashMap<String, Integer>()).isExactlyInstanceOf(HashMap.class); // assertions 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 iterable.This assertion always fails if the given iterable is empty.
Example:
Iterable<Ring> elvesRings = list(vilya, nenya, narya); // assertion succeeds assertThat(nenya).isIn(elvesRings); // assertions fail: assertThat(oneRing).isIn(elvesRings); assertThat(oneRing).isIn(emptyList());
- 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.This assertion always fails if the given array of values is empty.
Example:
Ring[] elvesRings = new Ring[] { vilya, nenya, narya }; // assertion succeeds assertThat(nenya).isIn(elvesRings); // assertions fail assertThat(oneRing).isIn(elvesRings); assertThat(oneRing).isIn(new Ring[0]);
- 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 succeed assertThat("abc").isInstanceOf(String.class); assertThat(new HashMap<String, Integer>()).isInstanceOf(HashMap.class); assertThat(new HashMap<String, Integer>()).isInstanceOf(Map.class); // assertions 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 succeed 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 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 succeed assertThat("abc").isNotEqualTo("123"); assertThat(new ArrayList<String>()).isNotEqualTo(1); // assertions 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 succeed assertThat(1).isNotExactlyInstanceOf(String.class); assertThat(new ArrayList<String>()).isNotExactlyInstanceOf(List.class); assertThat(new HashMap<String, Integer>()).isNotExactlyInstanceOf(Map.class); // assertions 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 iterable.This assertion always succeeds if the given iterable is empty.
Example:
Iterable<Ring> elvesRings = list(vilya, nenya, narya); // assertions succeed: assertThat(oneRing).isNotIn(elvesRings); assertThat(oneRing).isNotIn(emptyList()); // assertions fails: 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.This assertion always succeeds if the given array of values is empty.
Example:
Ring[] elvesRings = new Ring[] { vilya, nenya, narya }; // assertions succeed assertThat(oneRing).isNotIn(elvesRings); assertThat(oneRing).isNotIn(new Ring[0]); // assertions fails: 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 succeed assertThat(1).isNotInstanceOf(Double.class); assertThat(new ArrayList<String>()).isNotInstanceOf(LinkedList.class); // assertions 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 succeed assertThat(1).isNotInstanceOfAny(Double.class, Float.class); assertThat(new ArrayList<String>()).isNotInstanceOfAny(LinkedList.class, Vector.class); // assertions 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 succeed assertThat(new HashMap<String, Integer>()).isNotOfAnyClassIn(Map.class, TreeMap.class); assertThat(new ArrayList<String>()).isNotOfAnyClassIn(LinkedList.class, List.class); // assertions 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:
// assertions succeed assertThat("abc").isNotNull(); assertThat(new HashMap<String, Integer>()).isNotNull(); // assertions fails 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, i.e., 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 succeed assertThat(new HashMap<String, Integer>()).isOfAnyClassIn(HashMap.class, TreeMap.class); assertThat(new ArrayList<String>()).isOfAnyClassIn(ArrayList.class, LinkedList.class); // assertions 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, i.e., 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.
-
noneMatch
Description copied from interface:ObjectEnumerableAssert
Verifies that no elements match the givenPredicate
.Example :
Note that you can achieve the same result withIterable<String> abcc = newArrayList("a", "b", "cc"); // assertion will pass assertThat(abcc).noneMatch(s -> s.isEmpty()); // assertion will fail assertThat(abcc).noneMatch(s -> s.length() == 2);
areNot(Condition)
ordoNotHave(Condition)
.- Specified by:
noneMatch
in interfaceObjectEnumerableAssert<SELF extends AbstractIterableAssert<SELF,
ACTUAL, ELEMENT, ELEMENT_ASSERT>, ACTUAL extends Iterable<? extends ELEMENT>> - Parameters:
predicate
- the givenPredicate
.- Returns:
this
object.
-
overridingErrorMessage
Description copied from class:AbstractAssert
Overrides AssertJ default error message by the given one.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 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 the incoming assertion checks.This method should be used to disable a custom comparison strategy set by calling
usingComparator
.- 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 the given custom comparator instead of relying on actual type A equals method for incoming assertion checks.The custom comparator is bound to assertion instance, meaning that if a new assertion instance is created, the default comparison strategy will be used.
Examples :
// frodo and sam are instances of Character with Hobbit race (obviously :). // raceComparator implements Comparator<Character> assertThat(frodo).usingComparator(raceComparator).isEqualTo(sam);
- Specified by:
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 the incoming assertion checks.- Returns:
this
assertion object.
-
usingComparator
public SELF usingComparator(Comparator<? super ACTUAL> customComparator, String customComparatorDescription) Description copied from class:AbstractAssert
Use the given custom comparator instead of relying on actual type A equals method for incoming assertion checks.The custom comparator is bound to assertion instance, meaning that if a new assertion instance is created, the default comparison strategy will be used.
Examples :
// frodo and sam are instances of Character with Hobbit race (obviously :). // raceComparator implements Comparator<Character> assertThat(frodo).usingComparator(raceComparator, "Hobbit Race Comparator").isEqualTo(sam);
- Specified by:
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 the incoming assertion checks.customComparatorDescription
- comparator description to be used in assertion error messages- Returns:
this
assertion object.
-
withFailMessage
Description copied from class:AbstractAssert
Alternative method forAbstractAssert.overridingErrorMessage(java.lang.String, java.lang.Object...)
You must set it before calling the assertion otherwise it is ignored as the failing assertion breaks the chained call by throwing an AssertionError.
Example:
assertThat(player.isRookie()).withFailMessage("Expecting Player <%s> to be a rookie but was not.", player) .isTrue();
- 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
.
-
getComparatorsByType
protected org.assertj.core.internal.TypeComparators getComparatorsByType() -
getComparatorsForElementPropertyOrFieldTypes
protected org.assertj.core.internal.TypeComparators getComparatorsForElementPropertyOrFieldTypes() -
newAbstractIterableAssert
This methods is needed to build a new concrete instance of AbstractIterableAssert after a filtering operation is executed.If you create your own subclass of AbstractIterableAssert, simply returns an instance of it in this method.
- Parameters:
iterable
- the iterable used to build the concrete instance of AbstractIterableAssert- Returns:
- concrete instance of AbstractIterableAssert
-
singleElement()
instead