public class AtomicReferenceArrayAssert<T> extends AbstractAssert<AtomicReferenceArrayAssert<T>,AtomicReferenceArray<T>> implements IndexedObjectEnumerableAssert<AtomicReferenceArrayAssert<T>,T>, ArraySortedAssert<AtomicReferenceArrayAssert<T>,T>
actual, info, myself, throwUnsupportedExceptionOnEquals
Constructor and Description |
---|
AtomicReferenceArrayAssert(AtomicReferenceArray<T> actual) |
Modifier and Type | Method and Description |
---|---|
AtomicReferenceArrayAssert<T> |
allMatch(Predicate<? super T> predicate)
Verifies that all elements match the given
Predicate . |
AtomicReferenceArrayAssert<T> |
allMatch(Predicate<? super T> predicate,
String predicateDescription)
Verifies that all the elements of actual's array match the given
Predicate . |
AtomicReferenceArrayAssert<T> |
allSatisfy(Consumer<? super T> requirements)
Verifies that all the elements satisfy given requirements expressed as a
Consumer . |
AtomicReferenceArrayAssert<T> |
anyMatch(Predicate<? super T> predicate)
Verifies whether any elements match the provided
Predicate . |
AtomicReferenceArrayAssert<T> |
anySatisfy(Consumer<? super T> requirements)
Verifies that at least one element satisfies the given requirements expressed as a
Consumer . |
AtomicReferenceArrayAssert<T> |
are(Condition<? super T> condition)
Verifies that each element value satisfies the given condition
|
AtomicReferenceArrayAssert<T> |
areAtLeast(int times,
Condition<? super T> condition)
Verifies that there are at least n elements in the actual AtomicReferenceArray satisfying the given condition.
|
AtomicReferenceArrayAssert<T> |
areAtLeastOne(Condition<? super T> condition)
Verifies that there is at least one element in the actual AtomicReferenceArray satisfying the given condition.
|
AtomicReferenceArrayAssert<T> |
areAtMost(int times,
Condition<? super T> condition)
Verifies that there are at most n elements in the actual AtomicReferenceArray satisfying the given condition.
|
AtomicReferenceArrayAssert<T> |
areExactly(int times,
Condition<? super T> condition)
Verifies that there are exactly n elements in the actual AtomicReferenceArray satisfying the given condition.
|
AtomicReferenceArrayAssert<T> |
areNot(Condition<? super T> condition)
Verifies that each element value does not satisfy the given condition
|
AtomicReferenceArrayAssert<T> |
as(Description description)
Sets the description of the assertion that is going to be called after.
|
AtomicReferenceArrayAssert<T> |
as(String description,
Object... args)
Sets the description of the assertion that is going to be called after.
|
AtomicReferenceArrayAssert<T> |
contains(T... values)
Verifies that the actual AtomicReferenceArray contains the given values, in any order.
|
AtomicReferenceArrayAssert<T> |
contains(T value,
Index index)
Verifies that the actual AtomicReferenceArray contains the given object at the given index.
|
AtomicReferenceArrayAssert<T> |
containsAll(Iterable<? extends T> iterable)
Verifies that the actual AtomicReferenceArray contains all the elements of given
Iterable , in any order. |
AtomicReferenceArrayAssert<T> |
containsAnyElementsOf(Iterable<? extends T> iterable)
Verifies that the actual AtomicReferenceArray contains at least one of the given
Iterable elements. |
AtomicReferenceArrayAssert<T> |
containsAnyOf(T... values)
Verifies that the actual AtomicReferenceArray contains at least one of the given values.
|
AtomicReferenceArrayAssert<T> |
containsExactly(T... values)
Verifies that the actual AtomicReferenceArray contains only the given values and nothing else, in order.
|
AtomicReferenceArrayAssert<T> |
containsExactlyElementsOf(Iterable<? extends T> iterable)
Same as
containsExactly(Object...) but handles the Iterable to array conversion : verifies that
actual contains all elements of the given Iterable and nothing else in the same order. |
AtomicReferenceArrayAssert<T> |
containsExactlyInAnyOrder(T... values)
Verifies that the actual AtomicReferenceArray contains exactly the given values and nothing else, in any order.
|
AtomicReferenceArrayAssert<T> |
containsExactlyInAnyOrderElementsOf(Iterable<? extends T> values)
Verifies that the actual AtomicReferenceArray contains exactly the given values and nothing else, in any order.
|
AtomicReferenceArrayAssert<T> |
containsNull()
Verifies that the actual AtomicReferenceArray contains at least a null element.
|
AtomicReferenceArrayAssert<T> |
containsOnly(T... values)
Verifies that the actual AtomicReferenceArray contains only the given values and nothing else, in any order and ignoring duplicates (i.e.
|
AtomicReferenceArrayAssert<T> |
containsOnlyElementsOf(Iterable<? extends T> iterable)
Same semantic as
containsOnly(Object[]) : verifies that actual contains all elements of the given
Iterable and nothing else, in any order and ignoring duplicates (i.e. |
AtomicReferenceArrayAssert<T> |
containsOnlyNulls()
Verifies that the actual AtomicReferenceArray contains only null elements and nothing else.
|
AtomicReferenceArrayAssert<T> |
containsOnlyOnce(T... values)
Verifies that the actual AtomicReferenceArray contains the given values only once.
|
AtomicReferenceArrayAssert<T> |
containsSequence(Iterable<? extends T> sequence)
Verifies that the actual AtomicReferenceArray contains the given sequence in the correct order and without extra values between the sequence values.
|
AtomicReferenceArrayAssert<T> |
containsSequence(T... sequence)
Verifies that the actual AtomicReferenceArray contains the given sequence in the correct order and without extra values between the sequence values.
|
AtomicReferenceArrayAssert<T> |
containsSubsequence(Iterable<? extends T> subsequence)
Verifies that the actual AtomicReferenceArray contains the given subsequence in the correct order (possibly with other values between them).
|
AtomicReferenceArrayAssert<T> |
containsSubsequence(T... subsequence)
Verifies that the actual AtomicReferenceArray contains the given subsequence in the correct order (possibly with other values between them).
|
AtomicReferenceArrayAssert<T> |
doesNotContain(T... values)
Verifies that the actual AtomicReferenceArray does not contain the given values.
|
AtomicReferenceArrayAssert<T> |
doesNotContain(T value,
Index index)
Verifies that the actual AtomicReferenceArray does not contain the given object at the given index.
|
AtomicReferenceArrayAssert<T> |
doesNotContainAnyElementsOf(Iterable<? extends T> iterable)
Verifies that the actual AtomicReferenceArray does not contain any elements of the given
Iterable (i.e. |
AtomicReferenceArrayAssert<T> |
doesNotContainNull()
Verifies that the actual AtomicReferenceArray does not contain null elements.
|
AtomicReferenceArrayAssert<T> |
doesNotContainSequence(Iterable<? extends T> sequence)
Verifies that the actual AtomicReferenceArray contains the given sequence in the given order and without extra values between the sequence values.
|
AtomicReferenceArrayAssert<T> |
doesNotContainSequence(T... sequence)
Verifies that the actual AtomicReferenceArray contains the given sequence in the given order and without extra values between the sequence values.
|
AtomicReferenceArrayAssert<T> |
doesNotContainSubsequence(Iterable<? extends T> subsequence)
Verifies that the actual AtomicReferenceArray does not contain the given subsequence in the correct order (possibly
with other values between them).
|
AtomicReferenceArrayAssert<T> |
doesNotContainSubsequence(T... subsequence)
Verifies that the actual AtomicReferenceArray does not contain the given subsequence in the correct order (possibly
with other values between them).
|
AtomicReferenceArrayAssert<T> |
doesNotHaveAnyElementsOfTypes(Class<?>... unexpectedTypes)
Verifies that all the elements in the actual AtomicReferenceArray do not belong to the specified types (including subclasses).
|
AtomicReferenceArrayAssert<T> |
doesNotHaveDuplicates()
Verifies that the actual AtomicReferenceArray does not contain duplicates.
|
AtomicReferenceArrayAssert<T> |
doNotHave(Condition<? super T> condition)
Verifies that all elements don't satisfy the given condition.
|
AtomicReferenceArrayAssert<T> |
endsWith(T[] sequence)
Verifies that the actual AtomicReferenceArray ends with the given sequence of objects, without any other objects between them.
|
AtomicReferenceArrayAssert<T> |
endsWith(T first,
T... sequence)
Verifies that the actual AtomicReferenceArray ends with the given sequence of objects, without any other objects between them.
|
<U> ObjectArrayAssert<U> |
extracting(Function<? super T,U> extractor)
Extract the values from the array's elements by applying an extracting function on them.
|
ObjectArrayAssert<Tuple> |
extracting(String... propertiesOrFields)
Extract the values of given fields/properties from the array's elements under test into a new array composed of
Tuple (a simple data structure), this new array becoming the array under test.
|
ObjectArrayAssert<Object> |
extracting(String fieldOrProperty)
Extract the values of given field or property from the array's elements under test into a new array, this new array
becoming the array under test.
|
<P> ObjectArrayAssert<P> |
extracting(String fieldOrProperty,
Class<P> extractingType)
Extract the values of given field or property from the array's elements under test into a new array, this new array
becoming the array under test with type.
|
<U,EXCEPTION extends Exception> |
extracting(ThrowingExtractor<? super T,U,EXCEPTION> extractor)
Extract the values from the array's elements by applying an extracting function (which might throw an
exception) on them.
|
ObjectArrayAssert<Object> |
extractingResultOf(String method)
Extract the result of given method invocation from the array's elements under test into a new array, this new array
becoming the array under test.
|
<P> ObjectArrayAssert<P> |
extractingResultOf(String method,
Class<P> extractingType)
Extract the result of given method invocation from the array's elements under test into a new array, this new array
becoming the array under test.
|
AtomicReferenceArrayAssert<T> |
filteredOn(Condition<? super T> condition)
Filter the array under test keeping only elements matching the given
Condition . |
AtomicReferenceArrayAssert<T> |
filteredOn(String propertyOrFieldName,
FilterOperator<?> filterOperator)
Filter the array under test keeping only elements having a property or field matching the filter expressed with
the
FilterOperator , the property/field is specified by propertyOrFieldName parameter. |
AtomicReferenceArrayAssert<T> |
filteredOn(String propertyOrFieldName,
Object expectedValue)
Filter the array under test keeping only elements having a property or field equal to
expectedValue , the
property/field is specified by propertyOrFieldName parameter. |
AtomicReferenceArrayAssert<T> |
filteredOnNull(String propertyOrFieldName)
Filter the array under test keeping only elements whose property or field specified by
propertyOrFieldName
is null. |
<U,C extends Collection<U>> |
flatExtracting(Function<? super T,C> extractor)
Extract the Iterable values from the array's elements by applying an Iterable extracting function on them
and concatenating the result lists into an array which becomes the new object under test.
|
ObjectArrayAssert<Object> |
flatExtracting(String propertyName)
Extract from array's elements the Iterable/Array values corresponding to the given property/field name and
concatenate them into a single array becoming the new object under test.
|
<U,C extends Collection<U>,EXCEPTION extends Exception> |
flatExtracting(ThrowingExtractor<? super T,C,EXCEPTION> extractor)
Extract the Iterable values from the array's elements by applying an Iterable extracting function (which might
throw an exception) on them and concatenating the result lists into an array which becomes the new object under
test.
|
protected TypeComparators |
getComparatorsByType() |
protected TypeComparators |
getComparatorsForElementPropertyOrFieldTypes() |
AtomicReferenceArrayAssert<T> |
hasArray(T[] expected)
Verifies that the AtomicReferenceArray has the given array.
|
AtomicReferenceArrayAssert<T> |
hasAtLeastOneElementOfType(Class<?> expectedType)
Verifies that at least one element in the actual AtomicReferenceArray has the specified type (matching
includes subclasses of the given type).
|
AtomicReferenceArrayAssert<T> |
hasOnlyElementsOfType(Class<?> expectedType)
Verifies that all the elements in the actual AtomicReferenceArray belong to the specified type (matching includes
subclasses of the given type).
|
AtomicReferenceArrayAssert<T> |
hasOnlyElementsOfTypes(Class<?>... types)
Verifies that all elements of the actual group are instances of given classes or interfaces.
|
AtomicReferenceArrayAssert<T> |
hasOnlyOneElementSatisfying(Consumer<? super T> elementAssertions)
Verifies that the unique element of the
AtomicReferenceArray satisfies the given assertions expressed as a Consumer ,
if it does not, only the first error is reported, use SoftAssertions to get all the errors. |
AtomicReferenceArrayAssert<T> |
hasSameElementsAs(Iterable<? extends T> iterable)
An alias of
containsOnlyElementsOf(Iterable) : verifies that actual contains all elements of the
given Iterable and nothing else, in any order. |
AtomicReferenceArrayAssert<T> |
hasSameSizeAs(Iterable<?> other)
Verifies that the actual AtomicReferenceArray has the same size as the given
Iterable . |
AtomicReferenceArrayAssert<T> |
hasSameSizeAs(Object other)
Verifies that the actual AtomicReferenceArray has the same size as the given array.
|
AtomicReferenceArrayAssert<T> |
hasSize(int expected)
Verifies that the number of values in the AtomicReferenceArray is equal to the given one.
|
AtomicReferenceArrayAssert<T> |
hasSizeBetween(int lowerBoundary,
int higherBoundary)
Verifies that the number of values in the actual array is between the given boundaries (inclusive).
|
AtomicReferenceArrayAssert<T> |
hasSizeGreaterThan(int boundary)
Verifies that the number of values in the actual array is greater than the given boundary.
|
AtomicReferenceArrayAssert<T> |
hasSizeGreaterThanOrEqualTo(int boundary)
Verifies that the number of values in the actual array is greater than or equal to the given boundary.
|
AtomicReferenceArrayAssert<T> |
hasSizeLessThan(int boundary)
Verifies that the number of values in the actual array is less than the given boundary.
|
AtomicReferenceArrayAssert<T> |
hasSizeLessThanOrEqualTo(int boundary)
Verifies that the number of values in the actual array is less than or equal to the given boundary.
|
AtomicReferenceArrayAssert<T> |
have(Condition<? super T> condition)
Verifies that all elements satisfy the given condition.
|
AtomicReferenceArrayAssert<T> |
haveAtLeast(int times,
Condition<? super T> condition)
Verifies that there are at least n elements in the actual AtomicReferenceArray satisfying the given condition.
|
AtomicReferenceArrayAssert<T> |
haveAtLeastOne(Condition<? super T> condition)
Verifies that there is at least one element in the actual AtomicReferenceArray satisfying the given condition.
|
AtomicReferenceArrayAssert<T> |
haveAtMost(int times,
Condition<? super T> condition)
Verifies that there are at most n elements in the actual AtomicReferenceArray satisfying the given condition.
|
AtomicReferenceArrayAssert<T> |
haveExactly(int times,
Condition<? super T> condition)
Verifies that there are exactly n elements in the actual AtomicReferenceArray satisfying the given condition.
|
AtomicReferenceArrayAssert<T> |
inBinary()
Use binary object representation instead of standard representation in error messages.
|
AtomicReferenceArrayAssert<T> |
inHexadecimal()
Enable hexadecimal object representation of Iterable elements instead of standard java representation in error
messages.
|
void |
isEmpty()
Verifies that the AtomicReferenceArray is empty.
|
AtomicReferenceArrayAssert<T> |
isNotEmpty()
Verifies that the AtomicReferenceArray is not empty.
|
void |
isNullOrEmpty()
Verifies that the AtomicReferenceArray is
null or empty. |
AtomicReferenceArrayAssert<T> |
isSorted()
Verifies that the actual array is sorted in ascending order according to the natural ordering of its elements.
|
AtomicReferenceArrayAssert<T> |
isSortedAccordingTo(Comparator<? super T> comparator)
Verifies that the actual array is sorted according to the given comparator.
Empty arrays are considered sorted whatever the comparator is. One element arrays are considered sorted if the element is compatible with comparator, otherwise an AssertionError is thrown. |
AtomicReferenceArrayAssert<T> |
isSubsetOf(Iterable<? extends T> values)
Verifies that all elements of actual are present in the given
Iterable . |
AtomicReferenceArrayAssert<T> |
isSubsetOf(T... values)
Verifies that all elements of actual are present in the given values.
|
AtomicReferenceArrayAssert<T> |
noneMatch(Predicate<? super T> predicate)
Verifies that no elements match the given
Predicate . |
AtomicReferenceArrayAssert<T> |
noneSatisfy(Consumer<? super T> restrictions)
Verifies that no elements satisfy the given restrictions expressed as a
Consumer . |
AtomicReferenceArrayAssert<T> |
startsWith(T... sequence)
Verifies that the actual AtomicReferenceArray starts with the given sequence of objects, without any other objects between them.
|
<C> AtomicReferenceArrayAssert<T> |
usingComparatorForElementFieldsWithNames(Comparator<C> comparator,
String... elementPropertyOrFieldNames)
Allows to set a comparator to compare properties or fields of elements with the given names.
|
<C> AtomicReferenceArrayAssert<T> |
usingComparatorForElementFieldsWithType(Comparator<C> comparator,
Class<C> type)
Allows to set a specific comparator to compare properties or fields of elements with the given type.
|
<C> AtomicReferenceArrayAssert<T> |
usingComparatorForType(Comparator<C> comparator,
Class<C> type)
Allows to set a specific comparator for the given type of elements or their fields.
|
AtomicReferenceArrayAssert<T> |
usingDefaultElementComparator()
Revert to standard comparison for incoming assertion group element checks.
|
AtomicReferenceArrayAssert<T> |
usingElementComparator(Comparator<? super T> elementComparator)
Use given custom comparator instead of relying on actual element type
equals method to compare AtomicReferenceArray
elements for incoming assertion checks. |
AtomicReferenceArrayAssert<T> |
usingElementComparatorIgnoringFields(String... fields)
Use field/property by field/property on all fields/properties except the given ones (including inherited
fields/properties) instead of relying on actual type A
equals method to compare AtomicReferenceArray elements for
incoming assertion checks. |
AtomicReferenceArrayAssert<T> |
usingElementComparatorOnFields(String... fields)
Use field/property by field/property comparison on the given fields/properties only (including inherited
fields/properties) instead of relying on actual type A
equals method to compare AtomicReferenceArray elements for
incoming assertion checks. |
AtomicReferenceArrayAssert<T> |
usingFieldByFieldElementComparator()
Use field/property by field/property comparison (including inherited fields/properties) instead of relying on
actual type A
equals method to compare AtomicReferenceArray elements for incoming assertion checks. |
AtomicReferenceArrayAssert<T> |
usingRecursiveFieldByFieldElementComparator()
Use a recursive field/property by field/property comparison (including inherited fields/properties)
instead of relying on actual type A
equals method to compare AtomicReferenceArray elements for incoming
assertion checks. |
asList, asString, describedAs, describedAs, descriptionText, doesNotHave, doesNotHaveSameClassAs, equals, failWithMessage, getWritableAssertionInfo, has, hashCode, hasSameClassAs, hasSameHashCodeAs, hasToString, is, isEqualTo, isExactlyInstanceOf, isIn, isIn, isInstanceOf, isInstanceOfAny, isInstanceOfSatisfying, isNot, isNotEqualTo, isNotExactlyInstanceOf, isNotIn, isNotIn, isNotInstanceOf, isNotInstanceOfAny, isNotNull, isNotOfAnyClassIn, isNotSameAs, isNull, isOfAnyClassIn, isSameAs, matches, matches, newListAssertInstance, overridingErrorMessage, satisfies, satisfies, satisfiesAnyOf, satisfiesAnyOf, setCustomRepresentation, throwAssertionError, usingComparator, usingComparator, usingDefaultComparator, withFailMessage, withRepresentation, withThreadDumpOnError
public AtomicReferenceArrayAssert(AtomicReferenceArray<T> actual)
public AtomicReferenceArrayAssert<T> as(Description description)
AbstractAssert
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.
as
in interface Descriptable<AtomicReferenceArrayAssert<T>>
as
in class AbstractAssert<AtomicReferenceArrayAssert<T>,AtomicReferenceArray<T>>
description
- the new description to set.this
object.Descriptable.describedAs(Description)
public AtomicReferenceArrayAssert<T> as(String description, Object... args)
AbstractAssert
You must set it before calling the assertion otherwise it is ignored as the failing assertion breaks the chained call by throwing an AssertionError.
The description follows String.format(String, Object...)
syntax.
Example :
try {
// set a bad age to Mr Frodo which is really 33 years old.
frodo.setAge(50);
// specify a test description (call as() before the assertion !), it supports String format syntax.
assertThat(frodo.getAge()).as("check %s's age", frodo.getName()).isEqualTo(33);
} catch (AssertionError e) {
assertThat(e).hasMessage("[check Frodo's age] expected:<[33]> but was:<[50]>");
}
as
in interface Descriptable<AtomicReferenceArrayAssert<T>>
as
in class AbstractAssert<AtomicReferenceArrayAssert<T>,AtomicReferenceArray<T>>
description
- the new description to set.args
- optional parameter if description is a format String.this
object.Descriptable.describedAs(String, Object...)
public void isNullOrEmpty()
null
or empty.
Example:
// assertions will pass
assertThat(new AtomicReferenceArray<>(new String[0])).isNullOrEmpty();
AtomicReferenceArray array = null;
assertThat(array).isNullOrEmpty();
// assertion will fail
assertThat(new AtomicReferenceArray<>(new String[] {"a", "b", "c"})).isNullOrEmpty();
isNullOrEmpty
in interface EnumerableAssert<AtomicReferenceArrayAssert<T>,T>
AssertionError
- if the AtomicReferenceArray is not null
or not empty.public void isEmpty()
Example:
// assertion will pass
assertThat(new AtomicReferenceArray<>(new String[0])).isEmpty();
// assertion will fail
assertThat(new AtomicReferenceArray<>(new String[]{"a", "b", "c"})).isEmpty();
isEmpty
in interface EnumerableAssert<AtomicReferenceArrayAssert<T>,T>
AssertionError
- if the AtomicReferenceArray is not empty.public AtomicReferenceArrayAssert<T> isNotEmpty()
Example:
// assertion will pass
assertThat(new AtomicReferenceArray<>(new String[]{"a", "b", "c"})).isNotEmpty();
// assertion will fail
assertThat(new AtomicReferenceArray<>(new String[0])).isNotEmpty();
isNotEmpty
in interface EnumerableAssert<AtomicReferenceArrayAssert<T>,T>
this
assertion object.AssertionError
- if the AtomicReferenceArray is empty.public AtomicReferenceArrayAssert<T> hasArray(T[] expected)
Example:
AtomicReferenceArray<String> atomicArray = new AtomicReferenceArray<>(new String[]{"a", "b", "c"});
// assertion will pass
assertThat(atomicArray).hasArray(new String[]{"a", "b", "c"});
// assertion will fail
assertThat(atomicArray).hasArray(new String[]{"a", "b", "c", "d"});
expected
- the array expected to be in the actual AtomicReferenceArray.this
assertion object.AssertionError
- if the AtomicReferenceArray does not have the given array.public AtomicReferenceArrayAssert<T> hasOnlyOneElementSatisfying(Consumer<? super T> elementAssertions)
AtomicReferenceArray
satisfies the given assertions expressed as a Consumer
,
if it does not, only the first error is reported, use SoftAssertions
to get all the errors.
Example:
AtomicReferenceArray<Jedi> jedis = new AtomicReferenceArray<>(new Jedi[]{
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 = new AtomicReferenceArray<>(new Jedi[]{
new Jedi("Yoda", "red"),
new Jedi("Luke", "green")
});
assertThat(jedis).hasOnlyOneElementSatisfying(yoda -> assertThat(yoda.getName()).startsWith("Yo"));
hasOnlyOneElementSatisfying
in interface ObjectEnumerableAssert<AtomicReferenceArrayAssert<T>,T>
elementAssertions
- the assertions to perform on the unique element.this
assertion object.AssertionError
- if the Iterable
does not have a unique element.AssertionError
- if the Iterable
's unique element does not satisfies the given assertions.public AtomicReferenceArrayAssert<T> hasSize(int expected)
Example:
AtomicReferenceArray<String> atomicArray = new AtomicReferenceArray<>(new String[]{"a", "b", "c"});
assertThat(atomicArray).hasSize(3);
// assertion will fail
assertThat(atomicArray).hasSize(1);
hasSize
in interface EnumerableAssert<AtomicReferenceArrayAssert<T>,T>
expected
- the expected number of values in the actual AtomicReferenceArray.this
assertion object.AssertionError
- if the number of values of the AtomicReferenceArray is not equal to the given one.public AtomicReferenceArrayAssert<T> hasSizeGreaterThan(int boundary)
Example:
AtomicReferenceArray atomicReferenceArray = new AtomicReferenceArray(new String[] { "a", "b", "c" });
// assertion will pass
assertThat(atomicReferenceArray).hasSizeGreaterThan(1);
// assertion will fail
assertThat(atomicReferenceArray).hasSizeGreaterThan(3);
hasSizeGreaterThan
in interface EnumerableAssert<AtomicReferenceArrayAssert<T>,T>
boundary
- the given value to compare the actual size to.this
assertion object.AssertionError
- if the number of values of the actual array is not greater than the boundary.public AtomicReferenceArrayAssert<T> hasSizeGreaterThanOrEqualTo(int boundary)
Example:
AtomicReferenceArray atomicReferenceArray = new AtomicReferenceArray(new String[] { "a", "b", "c" });
// assertion will pass
assertThat(atomicReferenceArray).hasSizeGreaterThanOrEqualTo(3);
// assertion will fail
assertThat(atomicReferenceArray).hasSizeGreaterThanOrEqualTo(5);
hasSizeGreaterThanOrEqualTo
in interface EnumerableAssert<AtomicReferenceArrayAssert<T>,T>
boundary
- the given value to compare the actual size to.this
assertion object.AssertionError
- if the number of values of the actual array is not greater than or equal to the boundary.public AtomicReferenceArrayAssert<T> hasSizeLessThan(int boundary)
Example:
AtomicReferenceArray atomicReferenceArray = new AtomicReferenceArray(new String[] { "a", "b", "c" });
// assertion will pass
assertThat(atomicReferenceArray).hasSizeLessThan(4);
// assertion will fail
assertThat(atomicReferenceArray).hasSizeLessThan(2);
hasSizeLessThan
in interface EnumerableAssert<AtomicReferenceArrayAssert<T>,T>
boundary
- the given value to compare the actual size to.this
assertion object.AssertionError
- if the number of values of the actual array is not less than the boundary.public AtomicReferenceArrayAssert<T> hasSizeLessThanOrEqualTo(int boundary)
Example:
AtomicReferenceArray atomicReferenceArray = new AtomicReferenceArray(new String[] { "a", "b", "c" });
// assertion will pass
assertThat(atomicReferenceArray).hasSizeLessThanOrEqualTo(3);
// assertion will fail
assertThat(atomicReferenceArray).hasSizeLessThanOrEqualTo(2);
hasSizeLessThanOrEqualTo
in interface EnumerableAssert<AtomicReferenceArrayAssert<T>,T>
boundary
- the given value to compare the actual size to.this
assertion object.AssertionError
- if the number of values of the actual array is not less than or equal to the boundary.public AtomicReferenceArrayAssert<T> hasSizeBetween(int lowerBoundary, int higherBoundary)
Example:
AtomicReferenceArray atomicReferenceArray = new AtomicReferenceArray(new String[] { "a", "b", "c" });
// assertion will pass
assertThat(atomicReferenceArray).hasSizeBetween(3, 4);
// assertion will fail
assertThat(atomicReferenceArray).hasSizeBetween(4, 6);
hasSizeBetween
in interface EnumerableAssert<AtomicReferenceArrayAssert<T>,T>
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.this
assertion object.AssertionError
- if the number of values of the actual array is not between the boundaries.public AtomicReferenceArrayAssert<T> hasSameSizeAs(Object other)
Parameter is declared as Object to accept both Object[]
and primitive arrays (e.g. int[]
).
Example:
AtomicReferenceArray<String> abc = new AtomicReferenceArray<>(new String[]{"a", "b", "c"});
int[] fourFiveSix = {4, 5, 6};
int[] sevenEight = {7, 8};
// assertion will pass
assertThat(abc).hasSameSizeAs(fourFiveSix);
// assertion will fail
assertThat(abc).hasSameSizeAs(sevenEight);
hasSameSizeAs
in interface EnumerableAssert<AtomicReferenceArrayAssert<T>,T>
other
- the array to compare size with actual AtomicReferenceArray.this
assertion object.AssertionError
- if the actual AtomicReferenceArray is null
.AssertionError
- if the array parameter is null
or is not a true array.AssertionError
- if actual AtomicReferenceArray and given array don't have the same size.public AtomicReferenceArrayAssert<T> hasSameSizeAs(Iterable<?> other)
Iterable
.
Example:
AtomicReferenceArray<String> abc = new AtomicReferenceArray<>(new String[]{"a", "b", "c"});
Iterable<Ring> elvesRings = newArrayList(vilya, nenya, narya);
// assertion will pass
assertThat(abc).hasSameSizeAs(elvesRings);
// assertion will fail
assertThat(abc).hasSameSizeAs(Arrays.asList("a", "b"));
hasSameSizeAs
in interface EnumerableAssert<AtomicReferenceArrayAssert<T>,T>
other
- the Iterable
to compare size with actual AtomicReferenceArray.this
assertion object.AssertionError
- if the actual AtomicReferenceArray is null
.AssertionError
- if the other Iterable
is null
.AssertionError
- if actual AtomicReferenceArray and given Iterable
don't have the same size.public AtomicReferenceArrayAssert<T> contains(T... values)
Example :
AtomicReferenceArray<String> abc = new AtomicReferenceArray<>(new String[]{"a", "b", "c"});
// assertions will pass
assertThat(abc).contains("b", "a")
.contains("b", "a", "b");
// assertions will fail
assertThat(abc).contains("d");
assertThat(abc).contains("c", "d");
contains
in interface ObjectEnumerableAssert<AtomicReferenceArrayAssert<T>,T>
values
- the given values.this
assertion object.NullPointerException
- if the given argument is null
.IllegalArgumentException
- if the given argument is an empty array.AssertionError
- if the actual AtomicReferenceArray is null
.AssertionError
- if the actual AtomicReferenceArray does not contain the given values.public AtomicReferenceArrayAssert<T> containsOnly(T... values)
Example :
AtomicReferenceArray<String> abc = new AtomicReferenceArray<>(new String[]{"a", "b", "c"});
// assertions will pass
assertThat(abc).containsOnly("c", "b", "a")
.containsOnly("a", "a", "b", "c", "c");
// assertion will fail because "c" is missing from the given values
assertThat(abc).containsOnly("a", "b");
// assertion will fail because abc does not contain "d"
assertThat(abc).containsOnly("a", "b", "c", "d");
containsOnly
in interface ObjectEnumerableAssert<AtomicReferenceArrayAssert<T>,T>
values
- the given values.this
assertion object.NullPointerException
- if the given argument is null
.IllegalArgumentException
- if the given argument is an empty array.AssertionError
- if the actual AtomicReferenceArray is null
.AssertionError
- if the actual AtomicReferenceArray does not contain the given values, i.e. the actual AtomicReferenceArray contains some
or none of the given values, or the actual AtomicReferenceArray contains more values than the given ones.public AtomicReferenceArrayAssert<T> containsOnlyElementsOf(Iterable<? extends T> iterable)
containsOnly(Object[])
: verifies that actual contains all 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 :
AtomicReferenceArray<Ring> rings = new AtomicReferenceArray<>(new Ring[]{nenya, vilya});
// assertions will pass
assertThat(rings).containsOnlyElementsOf(newArrayList(nenya, vilya))
.containsOnlyElementsOf(newArrayList(nenya, nenya, vilya, vilya));
// assertion will fail as actual does not contain narya
assertThat(rings).containsOnlyElementsOf(newArrayList(nenya, vilya, narya));
// assertion will fail as actual contains nenya
assertThat(rings).containsOnlyElementsOf(newArrayList(vilya));
containsOnlyElementsOf
in interface ObjectEnumerableAssert<AtomicReferenceArrayAssert<T>,T>
iterable
- the given Iterable
we will get elements from.this
assertion object.public AtomicReferenceArrayAssert<T> containsOnlyNulls()
Example :
// assertion will pass
AtomicReferenceArray<String> items = new AtomicReferenceArray<>(new String[]{null, null, null});
assertThat(items).containsOnlyNulls();
// assertion will fail because items2 contains not null element
AtomicReferenceArray<String> items2 = new AtomicReferenceArray<>(new String[]{null, null, "notNull"});
assertThat(items2).containsOnlyNulls();
// assertion will fail since an empty array does not contain any elements and therefore no null ones.
AtomicReferenceArray<String> empty = new AtomicReferenceArray<>(new String[0]);
assertThat(empty).containsOnlyNulls();
containsOnlyNulls
in interface ObjectEnumerableAssert<AtomicReferenceArrayAssert<T>,T>
this
assertion object.AssertionError
- if the actual AtomicReferenceArray is null
.AssertionError
- if the actual AtomicReferenceArray is empty or contains non null elements.public AtomicReferenceArrayAssert<T> hasSameElementsAs(Iterable<? extends T> iterable)
containsOnlyElementsOf(Iterable)
: verifies that actual contains all elements of the
given Iterable
and nothing else, in any order.
Example:
AtomicReferenceArray<Ring> elvesRings = new AtomicReferenceArray<>(new Ring[]{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));
hasSameElementsAs
in interface ObjectEnumerableAssert<AtomicReferenceArrayAssert<T>,T>
iterable
- the Iterable
whose elements we expect to be presentAssertionError
- if the actual AtomicReferenceArray is null
NullPointerException
- if the given Iterable
is null
AssertionError
- if the actual Iterable
does not have the same elements, in any order, as the given
Iterable
public AtomicReferenceArrayAssert<T> containsOnlyOnce(T... values)
Examples :
// array is a factory method to create arrays.
AtomicReferenceArray<String> got = new AtomicReferenceArray<>(new String[]{"winter", "is", "coming"});
// assertions will pass
assertThat(got).containsOnlyOnce("winter")
.containsOnlyOnce("coming", "winter");
// assertions will fail
AtomicReferenceArray<String> stark= new AtomicReferenceArray<>(new String[]{"Arya", "Stark", "daughter", "of", "Ned", "Stark")});
assertThat(got).containsOnlyOnce("Lannister");
assertThat(stark).containsOnlyOnce("Stark");
containsOnlyOnce
in interface ObjectEnumerableAssert<AtomicReferenceArrayAssert<T>,T>
values
- the given values.this
assertion object.NullPointerException
- if the given argument is null
.IllegalArgumentException
- if the given argument is an empty array.AssertionError
- if the actual AtomicReferenceArray is null
.AssertionError
- if the actual AtomicReferenceArray does not contain the given values, i.e. the actual AtomicReferenceArray contains some
or none of the given values, or the actual AtomicReferenceArray contains more than once these values.public AtomicReferenceArrayAssert<T> containsExactly(T... values)
Example :
AtomicReferenceArray<Ring> elvesRings = new AtomicReferenceArray<>(new Ring[]{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);
containsExactly
in interface ObjectEnumerableAssert<AtomicReferenceArrayAssert<T>,T>
values
- the given values.this
assertion object.NullPointerException
- if the given argument is null
.AssertionError
- if the actual AtomicReferenceArray is null
.AssertionError
- if the actual AtomicReferenceArray does not contain the given values with same order, i.e. the actual AtomicReferenceArray
contains some or none of the given values, or the actual AtomicReferenceArray contains more values than the given ones
or values are the same but the order is not.public AtomicReferenceArrayAssert<T> containsExactlyInAnyOrder(T... values)
Example :
AtomicReferenceArray<Ring> elvesRings = new AtomicReferenceArray<>(new Ring[]{vilya, nenya, narya});
// 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);
containsExactlyInAnyOrder
in interface ObjectEnumerableAssert<AtomicReferenceArrayAssert<T>,T>
values
- the given values.this
assertion object.NullPointerException
- if the given argument is null
.AssertionError
- if the actual group is null
.AssertionError
- if the actual AtomicReferenceArray does not contain the given values, i.e. it
contains some or none of the given values, or more values than the given ones.public AtomicReferenceArrayAssert<T> containsExactlyInAnyOrderElementsOf(Iterable<? extends T> values)
Example :
AtomicReferenceArray<Ring> elvesRings = new AtomicReferenceArray(new Ring[]{vilya, nenya, narya, vilya});
AtomicReferenceArray<Ring> elvesRingsSomeMissing = new AtomicReferenceArray(new Ring[]{vilya, nenya, narya});
AtomicReferenceArray<Ring> elvesRingsDifferentOrder = new AtomicReferenceArray(new Ring[]{nenya, narya, vilya, vilya});
// assertion will pass
assertThat(elvesRings).containsExactlyInAnyOrder(elvesRingsDifferentOrder);
// assertion will fail as vilya is contained twice in elvesRings.
assertThat(elvesRings).containsExactlyInAnyOrder(elvesRingsSomeMissing);
containsExactlyInAnyOrderElementsOf
in interface ObjectEnumerableAssert<AtomicReferenceArrayAssert<T>,T>
values
- the given values.this
assertion object.NullPointerException
- if the given argument is null
.AssertionError
- if the actual group is null
.AssertionError
- if the actual group does not contain the given values, i.e. the actual group
contains some or none of the given values, or the actual group contains more values than the given ones.public AtomicReferenceArrayAssert<T> containsExactlyElementsOf(Iterable<? extends T> iterable)
containsExactly(Object...)
but handles the Iterable
to array conversion : verifies that
actual contains all elements of the given Iterable
and nothing else in the same order.
Example :
AtomicReferenceArray<Ring> elvesRings = new AtomicReferenceArray<>(new Ring[]{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));
containsExactlyElementsOf
in interface ObjectEnumerableAssert<AtomicReferenceArrayAssert<T>,T>
iterable
- the given Iterable
we will get elements from.this
assertion object.public AtomicReferenceArrayAssert<T> containsSequence(T... sequence)
Use containsSubsequence(Object...)
to allow values between the expected sequence values.
Example:
AtomicReferenceArray<Ring> elvesRings = new AtomicReferenceArray<>(new Ring[]{vilya, nenya, narya});
// assertion 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);
containsSequence
in interface ObjectEnumerableAssert<AtomicReferenceArrayAssert<T>,T>
sequence
- the sequence of objects to look for.AssertionError
- if the actual AtomicReferenceArray is null
.AssertionError
- if the given array is null
.AssertionError
- if the actual AtomicReferenceArray does not contain the given sequence.public AtomicReferenceArrayAssert<T> containsSequence(Iterable<? extends T> sequence)
Use containsSubsequence(Object...)
to allow values between the expected sequence values.
Example:
AtomicReferenceArray<Ring> elvesRings = new AtomicReferenceArray<>(new Ring[]{vilya, nenya, narya});
// assertion 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));
containsSequence
in interface ObjectEnumerableAssert<AtomicReferenceArrayAssert<T>,T>
sequence
- the sequence of objects to look for.AssertionError
- if the actual AtomicReferenceArray is null
.AssertionError
- if the given array is null
.AssertionError
- if the actual AtomicReferenceArray does not contain the given sequence.public AtomicReferenceArrayAssert<T> doesNotContainSequence(T... sequence)
Use doesNotContainSubsequence(Object...)
to also ensure the sequence does not exist with values between the expected sequence values.
Example:
AtomicReferenceArray<Ring> elvesRings = new AtomicReferenceArray<>(new Ring[]{vilya, nenya, narya});
// assertion will pass, the elements order is correct but there is a value between them (nenya)
assertThat(elvesRings).containsSequence(vilya, narya);
assertThat(elvesRings).containsSequence(nenya, vilya);
// assertions will fail
assertThat(elvesRings).containsSequence(vilya, nenya);
assertThat(elvesRings).containsSequence(nenya, narya);
doesNotContainSequence
in interface ObjectEnumerableAssert<AtomicReferenceArrayAssert<T>,T>
sequence
- the sequence of objects to look for.AssertionError
- if the actual AtomicReferenceArray is null
.AssertionError
- if the given array is null
.AssertionError
- if the actual AtomicReferenceArray does not contain the given sequence.public AtomicReferenceArrayAssert<T> doesNotContainSequence(Iterable<? extends T> sequence)
Use doesNotContainSubsequence(Iterable)
to also ensure the sequence does not exist with values between the expected sequence values.
Example:
AtomicReferenceArray<Ring> elvesRings = new AtomicReferenceArray<>(new Ring[]{vilya, nenya, narya});
// assertion will pass, 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));
// assertions will fail
assertThat(elvesRings).containsSequence(newArrayList(vilya, nenya));
assertThat(elvesRings).containsSequence(newArrayList(nenya, narya));
doesNotContainSequence
in interface ObjectEnumerableAssert<AtomicReferenceArrayAssert<T>,T>
sequence
- the sequence of objects to look for.AssertionError
- if the actual AtomicReferenceArray is null
.AssertionError
- if the given array is null
.AssertionError
- if the actual AtomicReferenceArray does not contain the given sequence.public AtomicReferenceArrayAssert<T> containsSubsequence(T... subsequence)
Example:
AtomicReferenceArray<Ring> elvesRings = new AtomicReferenceArray<>(new Ring[]{vilya, nenya, narya});
// assertions will pass
assertThat(elvesRings).containsSubsequence(vilya, nenya)
.containsSubsequence(vilya, narya);
// assertion will fail
assertThat(elvesRings).containsSubsequence(nenya, vilya);
containsSubsequence
in interface ObjectEnumerableAssert<AtomicReferenceArrayAssert<T>,T>
subsequence
- the subsequence of objects to look for.AssertionError
- if the actual AtomicReferenceArray is null
.AssertionError
- if the given array is null
.AssertionError
- if the actual AtomicReferenceArray does not contain the given subsequence.public AtomicReferenceArrayAssert<T> containsSubsequence(Iterable<? extends T> subsequence)
Example:
AtomicReferenceArray<Ring> elvesRings = new AtomicReferenceArray<>(new Ring[]{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));
containsSubsequence
in interface ObjectEnumerableAssert<AtomicReferenceArrayAssert<T>,T>
subsequence
- the subsequence of objects to look for.AssertionError
- if the actual AtomicReferenceArray is null
.AssertionError
- if the given array is null
.AssertionError
- if the actual AtomicReferenceArray does not contain the given subsequence.public AtomicReferenceArrayAssert<T> doesNotContainSubsequence(T... subsequence)
Example:
AtomicReferenceArray<Ring> elvesRings = new AtomicReferenceArray<>(new Ring[]{vilya, nenya, narya});
// assertions will pass
assertThat(elvesRings).doesNotContainSubsequence(nenya, vilya);
// assertion will fail
assertThat(elvesRings).doesNotContainSubsequence(vilya, nenya);
assertThat(elvesRings).doesNotContainSubsequence(vilya, narya);
doesNotContainSubsequence
in interface ObjectEnumerableAssert<AtomicReferenceArrayAssert<T>,T>
subsequence
- the subsequence of objects to look for.AssertionError
- if the actual AtomicReferenceArray is null
.AssertionError
- if the given array is null
.AssertionError
- if the actual AtomicReferenceArray contains the given subsequence.public AtomicReferenceArrayAssert<T> doesNotContainSubsequence(Iterable<? extends T> subsequence)
Example:
AtomicReferenceArray<Ring> elvesRings = new AtomicReferenceArray<>(new Ring[]{vilya, nenya, narya});
// assertions will pass
assertThat(elvesRings).doesNotContainSubsequence(newArrayList(nenya, vilya));
// assertion will fail
assertThat(elvesRings).doesNotContainSubsequence(newArrayList(vilya, nenya));
assertThat(elvesRings).doesNotContainSubsequence(newArrayList(vilya, narya));
doesNotContainSubsequence
in interface ObjectEnumerableAssert<AtomicReferenceArrayAssert<T>,T>
subsequence
- the subsequence of objects to look for.AssertionError
- if the actual AtomicReferenceArray is null
.AssertionError
- if the given array is null
.AssertionError
- if the actual AtomicReferenceArray contains the given subsequence.public AtomicReferenceArrayAssert<T> contains(T value, Index index)
Example:
AtomicReferenceArray<Ring> elvesRings = new AtomicReferenceArray<>(new Ring[]{vilya, nenya, narya});
// assertions will pass
assertThat(elvesRings).contains(vilya, atIndex(0))
.contains(nenya, atIndex(1))
.contains(narya, atIndex(2));
// assertions will fail
assertThat(elvesRings).contains(vilya, atIndex(1));
assertThat(elvesRings).contains(nenya, atIndex(2));
assertThat(elvesRings).contains(narya, atIndex(0));
contains
in interface IndexedObjectEnumerableAssert<AtomicReferenceArrayAssert<T>,T>
value
- the object to look for.index
- the index where the object should be stored in the actual AtomicReferenceArray.AssertionError
- if the actual AtomicReferenceArray is null
or empty.NullPointerException
- if the given Index
is null
.IndexOutOfBoundsException
- if the value of the given Index
is equal to or greater than the size of the actual
AtomicReferenceArray.AssertionError
- if the actual AtomicReferenceArray does not contain the given object at the given index.public AtomicReferenceArrayAssert<T> hasOnlyElementsOfTypes(Class<?>... types)
Example :
AtomicReferenceArray<Object> elvesRings = new AtomicReferenceArray<>(new Object[]{"", new StringBuilder()});
// assertions will pass
assertThat(objects).hasOnlyElementsOfTypes(CharSequence.class);
assertThat(objects).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);
hasOnlyElementsOfTypes
in interface ObjectEnumerableAssert<AtomicReferenceArrayAssert<T>,T>
types
- the expected classes and interfacesthis
assertion object.NullPointerException
- if the given argument is null
.AssertionError
- if the actual group is null
.AssertionError
- if not all elements of the actual group are instances of one of the given typespublic AtomicReferenceArrayAssert<T> doesNotContain(T value, Index index)
Example:
AtomicReferenceArray<Ring> elvesRings = new AtomicReferenceArray<>(new Ring[]{vilya, nenya, narya});
// assertions will pass
assertThat(elvesRings).doesNotContain(vilya, atIndex(1))
.doesNotContain(nenya, atIndex(2))
.doesNotContain(narya, atIndex(0));
// assertions will fail
assertThat(elvesRings).doesNotContain(vilya, atIndex(0));
assertThat(elvesRings).doesNotContain(nenya, atIndex(1));
assertThat(elvesRings).doesNotContain(narya, atIndex(2));
doesNotContain
in interface IndexedObjectEnumerableAssert<AtomicReferenceArrayAssert<T>,T>
value
- the object to look for.index
- the index where the object should not be stored in the actual AtomicReferenceArray.AssertionError
- if the actual AtomicReferenceArray is null
.NullPointerException
- if the given Index
is null
.AssertionError
- if the actual AtomicReferenceArray contains the given object at the given index.public AtomicReferenceArrayAssert<T> doesNotContain(T... values)
Example :
AtomicReferenceArray<String> abc = new AtomicReferenceArray<>(new String[]{"a", "b", "c"});
// assertion will pass
assertThat(abc).doesNotContain("d", "e");
// assertions will fail
assertThat(abc).doesNotContain("a");
assertThat(abc).doesNotContain("a", "b", "c");
assertThat(abc).doesNotContain("a", "x");
doesNotContain
in interface ObjectEnumerableAssert<AtomicReferenceArrayAssert<T>,T>
values
- the given values.this
assertion object.NullPointerException
- if the given argument is null
.IllegalArgumentException
- if the given argument is an empty array.AssertionError
- if the actual AtomicReferenceArray is null
.AssertionError
- if the actual AtomicReferenceArray contains any of the given values.public AtomicReferenceArrayAssert<T> doesNotContainAnyElementsOf(Iterable<? extends T> iterable)
Iterable
(i.e. none).
Example:
AtomicReferenceArray<String> abc = new AtomicReferenceArray<>(new String[]{"a", "b", "c"});
// assertion will pass
assertThat(actual).doesNotContainAnyElementsOf(newArrayList("d", "e"));
// assertions will fail
assertThat(actual).doesNotContainAnyElementsOf(newArrayList("a", "b"));
assertThat(actual).doesNotContainAnyElementsOf(newArrayList("d", "e", "a"));
doesNotContainAnyElementsOf
in interface ObjectEnumerableAssert<AtomicReferenceArrayAssert<T>,T>
iterable
- the Iterable
whose elements must not be in the actual AtomicReferenceArray.this
assertion object.NullPointerException
- if the given argument is null
.IllegalArgumentException
- if the given argument is an empty iterable.AssertionError
- if the actual AtomicReferenceArray is null
.AssertionError
- if the actual AtomicReferenceArray contains some elements of the given Iterable
.public AtomicReferenceArrayAssert<T> doesNotHaveDuplicates()
Example :
AtomicReferenceArray<String> abc = new AtomicReferenceArray<>(new String[]{"a", "b", "c"});
AtomicReferenceArray<String> aaa = new AtomicReferenceArray<>(new String[]{"a", "a", "a"});
// assertion will pass
assertThat(abc).doesNotHaveDuplicates();
// assertion will fail
assertThat(aaa).doesNotHaveDuplicates();
doesNotHaveDuplicates
in interface ObjectEnumerableAssert<AtomicReferenceArrayAssert<T>,T>
this
assertion object.AssertionError
- if the actual AtomicReferenceArray is null
.AssertionError
- if the actual AtomicReferenceArray contains duplicates.public AtomicReferenceArrayAssert<T> startsWith(T... sequence)
containsSequence(Object...)
, but it also verifies that the first element in the
sequence is also the first element of the actual AtomicReferenceArray.
Example :
AtomicReferenceArray<String> abc = new AtomicReferenceArray<>(new String[]{"a", "b", "c"});
// assertion will pass
assertThat(abc).startsWith("a", "b");
// assertion will fail
assertThat(abc).startsWith("c");
startsWith
in interface ObjectEnumerableAssert<AtomicReferenceArrayAssert<T>,T>
sequence
- the sequence of objects to look for.NullPointerException
- if the given argument is null
.IllegalArgumentException
- if the given argument is an empty array.AssertionError
- if the actual AtomicReferenceArray is null
.AssertionError
- if the actual AtomicReferenceArray does not start with the given sequence of objects.public AtomicReferenceArrayAssert<T> endsWith(T first, T... sequence)
containsSequence(Object...)
, but it also verifies that the last element in the
sequence is also last element of the actual AtomicReferenceArray.
Example :
AtomicReferenceArray<String> abc = new AtomicReferenceArray<>(new String[]{"a", "b", "c"});
// assertion will pass
assertThat(abc).endsWith("b", "c");
// assertion will fail
assertThat(abc).endsWith("a");
endsWith
in interface ObjectEnumerableAssert<AtomicReferenceArrayAssert<T>,T>
first
- the first element of the end sequence of objects to look for.sequence
- the rest of the end sequence of objects to look for.NullPointerException
- if the given argument is null
.AssertionError
- if the actual AtomicReferenceArray is null
.AssertionError
- if the actual AtomicReferenceArray does not end with the given sequence of objects.public AtomicReferenceArrayAssert<T> endsWith(T[] sequence)
containsSequence(Object...)
, but it also verifies that the last element in the
sequence is also last element of the actual AtomicReferenceArray.
Example :
AtomicReferenceArray<String> abc = new AtomicReferenceArray<>(new String[]{"a", "b", "c"});
// assertions will pass
assertThat(abc).endsWith(new String[0])
.endsWith(new String[] {"b", "c"});
// assertion will fail
assertThat(abc).endsWith(new String[] {"a"});
endsWith
in interface ObjectEnumerableAssert<AtomicReferenceArrayAssert<T>,T>
sequence
- the (possibly empty) sequence of objects to look for.NullPointerException
- if the given argument is null
.AssertionError
- if the actual AtomicReferenceArray is null
.AssertionError
- if the actual AtomicReferenceArray does not end with the given sequence of objects.public AtomicReferenceArrayAssert<T> isSubsetOf(Iterable<? extends T> values)
Iterable
.
Example:
AtomicReferenceArray<Ring> elvesRings = new AtomicReferenceArray<>(new Ring[]{vilya, nenya, narya});
List<Ring> ringsOfPower = newArrayList(oneRing, vilya, nenya, narya, dwarfRing, manRing);
// assertion will pass:
assertThat(elvesRings).isSubsetOf(ringsOfPower);
// assertion will fail:
assertThat(elvesRings).isSubsetOf(newArrayList(nenya, narya));
isSubsetOf
in interface ObjectEnumerableAssert<AtomicReferenceArrayAssert<T>,T>
values
- the Iterable
that should contain all actual elements.AssertionError
- if the actual Iterable
is null
.NullPointerException
- if the given Iterable
is null
.AssertionError
- if the actual Iterable
is not subset of set Iterable
.public AtomicReferenceArrayAssert<T> isSubsetOf(T... values)
Example:
AtomicReferenceArray<Ring> elvesRings = new AtomicReferenceArray<>(new Ring[]{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);
isSubsetOf
in interface ObjectEnumerableAssert<AtomicReferenceArrayAssert<T>,T>
values
- the values that should be used for checking the elements of actual.AssertionError
- if the actual Iterable
is null
.AssertionError
- if the actual Iterable
is not subset of the given values.public AtomicReferenceArrayAssert<T> containsNull()
Example :
AtomicReferenceArray<String> abc = new AtomicReferenceArray<>(new String[]{"a", "b", "c"});
AtomicReferenceArray<String> abNull = new AtomicReferenceArray<>(new String[]{"a", "b", null});
// assertion will pass
assertThat(abNull).containsNull();
// assertion will fail
assertThat(abc).containsNull();
containsNull
in interface ObjectEnumerableAssert<AtomicReferenceArrayAssert<T>,T>
this
assertion object.AssertionError
- if the actual AtomicReferenceArray is null
.AssertionError
- if the actual AtomicReferenceArray does not contain a null element.public AtomicReferenceArrayAssert<T> doesNotContainNull()
Example :
AtomicReferenceArray<String> abc = new AtomicReferenceArray<>(new String[]{"a", "b", "c"});
AtomicReferenceArray<String> abNull = new AtomicReferenceArray<>(new String[]{"a", "b", null});
// assertion will pass
assertThat(abc).doesNotContainNull();
// assertion will fail
assertThat(abNull).doesNotContainNull();
doesNotContainNull
in interface ObjectEnumerableAssert<AtomicReferenceArrayAssert<T>,T>
this
assertion object.AssertionError
- if the actual AtomicReferenceArray is null
.AssertionError
- if the actual AtomicReferenceArray contains a null element.public AtomicReferenceArrayAssert<T> are(Condition<? super T> condition)
Example :
AtomicReferenceArray<String> abc = new AtomicReferenceArray<>(new String[]{"a", "b", "c"});
AtomicReferenceArray<String> abcc = new AtomicReferenceArray<>(new String[]{"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);
are
in interface ObjectEnumerableAssert<AtomicReferenceArrayAssert<T>,T>
condition
- the given condition.this
object.NullPointerException
- if the given condition is null
.AssertionError
- if an element cannot be cast to T.AssertionError
- if one or more elements don't satisfy the given condition.public AtomicReferenceArrayAssert<T> areNot(Condition<? super T> condition)
Example :
AtomicReferenceArray<String> abc = new AtomicReferenceArray<>(new String[]{"a", "b", "c"});
AtomicReferenceArray<String> abcc = new AtomicReferenceArray<>(new String[]{"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);
areNot
in interface ObjectEnumerableAssert<AtomicReferenceArrayAssert<T>,T>
condition
- the given condition.this
object.NullPointerException
- if the given condition is null
.AssertionError
- if an element cannot be cast to T.AssertionError
- if one or more elements satisfy the given condition.public AtomicReferenceArrayAssert<T> have(Condition<? super T> condition)
Example :
AtomicReferenceArray<String> abc = new AtomicReferenceArray<>(new String[]{"a", "b", "c"});
AtomicReferenceArray<String> abcc = new AtomicReferenceArray<>(new String[]{"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);
have
in interface ObjectEnumerableAssert<AtomicReferenceArrayAssert<T>,T>
condition
- the given condition.this
object.NullPointerException
- if the given condition is null
.AssertionError
- if an element cannot be cast to T.AssertionError
- if one or more elements do not satisfy the given condition.public AtomicReferenceArrayAssert<T> doNotHave(Condition<? super T> condition)
Example :
AtomicReferenceArray<String> abc = new AtomicReferenceArray<>(new String[]{"a", "b", "c"});
AtomicReferenceArray<String> abcc = new AtomicReferenceArray<>(new String[]{"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);
doNotHave
in interface ObjectEnumerableAssert<AtomicReferenceArrayAssert<T>,T>
condition
- the given condition.this
object.NullPointerException
- if the given condition is null
.AssertionError
- if an element cannot be cast to T.AssertionError
- if one or more elements satisfy the given condition.public AtomicReferenceArrayAssert<T> areAtLeast(int times, Condition<? super T> condition)
Example :
AtomicReferenceArray<Integer> oneThwoThree = new AtomicReferenceArray<>(new Integer[]{1, 2, 3});
Condition<Integer> oddNumber = new Condition<>(value % 2 == 1, "odd number");
// assertion will pass
oneThwoThree.areAtLeast(2, oddNumber);
// assertion will fail
oneThwoThree.areAtLeast(3, oddNumber);
areAtLeast
in interface ObjectEnumerableAssert<AtomicReferenceArrayAssert<T>,T>
times
- the minimum number of times the condition should be verified.condition
- the given condition.this
object.NullPointerException
- if the given condition is null
.AssertionError
- if an element can not be cast to T.AssertionError
- if the number of elements satisfying the given condition is < n.public AtomicReferenceArrayAssert<T> areAtLeastOne(Condition<? super T> condition)
This method is an alias for areAtLeast(1, condition)
.
Example:
// jedi is a Condition<String>
AtomicReferenceArray<String> rebels = new AtomicReferenceArray<>(new String[]{"Luke", "Solo", "Leia"});
assertThat(rebels).areAtLeastOne(jedi);
areAtLeastOne
in interface ObjectEnumerableAssert<AtomicReferenceArrayAssert<T>,T>
condition
- the given condition.this
assertion object.haveAtLeast(int, Condition)
public AtomicReferenceArrayAssert<T> areAtMost(int times, Condition<? super T> condition)
Example :
AtomicReferenceArray<Integer> oneThwoThree = new AtomicReferenceArray<>(new Integer[]{1, 2, 3});
Condition<Integer> oddNumber = new Condition<>(value % 2 == 1, "odd number");
// assertions will pass
oneThwoThree.areAtMost(2, oddNumber);
oneThwoThree.areAtMost(3, oddNumber);
// assertion will fail
oneThwoThree.areAtMost(1, oddNumber);
areAtMost
in interface ObjectEnumerableAssert<AtomicReferenceArrayAssert<T>,T>
times
- the number of times the condition should be at most verified.condition
- the given condition.this
object.NullPointerException
- if the given condition is null
.AssertionError
- if an element cannot be cast to T.AssertionError
- if the number of elements satisfying the given condition is > n.public AtomicReferenceArrayAssert<T> areExactly(int times, Condition<? super T> condition)
Example :
AtomicReferenceArray<Integer> oneThwoThree = new AtomicReferenceArray<>(new Integer[]{1, 2, 3});
Condition<Integer> oddNumber = new Condition<>(value % 2 == 1, "odd number");
// assertion will pass
oneThwoThree.areExactly(2, oddNumber);
// assertions will fail
oneThwoThree.areExactly(1, oddNumber);
oneThwoThree.areExactly(3, oddNumber);
areExactly
in interface ObjectEnumerableAssert<AtomicReferenceArrayAssert<T>,T>
times
- the exact number of times the condition should be verified.condition
- the given condition.this
object.NullPointerException
- if the given condition is null
.AssertionError
- if an element cannot be cast to T.AssertionError
- if the number of elements satisfying the given condition is ≠ n.public AtomicReferenceArrayAssert<T> haveAtLeastOne(Condition<? super T> condition)
This method is an alias for haveAtLeast(1, condition)
.
Example:
AtomicReferenceArray<BasketBallPlayer> bullsPlayers = new AtomicReferenceArray<>(new BasketBallPlayer[]{butler, rose});
// potentialMvp is a Condition<BasketBallPlayer>
assertThat(bullsPlayers).haveAtLeastOne(potentialMvp);
haveAtLeastOne
in interface ObjectEnumerableAssert<AtomicReferenceArrayAssert<T>,T>
condition
- the given condition.this
assertion object.haveAtLeast(int, Condition)
public AtomicReferenceArrayAssert<T> haveAtLeast(int times, Condition<? super T> condition)
Example :
AtomicReferenceArray<Integer> oneThwoThree = new AtomicReferenceArray<>(new Integer[]{1, 2, 3});
Condition<Integer> oddNumber = new Condition<>(value % 2 == 1, "odd number");
// assertion will pass
oneThwoThree.haveAtLeast(2, oddNumber);
// assertion will fail
oneThwoThree.haveAtLeast(3, oddNumber);
This method is an alias for areAtLeast(int, Condition)
.haveAtLeast
in interface ObjectEnumerableAssert<AtomicReferenceArrayAssert<T>,T>
times
- the minimum number of times the condition must hold.condition
- the given condition.this
assertion object.public AtomicReferenceArrayAssert<T> haveAtMost(int times, Condition<? super T> condition)
Example :
AtomicReferenceArray<Integer> oneThwoThree = new AtomicReferenceArray<>(new Integer[]{1, 2, 3});
Condition<Integer> oddNumber = new Condition<>(value % 2 == 1, "odd number");
// assertions will pass
oneThwoThree.haveAtMost(2, oddNumber);
oneThwoThree.haveAtMost(3, oddNumber);
// assertion will fail
oneThwoThree.haveAtMost(1, oddNumber);
This method is an alias areAtMost(int, Condition)
.haveAtMost
in interface ObjectEnumerableAssert<AtomicReferenceArrayAssert<T>,T>
times
- the maximum number of times the condition must hold.condition
- the given condition.this
assertion object.public AtomicReferenceArrayAssert<T> haveExactly(int times, Condition<? super T> condition)
Example :
AtomicReferenceArray<Integer> oneThwoThree = new AtomicReferenceArray<>(new Integer[]{1, 2, 3});
Condition<Integer> oddNumber = new Condition<>(value % 2 == 1, "odd number");
// assertion will pass
oneThwoThree.haveExactly(2, oddNumber);
// assertions will fail
oneThwoThree.haveExactly(1, oddNumber);
oneThwoThree.haveExactly(3, oddNumber);
This method is an alias areExactly(int, Condition)
.haveExactly
in interface ObjectEnumerableAssert<AtomicReferenceArrayAssert<T>,T>
times
- the exact number of times the condition must hold.condition
- the given condition.this
assertion object.public AtomicReferenceArrayAssert<T> hasAtLeastOneElementOfType(Class<?> expectedType)
Example:
AtomicReferenceArray<Number> numbers = new AtomicReferenceArray<>(new Number[]{ 2, 6L, 8.0 });
// successful assertion:
assertThat(numbers).hasAtLeastOneElementOfType(Long.class);
// assertion failure:
assertThat(numbers).hasAtLeastOneElementOfType(Float.class);
hasAtLeastOneElementOfType
in interface ObjectEnumerableAssert<AtomicReferenceArrayAssert<T>,T>
expectedType
- the expected type.NullPointerException
- if the given type is null
.AssertionError
- if the actual AtomicReferenceArray does not have any elements of the given type.public AtomicReferenceArrayAssert<T> hasOnlyElementsOfType(Class<?> expectedType)
Example:
AtomicReferenceArray<Number> numbers = new AtomicReferenceArray<>(new Number[]{ 2, 6, 8 });
// successful assertion:
assertThat(numbers).hasOnlyElementsOfType(Integer.class);
// assertion failure:
assertThat(numbers).hasOnlyElementsOfType(Long.class);
hasOnlyElementsOfType
in interface ObjectEnumerableAssert<AtomicReferenceArrayAssert<T>,T>
expectedType
- the expected type.NullPointerException
- if the given type is null
.AssertionError
- if one element is not of the expected type.public AtomicReferenceArrayAssert<T> doesNotHaveAnyElementsOfTypes(Class<?>... unexpectedTypes)
Example:
AtomicReferenceArray<Number> numbers = new AtomicReferenceArray<>(new Number[]{ 2, 6, 8.0 });
// successful assertion:
assertThat(numbers).doesNotHaveAnyElementsOfTypes(Long.class, Float.class);
// assertion failure:
assertThat(numbers).doesNotHaveAnyElementsOfTypes(Long.class, Integer.class);
doesNotHaveAnyElementsOfTypes
in interface ObjectEnumerableAssert<AtomicReferenceArrayAssert<T>,T>
unexpectedTypes
- the not expected types.NullPointerException
- if the given types is null
.AssertionError
- if one element's type matches the given types.public AtomicReferenceArrayAssert<T> isSorted()
All array elements must be primitive or implement the Comparable
interface and must be mutually comparable (that is,
e1.compareTo(e2) must not throw a ClassCastException for any elements e1 and e2 in the array), examples :
isSorted
in interface ArraySortedAssert<AtomicReferenceArrayAssert<T>,T>
this
assertion object.public AtomicReferenceArrayAssert<T> isSortedAccordingTo(Comparator<? super T> comparator)
isSortedAccordingTo
in interface ArraySortedAssert<AtomicReferenceArrayAssert<T>,T>
comparator
- the Comparator
used to compare array elementsthis
assertion object.public AtomicReferenceArrayAssert<T> containsAll(Iterable<? extends T> iterable)
Iterable
, in any order.
Example :
AtomicReferenceArray<String> abc = new AtomicReferenceArray<>(new String[]{"a", "b", "c"});
// assertion will pass
assertThat(abc).containsAll(Arrays.asList("b", "c"));
// assertions will fail
assertThat(abc).containsAll(Arrays.asList("d"));
assertThat(abc).containsAll(Arrays.asList("a", "b", "c", "d"));
containsAll
in interface ObjectEnumerableAssert<AtomicReferenceArrayAssert<T>,T>
iterable
- the given Iterable
we will get elements from.this
assertion object.NullPointerException
- if the given argument is null
.AssertionError
- if the actual AtomicReferenceArray is null
.AssertionError
- if the actual AtomicReferenceArray does not contain all the elements of given Iterable
.public AtomicReferenceArrayAssert<T> usingElementComparator(Comparator<? super T> elementComparator)
equals
method to compare AtomicReferenceArray
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(invoiceArray).usingComparator(invoicePayeeComparator).isEqualTo(expectedinvoiceArray).
// compares invoices by date, doesNotHaveDuplicates and contains both use the given invoice date comparator
assertThat(invoiceArray).usingComparator(invoiceDateComparator).doesNotHaveDuplicates().contains(may2010Invoice)
// as assertThat(invoiceArray) creates a new assertion, it falls back to standard comparison strategy
// based on Invoice's equal method to compare invoiceArray elements to lowestInvoice.
assertThat(invoiceArray).contains(lowestInvoice).
// standard comparison : the fellowshipOfTheRing includes Gandalf but not Sauron (believe me) ...
assertThat(fellowshipOfTheRing).contains(gandalf)
.doesNotContain(sauron);
// ... but if we compare only races, Sauron is in fellowshipOfTheRing because he's a Maia like Gandalf.
assertThat(fellowshipOfTheRing).usingElementComparator(raceComparator)
.contains(sauron);
usingElementComparator
in interface EnumerableAssert<AtomicReferenceArrayAssert<T>,T>
elementComparator
- the comparator to use for incoming assertion checks.this
assertion object.NullPointerException
- if the given comparator is null
.public AtomicReferenceArrayAssert<T> usingDefaultElementComparator()
This method should be used to disable a custom comparison strategy set by calling
EnumerableAssert.usingElementComparator(Comparator)
.
usingDefaultElementComparator
in interface EnumerableAssert<AtomicReferenceArrayAssert<T>,T>
this
assertion object.public <C> AtomicReferenceArrayAssert<T> usingComparatorForElementFieldsWithNames(Comparator<C> comparator, String... elementPropertyOrFieldNames)
To be used, comparators need to be specified by this method before calling any of:
usingFieldByFieldElementComparator()
usingElementComparatorOnFields(java.lang.String...)
usingElementComparatorIgnoringFields(java.lang.String...)
usingRecursiveFieldByFieldElementComparator()
Comparators specified by this method have precedence over comparators specified by
usingComparatorForElementFieldsWithType
.
Example:
public class TolkienCharacter {
private String name;
private double height;
// constructor omitted
}
TolkienCharacter frodo = new TolkienCharacter("Frodo", 1.2);
TolkienCharacter tallerFrodo = new TolkienCharacter("Frodo", 1.3);
TolkienCharacter reallyTallFrodo = new TolkienCharacter("Frodo", 1.9);
Comparator<Double> closeEnough = new Comparator<Double>() {
double precision = 0.5;
public int compare(Double d1, Double d2) {
return Math.abs(d1 - d2) <= precision ? 0 : 1;
}
};
AtomicReferenceArray<TolkienCharacter> hobbits = new AtomicReferenceArray<>(new TolkienCharacter[]{frodo});
// assertions will pass
assertThat(hobbits).usingComparatorForElementFieldsWithNames(closeEnough, "height")
.usingFieldByFieldElementComparator()
.contains(tallerFrodo);
assertThat(hobbits).usingComparatorForElementFieldsWithNames(closeEnough, "height")
.usingElementComparatorOnFields("height")
.contains(tallerFrodo);
assertThat(hobbits).usingComparatorForElementFieldsWithNames(closeEnough, "height")
.usingElementComparatorIgnoringFields("name")
.contains(tallerFrodo);
assertThat(hobbits).usingComparatorForElementFieldsWithNames(closeEnough, "height")
.usingRecursiveFieldByFieldElementComparator()
.contains(tallerFrodo);
// assertion will fail
assertThat(hobbits).usingComparatorForElementFieldsWithNames(closeEnough, "height")
.usingFieldByFieldElementComparator()
.containsExactly(reallyTallFrodo);
C
- the type to compare.comparator
- the Comparator
to useelementPropertyOrFieldNames
- the names of the properties and/or fields of the elements the comparator should be used forthis
assertions objectpublic <C> AtomicReferenceArrayAssert<T> usingComparatorForElementFieldsWithType(Comparator<C> comparator, Class<C> type)
To be used, comparators need to be specified by this method before calling any of:
usingFieldByFieldElementComparator()
usingElementComparatorOnFields(java.lang.String...)
usingElementComparatorIgnoringFields(java.lang.String...)
usingRecursiveFieldByFieldElementComparator()
Comparators specified by usingComparatorForElementFieldsWithNames
have precedence over comparators specified by this method.
Example:
public class TolkienCharacter {
private String name;
private double height;
// constructor omitted
}
TolkienCharacter frodo = new TolkienCharacter("Frodo", 1.2);
TolkienCharacter tallerFrodo = new TolkienCharacter("Frodo", 1.3);
TolkienCharacter reallyTallFrodo = new TolkienCharacter("Frodo", 1.9);
Comparator<Double> closeEnough = new Comparator<Double>() {
double precision = 0.5;
public int compare(Double d1, Double d2) {
return Math.abs(d1 - d2) <= precision ? 0 : 1;
}
};
AtomicReferenceArray<TolkienCharacter> hobbits = new AtomicReferenceArray<>(new TolkienCharacter[]{frodo});
// assertions will pass
assertThat(hobbits).usingComparatorForElementFieldsWithType(closeEnough, Double.class)
.usingFieldByFieldElementComparator()
.contains(tallerFrodo);
assertThat(hobbits).usingComparatorForElementFieldsWithType(closeEnough, Double.class)
.usingElementComparatorOnFields("height")
.contains(tallerFrodo);
assertThat(hobbits).usingComparatorForElementFieldsWithType(closeEnough, Double.class)
.usingElementComparatorIgnoringFields("name")
.contains(tallerFrodo);
assertThat(hobbits).usingComparatorForElementFieldsWithType(closeEnough, Double.class)
.usingRecursiveFieldByFieldElementComparator()
.contains(tallerFrodo);
// assertion will fail
assertThat(hobbits).usingComparatorForElementFieldsWithType(closeEnough, Double.class)
.usingFieldByFieldElementComparator()
.contains(reallyTallFrodo);
If multiple compatible comparators have been registered for a given type
, the closest in the inheritance
chain to the given type
is chosen in the following order:
type
type
type
C
- the type to compare.comparator
- the Comparator
to usetype
- the Class
of the type of the element fields the comparator should be used forthis
assertions objectpublic <C> AtomicReferenceArrayAssert<T> usingComparatorForType(Comparator<C> comparator, Class<C> type)
usingComparatorForElementFieldsWithType(java.util.Comparator<C>, java.lang.Class<C>)
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...)
usingRecursiveFieldByFieldElementComparator()
Example:
// assertion will pass
assertThat(new AtomicReferenceArray<>(new Object[] { "some", new BigDecimal("4.2") }))
.usingComparatorForType(BIG_DECIMAL_COMPARATOR, BigDecimal.class)
.contains(new BigDecimal("4.20"));
C
- the type to compare.comparator
- the Comparator
to usetype
- the Class
of the type of the element or element fields the comparator should be used forthis
assertions objectpublic AtomicReferenceArrayAssert<T> usingFieldByFieldElementComparator()
equals
method to compare AtomicReferenceArray elements for incoming assertion checks. Private fields
are included but this can be disabled using Assertions.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...)
and usingComparatorForElementFieldsWithType(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 equals
method.
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(atomicArray(frodo)).contains(frodoClone);
// frodo and frodoClone are equals when doing a field by field comparison.
assertThat(atomicArray(frodo)).usingFieldByFieldElementComparator().contains(frodoClone);
this
assertion object.public AtomicReferenceArrayAssert<T> usingRecursiveFieldByFieldElementComparator()
equals
method to compare AtomicReferenceArray elements for incoming
assertion checks. This can be useful if actual's equals
implementation does not suit you.
The recursive property/field comparison is not applied on fields having a custom equals
implementation, i.e. the overridden equals
method will be used instead of a field/property by field/property comparison.
You can specify a custom comparator per (nested) name or type of element field with
usingComparatorForElementFieldsWithNames
and usingComparatorForElementFieldsWithType
.
The recursive comparison handles cycles.
The objects to compare can be of different types but must have the same properties/fields. For example if actual object has a
name
String field, the other object must also have one.
If an object has a field and a property with the same name, the property value will be used over the field.
Example:
TolkienCharacter frodo = new TolkienCharacter("Frodo", 33, HOBBIT);
TolkienCharacter pippin = new TolkienCharacter("Pippin", 28, HOBBIT);
frodo.setFriend(pippin);
pippin.setFriend(frodo);
TolkienCharacter frodoClone = new TolkienCharacter("Frodo", 33, HOBBIT);
TolkienCharacter pippinClone = new TolkienCharacter("Pippin", 28, HOBBIT);
frodoClone.setFriend(pippinClone);
pippinClone.setFriend(frodoClone);
AtomicReferenceArray<TolkienCharacter> hobbits = new AtomicReferenceArray<>(new TolkienCharacter[] {frodo, pippin});
// fails if equals has not been overridden in TolkienCharacter as it would compares object references
assertThat(hobbits).contains(frodoClone, pippinClone);
// frodo/frodoClone and pippin/pippinClone are equals when doing a recursive property/field by property/field comparison
assertThat(hobbits).usingRecursiveFieldByFieldElementComparator()
.contains(frodoClone, pippinClone);
this
assertion object.public AtomicReferenceArrayAssert<T> usingElementComparatorOnFields(String... fields)
equals
method to compare AtomicReferenceArray elements for
incoming assertion checks. Private fields are included but this can be disabled using
Assertions.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...)
and usingComparatorForElementFieldsWithType(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 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(atomicArray(frodo)).usingElementComparatorOnFields("race").contains(sam); // OK
// ... but not when comparing both name and race
assertThat(atomicArray(frodo)).usingElementComparatorOnFields("name", "race").contains(sam); // FAIL
fields
- the fields to compare field/property by field/property.this
assertion object.public AtomicReferenceArrayAssert<T> usingElementComparatorIgnoringFields(String... fields)
equals
method to compare AtomicReferenceArray elements for
incoming assertion checks. Private fields are included but this can be disabled using
Assertions.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...)
and usingComparatorForElementFieldsWithType(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 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(atomicArray(frodo)).usingElementComparatorIgnoringFields("name", "age").contains(sam); // OK
// ... but not when comparing both name and race
assertThat(atomicArray(frodo)).usingElementComparatorIgnoringFields("age").contains(sam); // FAIL
fields
- the names of the fields/properties to ignorethis
assertion object.public ObjectArrayAssert<Object> extracting(String fieldOrProperty)
It allows you to test a field/property of the array's elements instead of testing the elements themselves, which can be much less work !
Let's take an example to make things clearer :
// Build a array of TolkienCharacter, a TolkienCharacter has a name (String) and a Race (a class)
// they can be public field or properties, both works when extracting their values.
AtomicReferenceArray<TolkienCharacter> fellowshipOfTheRing = new AtomicReferenceArray<>(new TolkienCharacter[]{
new TolkienCharacter("Frodo", 33, HOBBIT),
new TolkienCharacter("Sam", 38, HOBBIT),
new TolkienCharacter("Gandalf", 2020, MAIA),
new TolkienCharacter("Legolas", 1000, ELF),
new TolkienCharacter("Pippin", 28, HOBBIT),
new TolkienCharacter("Gimli", 139, DWARF),
new TolkienCharacter("Aragorn", 87, MAN,
new TolkienCharacter("Boromir", 37, MAN)
};
// let's verify the names of TolkienCharacter in fellowshipOfTheRing :
assertThat(fellowshipOfTheRing).extracting("name")
.contains("Boromir", "Gandalf", "Frodo")
.doesNotContain("Sauron", "Elrond");
// you can also extract nested field/property like the name of Race :
assertThat(fellowshipOfTheRing).extracting("race.name")
.contains("Hobbit", "Elf")
.doesNotContain("Orc");
A property with the given name is looked for first, if it does not exist then a field with the given name
is looked for.
Note that the order of extracted field/property values is consistent with the array order.
fieldOrProperty
- the field/property to extract from the array under testIntrospectionError
- if no field or property exists with the given namepublic <P> ObjectArrayAssert<P> extracting(String fieldOrProperty, Class<P> extractingType)
It allows you to test a field/property of the array's elements instead of testing the elements themselves, which can be much less work !
Let's take an example to make things clearer :
// Build an array of TolkienCharacter, a TolkienCharacter has a name (String) and a Race (a class)
// they can be public field or properties, both works when extracting their values.
AtomicReferenceArray<TolkienCharacter> fellowshipOfTheRing = new AtomicReferenceArray<>(new TolkienCharacter[]{
new TolkienCharacter("Frodo", 33, HOBBIT),
new TolkienCharacter("Sam", 38, HOBBIT),
new TolkienCharacter("Gandalf", 2020, MAIA),
new TolkienCharacter("Legolas", 1000, ELF),
new TolkienCharacter("Pippin", 28, HOBBIT),
new TolkienCharacter("Gimli", 139, DWARF),
new TolkienCharacter("Aragorn", 87, MAN,
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 also extract nested field/property like the name of Race :
assertThat(fellowshipOfTheRing).extracting("race.name", String.class)
.contains("Hobbit", "Elf")
.doesNotContain("Orc");
A property with the given name is looked for first, if it does not exist then a field with the given name
is looked for.
Note that the order of extracted field/property values is consistent with the order of the array under test.
P
- the extracted typefieldOrProperty
- the field/property to extract from the array under testextractingType
- type to returnIntrospectionError
- if no field or property exists with the given namepublic ObjectArrayAssert<Tuple> extracting(String... propertiesOrFields)
It allows you to test fields/properties of the array's elements instead of testing the elements themselves, it can be sometimes 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 array (the Tuple's data order is the same as the given fields/properties order).
Let's take an example to make things clearer :
// Build an array of TolkienCharacter, a TolkienCharacter has a name (String) and a Race (a class)
// they can be public field or properties, both works when extracting their values.
AtomicReferenceArray<TolkienCharacter> fellowshipOfTheRing = new AtomicReferenceArray<>(new TolkienCharacter[]{
new TolkienCharacter("Frodo", 33, HOBBIT),
new TolkienCharacter("Sam", 38, HOBBIT),
new TolkienCharacter("Gandalf", 2020, MAIA),
new TolkienCharacter("Legolas", 1000, ELF),
new TolkienCharacter("Pippin", 28, HOBBIT),
new TolkienCharacter("Gimli", 139, DWARF),
new TolkienCharacter("Aragorn", 87, MAN,
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"));
A property with the given name is looked for first, if it does not exist the a field with the given name is
looked for.
Note that the order of extracted property/field values is consistent with the iteration order of the array under test.
propertiesOrFields
- the properties/fields to extract from the initial array under testIntrospectionError
- if one of the given name does not match a field or property in one of the initial
Iterable's element.public <U> ObjectArrayAssert<U> extracting(Function<? super T,U> extractor)
It allows to test values from the elements in safer way than by using extracting(String)
, as it
doesn't utilize introspection.
Let's take a look an example:
// 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.
AtomicReferenceArray<TolkienCharacter> fellowshipOfTheRing = new AtomicReferenceArray<>(new TolkienCharacter[]{
new TolkienCharacter("Frodo", 33, HOBBIT),
new TolkienCharacter("Sam", 38, HOBBIT),
new TolkienCharacter("Gandalf", 2020, MAIA),
new TolkienCharacter("Legolas", 1000, ELF),
new TolkienCharacter("Pippin", 28, HOBBIT),
new TolkienCharacter("Gimli", 139, DWARF),
new TolkienCharacter("Aragorn", 87, MAN,
new TolkienCharacter("Boromir", 37, MAN)
};
// this extracts the race
Function<TolkienCharacter, Race> race = new Function<TolkienCharacter, Race>() {
@Override
public Race extract(TolkienCharacter input) {
return input.getRace();
}
}
// fellowship has hobbits, right, my presioussss?
assertThat(fellowshipOfTheRing).extracting(race).contains(HOBBIT);
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.U
- the extracted values typeextractor
- the object transforming input object to desired onepublic <U,EXCEPTION extends Exception> ObjectArrayAssert<U> extracting(ThrowingExtractor<? super T,U,EXCEPTION> extractor)
Any checked exception raised in the extractor is rethrown wrapped in a RuntimeException
.
It allows to test values from the elements in safer way than by using extracting(String)
, as it
doesn't utilize introspection.
Let's take a look an example:
// 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.
AtomicReferenceArray<TolkienCharacter> fellowshipOfTheRing = new AtomicReferenceArray<>(new TolkienCharacter[]{
new TolkienCharacter("Frodo", 33, HOBBIT),
new TolkienCharacter("Sam", 38, HOBBIT),
new TolkienCharacter("Gandalf", 2020, MAIA),
new TolkienCharacter("Legolas", 1000, ELF),
new TolkienCharacter("Pippin", 28, HOBBIT),
new TolkienCharacter("Gimli", 139, DWARF),
new TolkienCharacter("Aragorn", 87, MAN,
new TolkienCharacter("Boromir", 37, MAN)
};
assertThat(fellowshipOfTheRing).extracting(input -> {
if (input.getAge() < 20) {
throw new Exception("age < 20");
}
return input.getName();
}).contains("Frodo");
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.U
- the extracted values typeEXCEPTION
- the exception typeextractor
- the object transforming input object to desired onepublic <U,C extends Collection<U>> ObjectArrayAssert<U> flatExtracting(Function<? super T,C> extractor)
It allows testing the results of extracting values that are represented by Iterables.
For example:
CartoonCharacter bart = new CartoonCharacter("Bart Simpson");
CartoonCharacter lisa = new CartoonCharacter("Lisa Simpson");
CartoonCharacter maggie = new CartoonCharacter("Maggie Simpson");
CartoonCharacter homer = new CartoonCharacter("Homer Simpson");
homer.addChildren(bart, lisa, maggie);
CartoonCharacter pebbles = new CartoonCharacter("Pebbles Flintstone");
CartoonCharacter fred = new CartoonCharacter("Fred Flintstone");
fred.getChildren().add(pebbles);
Function<CartoonCharacter, List<CartoonCharacter>> childrenOf = new Function<CartoonCharacter, List<CartoonCharacter>>() {
@Override
public List<CartoonChildren> extract(CartoonCharacter input) {
return input.getChildren();
}
}
AtomicReferenceArray<CartoonCharacter> parents = new AtomicReferenceArray<>(new CartoonCharacter[]{ homer, fred });
// check children
assertThat(parents).flatExtracting(childrenOf)
.containsOnly(bart, lisa, maggie, pebbles);
The order of extracted values is consisted with both the order of the collection itself, as well as the extracted
collections.U
- the type of elements to extract.C
- the type of collection to flat/extract.extractor
- the object transforming input object to an Iterable of desired onespublic <U,C extends Collection<U>,EXCEPTION extends Exception> ObjectArrayAssert<U> flatExtracting(ThrowingExtractor<? super T,C,EXCEPTION> extractor)
It allows testing the results of extracting values that are represented by Iterables.
For example:
CartoonCharacter bart = new CartoonCharacter("Bart Simpson");
CartoonCharacter lisa = new CartoonCharacter("Lisa Simpson");
CartoonCharacter maggie = new CartoonCharacter("Maggie Simpson");
CartoonCharacter homer = new CartoonCharacter("Homer Simpson");
homer.addChildren(bart, lisa, maggie);
CartoonCharacter pebbles = new CartoonCharacter("Pebbles Flintstone");
CartoonCharacter fred = new CartoonCharacter("Fred Flintstone");
fred.getChildren().add(pebbles);
AtomicReferenceArray<CartoonCharacter> parents = new AtomicReferenceArray<>(new CartoonCharacter[]{ homer, fred });
// check children
assertThat(parents).flatExtracting(input -> {
if (input.getChildren().size() == 0) {
throw new Exception("no children");
}
return input.getChildren();
}).containsOnly(bart, lisa, maggie, pebbles);
The order of extracted values is consisted with both the order of the collection itself, as well as the extracted
collections.U
- the type of elements to extract.C
- the type of collection to flat/extract.EXCEPTION
- the exception typeextractor
- the object transforming input object to an Iterable of desired onespublic ObjectArrayAssert<Object> flatExtracting(String propertyName)
It allows testing the elements of extracting values that are represented by iterables or arrays.
For example:
CartoonCharacter bart = new CartoonCharacter("Bart Simpson");
CartoonCharacter lisa = new CartoonCharacter("Lisa Simpson");
CartoonCharacter maggie = new CartoonCharacter("Maggie Simpson");
CartoonCharacter homer = new CartoonCharacter("Homer Simpson");
homer.addChildren(bart, lisa, maggie);
CartoonCharacter pebbles = new CartoonCharacter("Pebbles Flintstone");
CartoonCharacter fred = new CartoonCharacter("Fred Flintstone");
fred.getChildren().add(pebbles);
AtomicReferenceArray<CartoonCharacter> parents = new AtomicReferenceArray<>(new CartoonCharacter[]{ homer, fred });
// check children
assertThat(parents).flatExtracting("children")
.containsOnly(bart, lisa, maggie, pebbles);
The order of extracted values is consisted with both the order of the collection itself, as well as the extracted
collections.propertyName
- the object transforming input object to an Iterable of desired onesIllegalArgumentException
- if one of the extracted property value was not an array or an iterable.public ObjectArrayAssert<Object> extractingResultOf(String method)
It allows you to test a method results of the array's elements instead of testing the elements themselves, which can be much less work!
It is especially useful for classes that does 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 :
// Build a array of WesterosHouse, a WesterosHouse has a method: public String sayTheWords()
AtomicReferenceArray<WesterosHouse> greatHousesOfWesteros = new AtomicReferenceArray<>(new WesterosHouse[]{
new WesterosHouse("Stark", "Winter is Coming"),
new WesterosHouse("Lannister", "Hear Me Roar!"),
new WesterosHouse("Greyjoy", "We Do Not Sow"),
new WesterosHouse("Baratheon", "Our is the Fury"),
new WesterosHouse("Martell", "Unbowed, Unbent, Unbroken"),
new WesterosHouse("Tyrell", "Growing Strong") });
// let's verify the words of the great houses of Westeros:
assertThat(greatHousesOfWesteros).extractingResultOf("sayTheWords")
.contains("Winter is Coming", "We Do Not Sow", "Hear Me Roar")
.doesNotContain("Lannisters always pay their debts");
Following requirements have to be met to extract method results:
Note that the order of extracted values is consistent with the order of the array under test.
method
- the name of the method which result is to be extracted from the array under testIllegalArgumentException
- if no method exists with the given name, or method is not public, or method does
return void, or method accepts arguments.public <P> ObjectArrayAssert<P> extractingResultOf(String method, Class<P> extractingType)
It allows you to test a method results of the array's elements instead of testing the elements themselves, which can be much less work!
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 :
// Build a array of WesterosHouse, a WesterosHouse has a method: public String sayTheWords()
AtomicReferenceArray<WesterosHouse> greatHousesOfWesteros = new AtomicReferenceArray<>(new WesterosHouse[]{
new WesterosHouse("Stark", "Winter is Coming"),
new WesterosHouse("Lannister", "Hear Me Roar!"),
new WesterosHouse("Greyjoy", "We Do Not Sow"),
new WesterosHouse("Baratheon", "Our is the Fury"),
new WesterosHouse("Martell", "Unbowed, Unbent, Unbroken"),
new WesterosHouse("Tyrell", "Growing Strong") });
// let's verify the words of the great houses of Westeros:
assertThat(greatHousesOfWesteros).extractingResultOf("sayTheWords", String.class)
.contains("Winter is Coming", "We Do Not Sow", "Hear Me Roar")
.doesNotContain("Lannisters always pay their debts");
Following requirements have to be met to extract method results:
Note that the order of extracted values is consistent with the order of the array under test.
P
- the extracted typemethod
- the name of the method which result is to be extracted from the array under testextractingType
- type to returnIllegalArgumentException
- if no method exists with the given name, or method is not public, or method does
return void, or method accepts arguments.public AtomicReferenceArrayAssert<T> inHexadecimal()
It can be useful to better understand what the error was with a more meaningful error message.
Example
AtomicReferenceArray<Byte> bytes = new AtomicReferenceArray<>(new Byte[]{ 0x10, 0x20 });
assertThat(bytes).inHexadecimal().contains(new Byte[] { 0x30 });
With standard error message:
Expecting:
<[16, 32]>
to contain:
<[48]>
but could not find:
<[48]>
With Hexadecimal error message:
Expecting:
<[0x10, 0x20]>
to contain:
<[0x30]>
but could not find:
<[0x30]>
inHexadecimal
in class AbstractAssert<AtomicReferenceArrayAssert<T>,AtomicReferenceArray<T>>
this
assertion object.public AtomicReferenceArrayAssert<T> inBinary()
AbstractAssert
Example:
assertThat(1).inBinary().isEqualTo(2);
org.junit.ComparisonFailure:
Expected :0b00000000_00000000_00000000_00000010
Actual :0b00000000_00000000_00000000_00000001
inBinary
in class AbstractAssert<AtomicReferenceArrayAssert<T>,AtomicReferenceArray<T>>
this
assertion object.public AtomicReferenceArrayAssert<T> filteredOn(String propertyOrFieldName, Object expectedValue)
expectedValue
, the
property/field is specified by propertyOrFieldName
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 calling Assertions.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):
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);
AtomicReferenceArray<Employee> employees = new AtomicReferenceArray<>(new Employee[]{ yoda, luke, obiwan, noname });
assertThat(employees).filteredOn("age", 800)
.containsOnly(yoda, obiwan);
Nested properties/fields are supported:
// 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 to
filteredOn(String, FilterOperator)
instead of this method.
An IntrospectionError
is thrown if the given propertyOrFieldName can't be found in one of the array
elements.
You can chain filters:
// fellowshipOfTheRing is an array 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);
If you need more complex filter, use filteredOn(Condition)
and provide a Condition
to specify the
filter to apply.propertyOrFieldName
- the name of the property or field to readexpectedValue
- the value to compare element's property or field withIllegalArgumentException
- if the given propertyOrFieldName is null
or empty.IntrospectionError
- if the given propertyOrFieldName can't be found in one of the array elements.public AtomicReferenceArrayAssert<T> filteredOnNull(String propertyOrFieldName)
propertyOrFieldName
is null.
exists it tries to read the value from a field. Reading private fields is supported by default, this can be
globally disabled by calling Assertions.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):
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);
AtomicReferenceArray<Employee> employees = new AtomicReferenceArray<>(new Employee[]{ yoda, luke, obiwan, noname });
assertThat(employees).filteredOnNull("name")
.containsOnly(noname);
Nested properties/fields are supported:
// Name is bean class with 'first' and 'last' String properties
assertThat(employees).filteredOnNull("name.last")
.containsOnly(yoda, obiwan, noname);
An IntrospectionError
is thrown if the given propertyOrFieldName can't be found in one of the array
elements.
If you need more complex filter, use filteredOn(Condition)
and provide a Condition
to specify the
filter to apply.
propertyOrFieldName
- the name of the property or field to readIntrospectionError
- if the given propertyOrFieldName can't be found in one of the array elements.public AtomicReferenceArrayAssert<T> filteredOn(String propertyOrFieldName, FilterOperator<?> filterOperator)
FilterOperator
, the property/field is specified by propertyOrFieldName
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 calling Assertions.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 :
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);
AtomicReferenceArray<Employee> employees = new AtomicReferenceArray<>(new Employee[]{ 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);
An IntrospectionError
is thrown if the given propertyOrFieldName can't be found in one of the array
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:
// fellowshipOfTheRing is an array 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);
If you need more complex filter, use filteredOn(Condition)
and provide a Condition
to specify the
filter to apply.propertyOrFieldName
- the name of the property or field to readfilterOperator
- the filter operator to applyIllegalArgumentException
- if the given propertyOrFieldName is null
or empty.public AtomicReferenceArrayAssert<T> filteredOn(Condition<? super T> condition)
Condition
.
Let's 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);
Employee noname = new Employee(4L, null, 50);
AtomicReferenceArray<Employee> employees = new AtomicReferenceArray<>(new Employee[]{ 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);
You can combine Condition
with condition operator like Not
:
// 'not' filter is statically imported from Assertions.not
assertThat(employees).filteredOn(not(oldEmployees))
.contains(luke, noname);
condition
- the filter condition / predicateIllegalArgumentException
- if the given condition is null
.public AtomicReferenceArrayAssert<T> allMatch(Predicate<? super T> predicate)
Predicate
.
Example :
AtomicReferenceArray<String> abc = new AtomicReferenceArray<>(new String[] {"a", "b", "c"});
AtomicReferenceArray<String> abcc = new AtomicReferenceArray<>(new String[] {"a", "b", "cc"});
// assertion will pass
assertThat(abc).allMatch(s -> s.length() == 1);
// assertion will fail
assertThat(abcc).allMatch(s -> s.length() == 1);
Note that you can achieve the same result with are(Condition)
or have(Condition)
.allMatch
in interface ObjectEnumerableAssert<AtomicReferenceArrayAssert<T>,T>
predicate
- the given Predicate
.this
object.NullPointerException
- if the given predicate is null
.AssertionError
- if an element cannot be cast to T.AssertionError
- if one or more elements don't satisfy the given predicate.public AtomicReferenceArrayAssert<T> allMatch(Predicate<? super T> predicate, String predicateDescription)
Predicate
. The predicate description is used
to get an informative error message.
Example :
AtomicReferenceArray<String> abc = new AtomicReferenceArray<>(new String[] {"a", "b", "c"});
AtomicReferenceArray<String> abcc = new AtomicReferenceArray<>(new String[] {"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");
The message of the failed assertion would be:
Expecting all elements of:
<["a", "b", "cc"]>
to match 'length of 1' predicate but this element did not:
<"cc">
allMatch
in interface ObjectEnumerableAssert<AtomicReferenceArrayAssert<T>,T>
predicate
- the given Predicate
.predicateDescription
- a description of the Predicate
used in the error messagethis
object.NullPointerException
- if the given predicate is null
.AssertionError
- if an element cannot be cast to T.AssertionError
- if one or more elements don't satisfy the given predicate.public AtomicReferenceArrayAssert<T> allSatisfy(Consumer<? super T> requirements)
Consumer
.
This is useful to perform a group of assertions on elements.
Grouping assertions example:
// myIcelanderFriends is an AtomicReferenceArray<Person>
assertThat(myIcelanderFriends).allSatisfy(person -> {
assertThat(person.getCountry()).isEqualTo("Iceland");
assertThat(person.getPhoneCountryCode()).isEqualTo("+354");
});
allSatisfy
in interface ObjectEnumerableAssert<AtomicReferenceArrayAssert<T>,T>
requirements
- the given Consumer
.this
object.NullPointerException
- if the given Consumer
is null
.AssertionError
- if one or more elements don't satisfy given requirements.public AtomicReferenceArrayAssert<T> anyMatch(Predicate<? super T> predicate)
Predicate
.
Example :
AtomicReferenceArray<String> abc = new AtomicReferenceArray<>(new String[] {"a", "b", "c"});
AtomicReferenceArray<String> abcc = new AtomicReferenceArray<>(new String[] {"a", "b", "cc"});
// assertion will pass
assertThat(abc).anyMatch(s -> s.length() == 2);
// assertion will fail
assertThat(abcc).anyMatch(s -> s.length() > 2);
Note that you can achieve the same result with areAtLeastOne(Condition)
or haveAtLeastOne(Condition)
.anyMatch
in interface ObjectEnumerableAssert<AtomicReferenceArrayAssert<T>,T>
predicate
- the given Predicate
.this
object.NullPointerException
- if the given predicate is null
.AssertionError
- if no elements satisfy the given predicate.public AtomicReferenceArrayAssert<T> anySatisfy(Consumer<? super T> requirements)
Consumer
.
This is useful to check that a group of assertions is verified by (at least) one element.
If the AtomicReferenceArray
to assert is empty, the assertion will fail.
Grouping assertions example:
// myIcelanderFriends is an AtomicReferenceArray<Person>
assertThat(myIcelanderFriends).anySatisfy(person -> {
assertThat(person.getCountry()).isEqualTo("Iceland");
assertThat(person.getPhoneCountryCode()).isEqualTo("+354");
assertThat(person.getSurname()).endsWith("son");
});
// assertion fails for empty group, whatever the requirements are.
assertThat(emptyArray).anySatisfy($ -> {
assertThat(true).isTrue();
});
anySatisfy
in interface ObjectEnumerableAssert<AtomicReferenceArrayAssert<T>,T>
requirements
- the given Consumer
.this
object.NullPointerException
- if the given Consumer
is null
.AssertionError
- if all elements don't satisfy given requirements.public AtomicReferenceArrayAssert<T> noneSatisfy(Consumer<? super T> restrictions)
ObjectEnumerableAssert
Consumer
.
Example:
// assume that all icelander in myIcelanderFriends are not from Brazil
assertThat(myIcelanderFriends).noneSatisfy(person -> {
assertThat(person.getCountry()).isEqualTo("Brazil");
});
Note that this assertion succeeds if the group (collection, array, ...) is empty whatever the restrictions are.noneSatisfy
in interface ObjectEnumerableAssert<AtomicReferenceArrayAssert<T>,T>
restrictions
- the given restrictions as Consumer
that no elements should met.this
object.public AtomicReferenceArrayAssert<T> containsAnyOf(T... values)
Example :
AtomicReferenceArray<String> abc = new AtomicReferenceArray<>(new String[]{"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");
containsAnyOf
in interface ObjectEnumerableAssert<AtomicReferenceArrayAssert<T>,T>
values
- the values whose at least one which is expected to be in the AtomicReferenceArray
under test.this
assertion object.NullPointerException
- if the array of values is null
.IllegalArgumentException
- if the array of values is empty and the AtomicReferenceArray
under test is not empty.AssertionError
- if the AtomicReferenceArray
under test is null
.AssertionError
- if the AtomicReferenceArray
under test does not contain any of the given values
.public AtomicReferenceArrayAssert<T> containsAnyElementsOf(Iterable<? extends T> iterable)
Iterable
elements.
Example :
AtomicReferenceArray<String> abc = new AtomicReferenceArray<>(new String[]{"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"));
containsAnyElementsOf
in interface ObjectEnumerableAssert<AtomicReferenceArrayAssert<T>,T>
iterable
- the iterable whose at least one element is expected to be in the AtomicReferenceArray
under test.this
assertion object.NullPointerException
- if the iterable of expected values is null
.IllegalArgumentException
- if the iterable of expected values is empty and the AtomicReferenceArray
under test is not empty.AssertionError
- if the AtomicReferenceArray
under test is null
.AssertionError
- if the AtomicReferenceArray
under test does not contain any of elements from the given Iterable
.public AtomicReferenceArrayAssert<T> noneMatch(Predicate<? super T> predicate)
Predicate
.
Example :
AtomicReferenceArray<String> abcc = new AtomicReferenceArray<>(new String[]{"a", "b", "cc"});
// assertion will pass
assertThat(abcc).noneMatch(s -> s.isEmpty());
// assertion will fail
assertThat(abcc).noneMatch(s -> s.length() == 2);
Note that you can achieve the same result with areNot(Condition)
or doNotHave(Condition)
.noneMatch
in interface ObjectEnumerableAssert<AtomicReferenceArrayAssert<T>,T>
predicate
- the given Predicate
.this
object.NullPointerException
- if the given predicate is null
.AssertionError
- if an element cannot be cast to T.AssertionError
- if any element satisfy the given predicate.protected TypeComparators getComparatorsByType()
protected TypeComparators getComparatorsForElementPropertyOrFieldTypes()
Copyright © 2014–2019 AssertJ. All rights reserved.