Package org.fest.assertions.internal
Class Iterables
java.lang.Object
org.fest.assertions.internal.Iterables
Reusable assertions for
Iterable
s.- Author:
- Alex Ruiz, Yvonne Wang, Maciej Jaskowski, Nicolas François, Joel Costigliola
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescription<E> void
assertAre
(AssertionInfo info, Iterable<? extends E> actual, Condition<? super E> condition) Assert that each element of givenIterable
satisfies the given condition.<E> void
assertAreAtLeast
(AssertionInfo info, Iterable<? extends E> actual, int n, Condition<? super E> condition) Assert that there is at least n elements in the actualIterable
satisfying the given condition.<E> void
assertAreAtMost
(AssertionInfo info, Iterable<? extends E> actual, int n, Condition<? super E> condition) Assert that there is at most n elements in the actualIterable
satisfying the given condition.<E> void
assertAreExactly
(AssertionInfo info, Iterable<? extends E> actual, int n, Condition<? super E> condition) Verifies that there is exactly n elements in the actualIterable
satisfying the given condition.<E> void
assertAreNot
(AssertionInfo info, Iterable<? extends E> actual, Condition<? super E> condition) Assert that each element of givenIterable
not satisfies the given condition.<E> void
assertAreNotAtLeast
(AssertionInfo info, Iterable<? extends E> actual, int n, Condition<? super E> condition) Assert that there is at least n elements in the actualIterable
not satisfying the given condition.<E> void
assertAreNotAtMost
(AssertionInfo info, Iterable<? extends E> actual, int n, Condition<? super E> condition) Verifies that there is at most n elements in the actualIterable
not satisfying the given condition.<E> void
assertAreNotExactly
(AssertionInfo info, Iterable<? extends E> actual, int n, Condition<? super E> condition) Verifies that there is exactly n elements in the actualIterable
not satisfying the given condition.void
assertContains
(AssertionInfo info, Iterable<?> actual, Object[] values) Asserts that the givenIterable
contains the given values, in any order.void
assertContainsAll
(AssertionInfo info, Iterable<?> actual, Iterable<?> other) Asserts that the givenIterable
contains all the elements of the otherIterable
, in any order.void
assertContainsExactly
(AssertionInfo info, Iterable<?> actual, Object[] values) Asserts that the givenIterable
contains exactly the given values and nothing else, in order.void
assertContainsNull
(AssertionInfo info, Iterable<?> actual) Asserts that the givenIterable
contains at least a null element.void
assertContainsOnly
(AssertionInfo info, Iterable<?> actual, Object[] values) Asserts that the givenIterable
contains only the given values and nothing else, in any order.void
assertContainsSequence
(AssertionInfo info, Iterable<?> actual, Object[] sequence) Verifies that the given
contains the given sequence of objects, without any other objects between them.Iterable
void
assertDoesNotContain
(AssertionInfo info, Iterable<?> actual, Object[] values) Asserts that the givenIterable
does not contain the given values.void
assertDoesNotContainNull
(AssertionInfo info, Iterable<?> actual) Asserts that the givenIterable
does not contain null elements.void
assertDoesNotHaveDuplicates
(AssertionInfo info, Iterable<?> actual) Asserts that the givenIterable
does not have duplicate values.<E> void
assertDoNotHave
(AssertionInfo info, Iterable<? extends E> actual, Condition<? super E> condition) Assert that each element of givenIterable
not satisfies the given condition.<E> void
assertDoNotHaveAtLeast
(AssertionInfo info, Iterable<? extends E> actual, int times, Condition<? super E> condition) An alias method ofassertAreNotAtLeast(AssertionInfo, Iterable, int, Condition)
to provide a richer fluent api (same logic, only error message differs).<E> void
assertDoNotHaveAtMost
(AssertionInfo info, Iterable<? extends E> actual, int times, Condition<? super E> condition) An alias method ofassertAreNotAtMost(AssertionInfo, Iterable, int, Condition)
to provide a richer fluent api (same logic, only error message differs).<E> void
assertDoNotHaveExactly
(AssertionInfo info, Iterable<? extends E> actual, int times, Condition<? super E> condition) An alias method ofassertAreNotExactly(AssertionInfo, Iterable, int, Condition)
to provide a richer fluent api (same logic, only error message differs).void
assertEmpty
(AssertionInfo info, Iterable<?> actual) Asserts that the givenIterable
is empty.void
assertEndsWith
(AssertionInfo info, Iterable<?> actual, Object[] sequence) Verifies that the givenIterable
ends with the given sequence of objects, without any other objects between them.void
assertHasSameSizeAs
(AssertionInfo info, Iterable<?> actual, Iterable<?> other) Assert that the actualIterable
has the same size as the otherIterable
.void
assertHasSameSizeAs
(AssertionInfo info, Iterable<?> actual, Object[] other) Assert that the actualIterable
has the same size as the other array.void
assertHasSize
(AssertionInfo info, Iterable<?> actual, int expectedSize) Asserts that the number of elements in the givenIterable
is equal to the expected one.<E> void
assertHave
(AssertionInfo info, Iterable<? extends E> actual, Condition<? super E> condition) Assert that each element of givenIterable
satisfies the given condition.<E> void
assertHaveAtLeast
(AssertionInfo info, Iterable<? extends E> actual, int times, Condition<? super E> condition) An alias method ofassertAreAtLeast(AssertionInfo, Iterable, int, Condition)
to provide a richer fluent api (same logic, only error message differs).<E> void
assertHaveAtMost
(AssertionInfo info, Iterable<? extends E> actual, int times, Condition<? super E> condition) An alias method ofassertAreAtMost(AssertionInfo, Iterable, int, Condition)
to provide a richer fluent api (same logic, only error message differs).<E> void
assertHaveExactly
(AssertionInfo info, Iterable<? extends E> actual, int times, Condition<? super E> condition) An alias method ofassertAreExactly(AssertionInfo, Iterable, int, Condition)
to provide a richer fluent api (same logic, only error message differs).void
assertIsSubsetOf
(AssertionInfo info, Iterable<?> actual, Iterable<?> values) Verifies that the actualIterable
is a subset of valuesIterable
.void
assertNotEmpty
(AssertionInfo info, Iterable<?> actual) Asserts that the givenIterable
is not empty.void
assertNullOrEmpty
(AssertionInfo info, Iterable<?> actual) Asserts that the given
isIterable
null
or empty.void
assertStartsWith
(AssertionInfo info, Iterable<?> actual, Object[] sequence) Verifies that the givenIterable
starts with the given sequence of objects, without any other objects between them.Comparator
<?> static Iterables
instance()
Returns the singleton instance of this class based onStandardComparisonStrategy
.static IllegalArgumentException
static NullPointerException
-
Constructor Details
-
Iterables
-
-
Method Details
-
instance
Returns the singleton instance of this class based onStandardComparisonStrategy
.- Returns:
- the singleton instance of this class based on
StandardComparisonStrategy
.
-
getComparator
-
assertNullOrEmpty
Asserts that the given
isIterable
null
or empty.- Parameters:
info
- contains information about the assertion.actual
- the givenIterable
.- Throws:
AssertionError
- if the givenIterable
is notnull
*and* contains one or more elements.
-
assertEmpty
Asserts that the givenIterable
is empty.- Parameters:
info
- contains information about the assertion.actual
- the givenIterable
.- Throws:
AssertionError
- if the givenIterable
isnull
.AssertionError
- if the givenIterable
is not empty.
-
assertNotEmpty
Asserts that the givenIterable
is not empty.- Parameters:
info
- contains information about the assertion.actual
- the givenIterable
.- Throws:
AssertionError
- if the givenIterable
isnull
.AssertionError
- if the givenIterable
is empty.
-
assertHasSize
Asserts that the number of elements in the givenIterable
is equal to the expected one.- Parameters:
info
- contains information about the assertion.actual
- the givenIterable
.expectedSize
- the expected size ofactual
.- Throws:
AssertionError
- if the givenIterable
isnull
.AssertionError
- if the number of elements in the givenIterable
is different than the expected one.
-
assertHasSameSizeAs
Assert that the actualIterable
has the same size as the other array.- Parameters:
info
- contains information about the assertion.actual
- the givenIterable
.other
- the given array to compare.- Throws:
AssertionError
- if the actual group isnull
.AssertionError
- if the other group isnull
.AssertionError
- if actualIterable
and other array don't have the same size.
-
assertHasSameSizeAs
Assert that the actualIterable
has the same size as the otherIterable
.- Parameters:
info
- contains information about the assertion.actual
- the givenIterable
.other
- the givenIterable
.- Throws:
AssertionError
- if the actual group isnull
.AssertionError
- if the other group isnull
.AssertionError
- if actual and otherIterable
don't have the same size.
-
assertContains
Asserts that the givenIterable
contains the given values, in any order.- Parameters:
info
- contains information about the assertion.actual
- the givenIterable
.values
- the values that are expected to be in the givenIterable
.- Throws:
NullPointerException
- if the array of values isnull
.IllegalArgumentException
- if the array of values is empty.AssertionError
- if the givenIterable
isnull
.AssertionError
- if the givenIterable
does not contain the given values.
-
assertContainsOnly
Asserts that the givenIterable
contains only the given values and nothing else, in any order.- Parameters:
info
- contains information about the assertion.actual
- the givenIterable
.values
- the values that are expected to be in the givenIterable
.- Throws:
NullPointerException
- if the array of values isnull
.IllegalArgumentException
- if the array of values is empty.AssertionError
- if the givenIterable
isnull
.AssertionError
- if the givenIterable
does not contain the given values or if the givenIterable
contains values that are not in the given array.
-
assertContainsSequence
Verifies that the given
contains the given sequence of objects, without any other objects between them.Iterable
- Parameters:
info
- contains information about the assertion.actual
- the givenIterable
.sequence
- the sequence of objects to look for.- Throws:
AssertionError
- if the givenIterable
isnull
.NullPointerException
- if the given sequence isnull
.IllegalArgumentException
- if the given sequence is empty.AssertionError
- if the givenIterable
does not contain the given sequence of objects.
-
assertIsSubsetOf
Verifies that the actualIterable
is a subset of valuesIterable
.
Both actual and given iterable are treated as sets, therefore duplicates on either of them are ignored.- Parameters:
info
- contains information about the assertion.actual
- the actualIterable
.values
- theIterable
that should contain all actual elements.- Throws:
AssertionError
- if the actualIterable
isnull
.NullPointerException
- if the given Iterable isnull
.AssertionError
- if the actualIterable
is not subset of setIterable
-
assertDoesNotContain
Asserts that the givenIterable
does not contain the given values.- Parameters:
info
- contains information about the assertion.actual
- the givenIterable
.values
- the values that are expected not to be in the givenIterable
.- Throws:
NullPointerException
- if the array of values isnull
.IllegalArgumentException
- if the array of values is empty.AssertionError
- if the givenIterable
isnull
.AssertionError
- if the givenIterable
contains any of given values.
-
assertDoesNotHaveDuplicates
Asserts that the givenIterable
does not have duplicate values.- Parameters:
info
- contains information about the assertion.actual
- the givenIterable
.- Throws:
NullPointerException
- if the array of values isnull
.IllegalArgumentException
- if the array of values is empty.AssertionError
- if the givenIterable
isnull
.AssertionError
- if the givenIterable
contains duplicate values.
-
assertStartsWith
Verifies that the givenIterable
starts with the given sequence of objects, without any other objects between them. Similar to
, but it also verifies that the first element in the sequence is also the first element of the givenassertContainsSequence(AssertionInfo, Iterable, Object[])
Iterable
.- Parameters:
info
- contains information about the assertion.actual
- the givenIterable
.sequence
- the sequence of objects to look for.- Throws:
NullPointerException
- if the given argument isnull
.IllegalArgumentException
- if the given argument is an empty array.AssertionError
- if the givenIterable
isnull
.AssertionError
- if the givenIterable
does not start with the given sequence of objects.
-
assertEndsWith
Verifies that the givenIterable
ends with the given sequence of objects, without any other objects between them. Similar to
, but it also verifies that the last element in the sequence is also the last element of the givenassertContainsSequence(AssertionInfo, Iterable, Object[])
Iterable
.- Parameters:
info
- contains information about the assertion.actual
- the givenIterable
.sequence
- the sequence of objects to look for.- Throws:
NullPointerException
- if the given argument isnull
.IllegalArgumentException
- if the given argument is an empty array.AssertionError
- if the givenIterable
isnull
.AssertionError
- if the givenIterable
does not end with the given sequence of objects.
-
assertContainsNull
Asserts that the givenIterable
contains at least a null element.- Parameters:
info
- contains information about the assertion.actual
- the givenIterable
.- Throws:
AssertionError
- if the givenIterable
isnull
.AssertionError
- if the givenIterable
does not contain at least a null element.
-
assertDoesNotContainNull
Asserts that the givenIterable
does not contain null elements.- Parameters:
info
- contains information about the assertion.actual
- the givenIterable
.- Throws:
AssertionError
- if the givenIterable
isnull
.AssertionError
- if the givenIterable
contains a null element.
-
assertAre
public <E> void assertAre(AssertionInfo info, Iterable<? extends E> actual, Condition<? super E> condition) Assert that each element of givenIterable
satisfies the given condition.- Parameters:
info
- contains information about the assertion.actual
- the givenIterable
.condition
- the givenCondition
.- Throws:
NullPointerException
- if the given condition isnull
.AssertionError
- if a element cannot be cast to E.AssertionError
- if one or more element not satisfy the given condition.
-
assertAreNot
public <E> void assertAreNot(AssertionInfo info, Iterable<? extends E> actual, Condition<? super E> condition) Assert that each element of givenIterable
not satisfies the given condition.- Parameters:
info
- contains information about the assertion.actual
- the givenIterable
.condition
- the givenCondition
.- Throws:
NullPointerException
- if the given condition isnull
.AssertionError
- if a element cannot be cast to E.AssertionError
- if one or more element satisfy the given condition.
-
assertHave
public <E> void assertHave(AssertionInfo info, Iterable<? extends E> actual, Condition<? super E> condition) Assert that each element of givenIterable
satisfies the given condition.- Parameters:
info
- contains information about the assertion.actual
- the givenIterable
.condition
- the givenCondition
.- Throws:
NullPointerException
- if the given condition isnull
.AssertionError
- if a element cannot be cast to E.AssertionError
- if one or more element not satisfy the given condition.
-
assertDoNotHave
public <E> void assertDoNotHave(AssertionInfo info, Iterable<? extends E> actual, Condition<? super E> condition) Assert that each element of givenIterable
not satisfies the given condition.- Parameters:
info
- contains information about the assertion.actual
- the givenIterable
.condition
- the givenCondition
.- Throws:
NullPointerException
- if the given condition isnull
.AssertionError
- if a element cannot be cast to E.AssertionError
- if one or more element satisfy the given condition.
-
assertAreAtLeast
public <E> void assertAreAtLeast(AssertionInfo info, Iterable<? extends E> actual, int n, Condition<? super E> condition) Assert that there is at least n elements in the actualIterable
satisfying the given condition.- Parameters:
info
- contains information about the assertion.actual
- the givenIterable
.n
- the minimum number of times the condition should be verified.condition
- the givenCondition
.- Throws:
NullPointerException
- if the given condition isnull
.AssertionError
- if a element cannot be cast to E.AssertionError
- if the number of elements satisfying the given condition is < n.
-
assertAreNotAtLeast
public <E> void assertAreNotAtLeast(AssertionInfo info, Iterable<? extends E> actual, int n, Condition<? super E> condition) Assert that there is at least n elements in the actualIterable
not satisfying the given condition.- Parameters:
info
- contains information about the assertion.actual
- the givenIterable
.n
- the number of times the condition should not be verified at least.condition
- the givenCondition
.- Throws:
NullPointerException
- if the given condition isnull
.AssertionError
- if a element cannot be cast to E.AssertionError
- if the number of elements not satisfying the given condition is < n.
-
assertAreAtMost
public <E> void assertAreAtMost(AssertionInfo info, Iterable<? extends E> actual, int n, Condition<? super E> condition) Assert that there is at most n elements in the actualIterable
satisfying the given condition.- Parameters:
info
- contains information about the assertion.actual
- the givenIterable
.n
- the number of times the condition should be at most verified.condition
- the givenCondition
.- Throws:
NullPointerException
- if the given condition isnull
.AssertionError
- if a element cannot be cast to E.AssertionError
- if the number of elements satisfying the given condition is > n.
-
assertAreNotAtMost
public <E> void assertAreNotAtMost(AssertionInfo info, Iterable<? extends E> actual, int n, Condition<? super E> condition) Verifies that there is at most n elements in the actualIterable
not satisfying the given condition.- Parameters:
info
- contains information about the assertion.actual
- the givenIterable
.n
- the number of times the condition should not be verified at most.condition
- the givenCondition
.- Throws:
NullPointerException
- if the given condition isnull
.AssertionError
- if a element cannot be cast to E.AssertionError
- if the number of elements not satisfying the given condition is > n.
-
assertAreExactly
public <E> void assertAreExactly(AssertionInfo info, Iterable<? extends E> actual, int n, Condition<? super E> condition) Verifies that there is exactly n elements in the actualIterable
satisfying the given condition.- Parameters:
info
- contains information about the assertion.actual
- the givenIterable
.n
- the exact number of times the condition should be verified.condition
- the givenCondition
.- Throws:
NullPointerException
- if the given condition isnull
.AssertionError
- if a element cannot be cast to E.AssertionError
- if the number of elements satisfying the given condition is ≠ n.
-
assertAreNotExactly
public <E> void assertAreNotExactly(AssertionInfo info, Iterable<? extends E> actual, int n, Condition<? super E> condition) Verifies that there is exactly n elements in the actualIterable
not satisfying the given condition.- Parameters:
info
- contains information about the assertion.actual
- the givenIterable
.n
- the exact number of times the condition should not be verified.condition
- the givenCondition
.- Throws:
NullPointerException
- if the given condition isnull
.AssertionError
- if a element cannot be cast to E.AssertionError
- if the number of elements not satisfying the given condition is ≠ n.
-
assertHaveAtLeast
public <E> void assertHaveAtLeast(AssertionInfo info, Iterable<? extends E> actual, int times, Condition<? super E> condition) An alias method ofassertAreAtLeast(AssertionInfo, Iterable, int, Condition)
to provide a richer fluent api (same logic, only error message differs). -
assertDoNotHaveAtLeast
public <E> void assertDoNotHaveAtLeast(AssertionInfo info, Iterable<? extends E> actual, int times, Condition<? super E> condition) An alias method ofassertAreNotAtLeast(AssertionInfo, Iterable, int, Condition)
to provide a richer fluent api (same logic, only error message differs). -
assertHaveAtMost
public <E> void assertHaveAtMost(AssertionInfo info, Iterable<? extends E> actual, int times, Condition<? super E> condition) An alias method ofassertAreAtMost(AssertionInfo, Iterable, int, Condition)
to provide a richer fluent api (same logic, only error message differs). -
assertDoNotHaveAtMost
public <E> void assertDoNotHaveAtMost(AssertionInfo info, Iterable<? extends E> actual, int times, Condition<? super E> condition) An alias method ofassertAreNotAtMost(AssertionInfo, Iterable, int, Condition)
to provide a richer fluent api (same logic, only error message differs). -
assertHaveExactly
public <E> void assertHaveExactly(AssertionInfo info, Iterable<? extends E> actual, int times, Condition<? super E> condition) An alias method ofassertAreExactly(AssertionInfo, Iterable, int, Condition)
to provide a richer fluent api (same logic, only error message differs). -
assertDoNotHaveExactly
public <E> void assertDoNotHaveExactly(AssertionInfo info, Iterable<? extends E> actual, int times, Condition<? super E> condition) An alias method ofassertAreNotExactly(AssertionInfo, Iterable, int, Condition)
to provide a richer fluent api (same logic, only error message differs). -
assertContainsAll
Asserts that the givenIterable
contains all the elements of the otherIterable
, in any order.- Parameters:
info
- contains information about the assertion.actual
- the givenIterable
.other
- the otherIterable
.- Throws:
NullPointerException
- ifIterable
isnull
.AssertionError
- if the givenIterable
isnull
.AssertionError
- if the givenIterable
does not contain all the elements of the otherIterable
, in any order.
-
assertContainsExactly
Asserts that the givenIterable
contains exactly the given values and nothing else, in order.- Parameters:
info
- contains information about the assertion.actual
- the givenIterable
.values
- the values that are expected to be in the givenIterable
in order.- Throws:
NullPointerException
- if the array of values isnull
.IllegalArgumentException
- if the array of values is empty.AssertionError
- if the givenIterable
isnull
.AssertionError
- if the givenIterable
does not contain the given values or if the givenIterable
contains values that are not in the given array, in order.
-
iterableToLookForIsNull
-
iterableToLookForIsEmpty
-