/**
* Assertion methods for arrays of {@code double}s.
*
* <p>To create an instance of this class, invoke <code>{@link Assertions#assertThat(double[])}
* </code>.
*
* @author Yvonne Wang
* @author Alex Ruiz
* @author Joel Costigliola
*/
public class DoubleArrayAssert extends AbstractAssert<DoubleArrayAssert, double[]>
implements EnumerableAssert<DoubleArrayAssert>, ArraySortedAssert<DoubleArrayAssert, Double> {
@VisibleForTesting DoubleArrays arrays = DoubleArrays.instance();
protected DoubleArrayAssert(double[] actual) {
super(actual, DoubleArrayAssert.class);
}
/** {@inheritDoc} */
public void isNullOrEmpty() {
arrays.assertNullOrEmpty(info, actual);
}
/** {@inheritDoc} */
public void isEmpty() {
arrays.assertEmpty(info, actual);
}
/** {@inheritDoc} */
public DoubleArrayAssert isNotEmpty() {
arrays.assertNotEmpty(info, actual);
return this;
}
/** {@inheritDoc} */
public DoubleArrayAssert hasSize(int expected) {
arrays.assertHasSize(info, actual, expected);
return this;
}
/**
* Verifies that the actual array contains the given values, in any order.
*
* @param values the given values.
* @return {@code this} assertion object.
* @throws NullPointerException if the given argument is {@code null}.
* @throws IllegalArgumentException if the given argument is an empty array.
* @throws AssertionError if the actual array is {@code null}.
* @throws AssertionError if the actual array does not contain the given values.
*/
public DoubleArrayAssert contains(double... values) {
arrays.assertContains(info, actual, values);
return this;
}
/**
* Verifies that the actual array contains only the given values and nothing else, in any order.
*
* @param values the given values.
* @return {@code this} assertion object.
* @throws NullPointerException if the given argument is {@code null}.
* @throws IllegalArgumentException if the given argument is an empty array.
* @throws AssertionError if the actual array is {@code null}.
* @throws AssertionError if the actual array does not contain the given values, i.e. the actual
* array contains some or none of the given values, or the actual array contains more values
* than the given ones.
*/
public DoubleArrayAssert containsOnly(double... values) {
arrays.assertContainsOnly(info, actual, values);
return this;
}
/**
* Verifies that the actual array contains the given sequence, without any other values between
* them.
*
* @param sequence the sequence of values to look for.
* @return this assertion object.
* @throws AssertionError if the actual array is {@code null}.
* @throws AssertionError if the given array is {@code null}.
* @throws AssertionError if the actual array does not contain the given sequence.
*/
public DoubleArrayAssert containsSequence(double... sequence) {
arrays.assertContainsSequence(info, actual, sequence);
return this;
}
/**
* Verifies that the actual array contains the given value at the given index.
*
* @param value the value to look for.
* @param index the index where the value should be stored in the actual array.
* @return this assertion object.
* @throws AssertionError if the actual 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 actual array.
* @throws AssertionError if the actual array does not contain the given value at the given index.
*/
public DoubleArrayAssert contains(double value, Index index) {
arrays.assertContains(info, actual, value, index);
return this;
}
/**
* Verifies that the actual array does not contain the given values.
*
* @param values the given values.
* @return {@code this} assertion object.
* @throws NullPointerException if the given argument is {@code null}.
* @throws IllegalArgumentException if the given argument is an empty array.
* @throws AssertionError if the actual array is {@code null}.
* @throws AssertionError if the actual array contains any of the given values.
*/
public DoubleArrayAssert doesNotContain(double... values) {
arrays.assertDoesNotContain(info, actual, values);
return this;
}
/**
* Verifies that the actual array does not contain the given value at the given index.
*
* @param value the value to look for.
* @param index the index where the value should be stored in the actual array.
* @return this assertion object.
* @throws AssertionError if the actual array is {@code null}.
* @throws NullPointerException if the given {@code Index} is {@code null}.
* @throws AssertionError if the actual array contains the given value at the given index.
*/
public DoubleArrayAssert doesNotContain(double value, Index index) {
arrays.assertDoesNotContain(info, actual, value, index);
return this;
}
/**
* Verifies that the actual array does not contain duplicates.
*
* @return {@code this} assertion object.
* @throws AssertionError if the actual array is {@code null}.
* @throws AssertionError if the actual array contains duplicates.
*/
public DoubleArrayAssert doesNotHaveDuplicates() {
arrays.assertDoesNotHaveDuplicates(info, actual);
return this;
}
/**
* Verifies that the actual array starts with the given sequence of values, without any other
* values between them. Similar to <code>{@link #containsSequence(double...)}</code>, but it also
* verifies that the first element in the sequence is also first element of the actual array.
*
* @param sequence the sequence of values to look for.
* @return this assertion object.
* @throws NullPointerException if the given argument is {@code null}.
* @throws IllegalArgumentException if the given argument is an empty array.
* @throws AssertionError if the actual array is {@code null}.
* @throws AssertionError if the actual array does not start with the given sequence.
*/
public DoubleArrayAssert startsWith(double... sequence) {
arrays.assertStartsWith(info, actual, sequence);
return this;
}
/**
* Verifies that the actual array ends with the given sequence of values, without any other values
* between them. Similar to <code>{@link #containsSequence(double...)}</code>, but it also
* verifies that the last element in the sequence is also last element of the actual array.
*
* @param sequence the sequence of values to look for.
* @return this assertion object.
* @throws NullPointerException if the given argument is {@code null}.
* @throws IllegalArgumentException if the given argument is an empty array.
* @throws AssertionError if the actual array is {@code null}.
* @throws AssertionError if the actual array does not end with the given sequence.
*/
public DoubleArrayAssert endsWith(double... sequence) {
arrays.assertEndsWith(info, actual, sequence);
return this;
}
/** {@inheritDoc} */
public DoubleArrayAssert isSorted() {
arrays.assertIsSorted(info, actual);
return this;
}
/** {@inheritDoc} */
public DoubleArrayAssert isSortedAccordingTo(Comparator<? extends Double> comparator) {
arrays.assertIsSortedAccordingToComparator(info, actual, comparator);
return this;
}
@Override
public DoubleArrayAssert usingComparator(Comparator<?> customComparator) {
super.usingComparator(customComparator);
this.arrays = new DoubleArrays(new ComparatorBasedComparisonStrategy(customComparator));
return myself;
}
@Override
public DoubleArrayAssert usingDefaultComparator() {
super.usingDefaultComparator();
this.arrays = DoubleArrays.instance();
return myself;
}
}
@Override
public DoubleArrayAssert usingDefaultComparator() {
super.usingDefaultComparator();
this.arrays = DoubleArrays.instance();
return myself;
}