com.fitbur.assertj.internal.ObjectArrays Maven / Gradle / Ivy
/**
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
* an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
* specific language governing permissions and limitations under the License.
*
* Copyright 2012-2016 the original author or authors.
*/
package com.fitbur.assertj.internal;
import static com.fitbur.assertj.error.ShouldHaveAtLeastOneElementOfType.shouldHaveAtLeastOneElementOfType;
import static com.fitbur.assertj.error.ShouldHaveOnlyElementsOfType.shouldHaveOnlyElementsOfType;
import static com.fitbur.assertj.internal.CommonValidations.checkIsNotNullAndNotEmpty;
import static com.fitbur.assertj.util.Lists.newArrayList;
import java.util.Comparator;
import java.util.List;
import com.fitbur.assertj.api.ArraySortedAssert;
import com.fitbur.assertj.api.AssertionInfo;
import com.fitbur.assertj.api.Condition;
import com.fitbur.assertj.data.Index;
import com.fitbur.assertj.util.VisibleForTesting;
/**
* Reusable assertions for arrays of objects.
*
* @author Alex Ruiz
* @author Joel Costigliola
* @author Nicolas François
* @author Mikhail Mazursky
*/
public class ObjectArrays {
private static final ObjectArrays INSTANCE = new ObjectArrays();
/**
* Returns the singleton instance of this class.
*
* @return the singleton instance of this class.
*/
public static ObjectArrays instance() {
return INSTANCE;
}
private Arrays arrays = Arrays.instance();
@VisibleForTesting
ObjectArrays() {
this(StandardComparisonStrategy.instance());
}
public ObjectArrays(ComparisonStrategy comparisonStrategy) {
this.arrays = new Arrays(comparisonStrategy);
}
@VisibleForTesting
public Comparator getComparator() {
return arrays.getComparator();
}
@VisibleForTesting
public ComparisonStrategy getComparisonStrategy() {
return arrays.getComparisonStrategy();
}
@VisibleForTesting
Failures failures = Failures.instance();
@VisibleForTesting
Conditions conditions = Conditions.instance();
/**
* Asserts that the given array is {@code null} or empty.
*
* @param info contains information about the assertion.
* @param actual the given array.
* @throws AssertionError if the given array is not {@code null} *and* contains one or more elements.
*/
public void assertNullOrEmpty(AssertionInfo info, Object[] actual) {
arrays.assertNullOrEmpty(info, failures, actual);
}
/**
* Asserts that the given array is empty.
*
* @param info contains information about the assertion.
* @param actual the given array.
* @throws AssertionError if the given array is {@code null}.
* @throws AssertionError if the given array is not empty.
*/
public void assertEmpty(AssertionInfo info, Object[] actual) {
arrays.assertEmpty(info, failures, actual);
}
/**
* Asserts that the given array is not empty.
*
* @param info contains information about the assertion.
* @param actual the given array.
* @throws AssertionError if the given array is {@code null}.
* @throws AssertionError if the given array is empty.
*/
public void assertNotEmpty(AssertionInfo info, Object[] actual) {
arrays.assertNotEmpty(info, failures, actual);
}
/**
* Asserts that the number of elements in the given array is equal to the expected one.
*
* @param info contains information about the assertion.
* @param actual the given array.
* @param expectedSize the expected size of {@code actual}.
* @throws AssertionError if the given array is {@code null}.
* @throws AssertionError if the number of elements in the given array is different than the expected one.
*/
public void assertHasSize(AssertionInfo info, Object[] actual, int expectedSize) {
arrays.assertHasSize(info, failures, actual, expectedSize);
}
/**
* Assert that the actual array has the same size as the other {@code Iterable}.
*
* @param info contains information about the assertion.
* @param actual the given iterable.
* @param other the group to compare
* @throws AssertionError if the actual group is {@code null}.
* @throws AssertionError if the other group is {@code null}.
* @throws AssertionError if the actual group does not have the same size.
*/
public void assertHasSameSizeAs(AssertionInfo info, Object[] actual, Iterable other) {
arrays.assertHasSameSizeAs(info, actual, other);
}
/**
* Assert that the actual array has the same size as the other array.
*
* @param info contains information about the assertion.
* @param actual the given array.
* @param other the group to compare
* @throws AssertionError if the actual group is {@code null}.
* @throws AssertionError if the other group is {@code null}.
* @throws AssertionError if the actual group does not have the same size.
*/
public void assertHasSameSizeAs(AssertionInfo info, Object[] actual, Object other) {
arrays.assertHasSameSizeAs(info, actual, other);
}
/**
* Asserts that the given array contains the given values, in any order.
*
* @param info contains information about the assertion.
* @param actual the given array.
* @param values the values that are expected to be in the given array.
* @throws NullPointerException if the array of values is {@code null}.
* @throws IllegalArgumentException if the array of values is empty.
* @throws AssertionError if the given array is {@code null}.
* @throws AssertionError if the given array does not contain the given values.
*/
public void assertContains(AssertionInfo info, Object[] actual, Object[] values) {
arrays.assertContains(info, failures, actual, values);
}
/**
* Verifies that the given array contains the given object at the given index.
*
* @param info contains information about the assertion.
* @param actual the given array.
* @param value the object to look for.
* @param index the index where the object should be stored in the given array.
* @throws AssertionError if the given array is {@code null} or empty.
* @throws NullPointerException if the given {@code Index} is {@code null}.
* @throws IndexOutOfBoundsException if the value of the given {@code Index} is equal to or greater than the size of
* the given array.
* @throws AssertionError if the given array does not contain the given object at the given index.
*/
public void assertContains(AssertionInfo info, Object[] actual, Object value, Index index) {
arrays.assertContains(info, failures, actual, value, index);
}
/**
* Verifies that the given array does not contain the given object at the given index.
*
* @param info contains information about the assertion.
* @param actual the given array.
* @param value the object to look for.
* @param index the index where the object should be stored in the given array.
* @throws AssertionError if the given array is {@code null}.
* @throws NullPointerException if the given {@code Index} is {@code null}.
* @throws AssertionError if the given array contains the given object at the given index.
*/
public void assertDoesNotContain(AssertionInfo info, Object[] actual, Object value, Index index) {
arrays.assertDoesNotContain(info, failures, actual, value, index);
}
/**
* Asserts that the given array contains only the given values and nothing else, in any order.
*
* @param info contains information about the assertion.
* @param actual the given array.
* @param values the values that are expected to be in the given array.
* @throws NullPointerException if the array of values is {@code null}.
* @throws IllegalArgumentException if the array of values is empty.
* @throws AssertionError if the given array is {@code null}.
* @throws AssertionError if the given array does not contain the given values or if the given array contains values
* that are not in the given array.
*/
public void assertContainsOnly(AssertionInfo info, Object[] actual, Object[] values) {
arrays.assertContainsOnly(info, failures, actual, values);
}
public void assertContainsExactly(AssertionInfo info, Object[] actual, Object[] values) {
arrays.assertContainsExactly(info, failures, actual, values);
}
public void assertContainsExactlyInAnyOrder(AssertionInfo info, Object[] actual, Object[] values) {
arrays.assertContainsExactlyInAnyOrder(info, failures, actual, values);
}
/**
* Asserts that the given array contains only once the given values.
*
* @param info contains information about the assertion.
* @param actual the given array.
* @param values the values that are expected to be in the given array.
* @throws NullPointerException if the array of values is {@code null}.
* @throws IllegalArgumentException if the array of values is empty.
* @throws AssertionError if the given array is {@code null}.
* @throws AssertionError if the given array does not contain the given values or if the given array contains values
* that are not in the given array.
*/
public void assertContainsOnlyOnce(AssertionInfo info, Object[] actual, Object[] values) {
arrays.assertContainsOnlyOnce(info, failures, actual, values);
}
/**
* Verifies that the given array contains the given sequence of objects, without any other objects between them.
*
* @param info contains information about the assertion.
* @param actual the given array.
* @param sequence the sequence of objects to look for.
* @throws AssertionError if the given array is {@code null}.
* @throws NullPointerException if the given sequence is {@code null}.
* @throws IllegalArgumentException if the given sequence is empty.
* @throws AssertionError if the given array does not contain the given sequence of objects.
*/
public void assertContainsSequence(AssertionInfo info, Object[] actual, Object[] sequence) {
arrays.assertContainsSequence(info, failures, actual, sequence);
}
/**
* Verifies that the given array contains the given subsequence of objects (possibly with other values between them).
*
* @param info contains information about the assertion.
* @param actual the given array.
* @param subsequence the subsequence of objects to look for.
* @throws AssertionError if the given array is {@code null}.
* @throws NullPointerException if the given subsequence is {@code null}.
* @throws IllegalArgumentException if the given subsequence is empty.
* @throws AssertionError if the given array does not contain the given subsequence of objects.
*/
public void assertContainsSubsequence(AssertionInfo info, Object[] actual, Object[] subsequence) {
arrays.assertContainsSubsequence(info, failures, actual, subsequence);
}
/**
* Asserts that the given array does not contain the given values.
*
* @param info contains information about the assertion.
* @param actual the given array.
* @param values the values that are expected not to be in the given array.
* @throws NullPointerException if the array of values is {@code null}.
* @throws IllegalArgumentException if the array of values is empty.
* @throws AssertionError if the given array is {@code null}.
* @throws AssertionError if the given array contains any of given values.
*/
public void assertDoesNotContain(AssertionInfo info, Object[] actual, Object[] values) {
arrays.assertDoesNotContain(info, failures, actual, values);
}
public void assertDoesNotContainAnyElementsOf(AssertionInfo info, Object[] actual, Iterable iterable) {
checkIsNotNullAndNotEmpty(iterable);
List values = newArrayList(iterable);
assertDoesNotContain(info, actual, values.toArray());
}
/**
* Asserts that the given array does not have duplicate values.
*
* @param info contains information about the assertion.
* @param actual the given array.
* @throws NullPointerException if the array of values is {@code null}.
* @throws IllegalArgumentException if the array of values is empty.
* @throws AssertionError if the given array is {@code null}.
* @throws AssertionError if the given array contains duplicate values.
*/
public void assertDoesNotHaveDuplicates(AssertionInfo info, Object[] actual) {
arrays.assertDoesNotHaveDuplicates(info, failures, actual);
}
/**
* Verifies that the given array starts with the given sequence of objects, without any other objects between them.
* Similar to {@link #assertContainsSequence(AssertionInfo, Object[], Object[])}, but it also verifies
* that the first element in the sequence is also the first element of the given array.
*
* @param info contains information about the assertion.
* @param actual the given array.
* @param sequence the sequence of objects to look for.
* @throws NullPointerException if the given argument is {@code null}.
* @throws IllegalArgumentException if the given argument is an empty array.
* @throws AssertionError if the given array is {@code null}.
* @throws AssertionError if the given array does not start with the given sequence of objects.
*/
public void assertStartsWith(AssertionInfo info, Object[] actual, Object[] sequence) {
arrays.assertStartsWith(info, failures, actual, sequence);
}
/**
* Verifies that the given array ends with the given sequence of objects, without any other objects between them.
* Similar to {@link #assertContainsSequence(AssertionInfo, Object[], Object[])}, but it also verifies
* that the last element in the sequence is also the last element of the given array.
*
* @param info contains information about the assertion.
* @param actual the given array.
* @param sequence the sequence of objects to look for.
* @throws NullPointerException if the given argument is {@code null}.
* @throws IllegalArgumentException if the given argument is an empty array.
* @throws AssertionError if the given array is {@code null}.
* @throws AssertionError if the given array does not end with the given sequence of objects.
*/
public void assertEndsWith(AssertionInfo info, Object[] actual, Object[] sequence) {
arrays.assertEndsWith(info, failures, actual, sequence);
}
public void assertIsSubsetOf(AssertionInfo info, Object actual, Iterable values) {
arrays.assertIsSubsetOf(info, failures, actual, values);
}
/**
* Asserts that the given array contains at least a null element.
*
* @param info contains information about the assertion.
* @param actual the given array.
* @throws AssertionError if the given array is {@code null}.
* @throws AssertionError if the given array does not contain a null element.
*/
public void assertContainsNull(AssertionInfo info, Object[] actual) {
arrays.assertContainsNull(info, failures, actual);
}
/**
* Asserts that the given array does not contain null elements.
*
* @param info contains information about the assertion.
* @param actual the given array.
* @throws AssertionError if the given array is {@code null}.
* @throws AssertionError if the given array contains a null element.
*/
public void assertDoesNotContainNull(AssertionInfo info, Object[] actual) {
arrays.assertDoesNotContainNull(info, failures, actual);
}
/**
* Assert that each element of given array satisfies the given condition.
*
* @param info contains information about the assertion.
* @param actual the given array.
* @param condition the given {@code Condition}.
* @throws NullPointerException if the given condition is {@code null}.
* @throws AssertionError if one or more elements do not satisfy the given condition.
*/
public void assertAre(AssertionInfo info, E[] actual, Condition condition) {
arrays.assertAre(info, failures, conditions, actual, condition);
}
/**
* Assert that each element of given array not satisfies the given condition.
*
* @param info contains information about the assertion.
* @param actual the given array.
* @param condition the given {@code Condition}.
* @throws NullPointerException if the given condition is {@code null}.
* @throws AssertionError if one or more elements satisfy the given condition.
*/
public void assertAreNot(AssertionInfo info, E[] actual, Condition condition) {
arrays.assertAreNot(info, failures, conditions, actual, condition);
}
/**
* Assert that each element of given array satisfies the given condition.
*
* @param info contains information about the assertion.
* @param actual the given array.
* @param condition the given {@code Condition}.
* @throws NullPointerException if the given condition is {@code null}.
* @throws AssertionError if one or more elements do not satisfy the given condition.
*/
public void assertHave(AssertionInfo info, E[] actual, Condition condition) {
arrays.assertHave(info, failures, conditions, actual, condition);
}
/**
* Assert that each element of given array not satisfies the given condition.
*
* @param info contains information about the assertion.
* @param actual the given array.
* @param condition the given {@code Condition}.
* @throws NullPointerException if the given condition is {@code null}.
* @throws AssertionError if one or more elements satisfy the given condition.
*/
public void assertDoNotHave(AssertionInfo info, E[] actual, Condition condition) {
arrays.assertHaveNot(info, failures, conditions, actual, condition);
}
/**
* Assert that there is at least n array elements satisfying the given condition.
*
* @param info contains information about the assertion.
* @param actual the given array.
* @param n the minimum number of times the condition should be verified.
* @param condition the given {@code Condition}.
* @throws NullPointerException if the given condition is {@code null}.
* @throws AssertionError if the number of elements satisfying the given condition is < n.
*/
public void assertAreAtLeast(AssertionInfo info, E[] actual, int n, Condition condition) {
arrays.assertAreAtLeast(info, failures, conditions, actual, n, condition);
}
/**
* Assert that there is at most n array elements satisfying the given condition.
*
* @param info contains information about the assertion.
* @param actual the given array.
* @param n the number of times the condition should be at most verified.
* @param condition the given {@code Condition}.
* @throws NullPointerException if the given condition is {@code null}.
* @throws AssertionError if the number of elements satisfying the given condition is > n.
*/
public void assertAreAtMost(AssertionInfo info, E[] actual, int n, Condition condition) {
arrays.assertAreAtMost(info, failures, conditions, actual, n, condition);
}
/**
* Verifies that there is exactly n array elements satisfying the given condition.
*
* @param info contains information about the assertion.
* @param actual the given array.
* @param n the exact number of times the condition should be verified.
* @param condition the given {@code Condition}.
* @throws NullPointerException if the given condition is {@code null}.
* @throws AssertionError if the number of elements satisfying the given condition is ≠ n.
*/
public void assertAreExactly(AssertionInfo info, E[] actual, int n, Condition condition) {
arrays.assertAreExactly(info, failures, conditions, actual, n, condition);
}
/**
* An alias method of {@link #assertAreAtLeast(AssertionInfo, Object[], int, Condition)} to provide a richer fluent
* api (same logic, only error message differs).
*/
public void assertHaveAtLeast(AssertionInfo info, E[] actual, int times, Condition condition) {
arrays.assertHaveAtLeast(info, failures, conditions, actual, times, condition);
}
/**
* An alias method of {@link #assertAreAtMost(AssertionInfo, Object[], int, Condition)} to provide a richer fluent api
* (same logic, only error message differs).
*/
public void assertHaveAtMost(AssertionInfo info, E[] actual, int times, Condition condition) {
arrays.assertHaveAtMost(info, failures, conditions, actual, times, condition);
}
/**
* An alias method of {@link #assertAreExactly(AssertionInfo, Object[], int, Condition)} to provide a richer fluent
* api (same logic, only error message differs).
*/
public void assertHaveExactly(AssertionInfo info, E[] actual, int times, Condition condition) {
arrays.assertHaveExactly(info, failures, conditions, actual, times, condition);
}
public void assertHasAtLeastOneElementOfType(AssertionInfo info, E[] actual, Class type) {
Objects.instance().assertNotNull(info, actual);
boolean found = false;
for (Object o : actual) {
if (!type.isInstance(o)) continue;
found = true;
break;
}
if (!found) throw failures.failure(info, shouldHaveAtLeastOneElementOfType(actual, type));
}
public void assertHasOnlyElementsOfType(AssertionInfo info, E[] actual, Class type) {
Objects.instance().assertNotNull(info, actual);
for (Object o : actual) {
if (!type.isInstance(o)) throw failures.failure(info, shouldHaveOnlyElementsOfType(actual, type, o.getClass()));
}
}
/**
* Concrete implementation of {@link ArraySortedAssert#isSorted()}.
*
* @param info contains information about the assertion.
* @param actual the given array.
*/
public void assertIsSorted(AssertionInfo info, Object[] actual) {
arrays.assertIsSorted(info, failures, actual);
}
/**
* Concrete implementation of {@link ArraySortedAssert#isSortedAccordingTo(Comparator)}.
*
* @param info contains information about the assertion.
* @param actual the given array.
* @param comparator the {@link Comparator} used to compare array elements
*/
public void assertIsSortedAccordingToComparator(AssertionInfo info, E[] actual, Comparator comparator) {
Arrays.assertIsSortedAccordingToComparator(info, failures, actual, comparator);
}
/**
* Asserts that the given array contains all the elements of the given {@code Iterable}, in any order.
*
* @param info contains information about the assertion.
* @param actual the given array.
* @param other the other {@code Iterable}.
* @throws NullPointerException if {@code Iterable} is {@code null}.
* @throws AssertionError if the given {@code Iterable} is {@code null}.
* @throws AssertionError if the given {@code Iterable} does not contain all the elements of the other
* {@code Iterable}, in any order.
*/
public void assertContainsAll(AssertionInfo info, E[] actual, Iterable other) {
arrays.assertcontainsAll(info, failures, actual, other);
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy