Top Description Fields Constructors Methods
org.assertj.core.api

public Class Double2DArrayAssert

extends Abstract2DArrayAssert<Double2DArrayAssert, double[][], Double>
Class Inheritance
Static Imports
org.assertj.core.error.ShouldHaveSameSizeAs.shouldHaveSameSizeAs, .ShouldNotBeNull.shouldNotBeNull, .SubarraysShouldHaveSameSize.subarraysShouldHaveSameSize, org.assertj.core.error.array2d.Array2dElementShouldBeDeepEqual.elementShouldBeEqual

Assertion methods for two-dimensional arrays of doubles.

To create an instance of this class, invoke Assertions#assertThat(double[][]).

Author
Maciej Wajcht
Since
3.17.0

Field Summary

Modifier and TypeField and Description
protected Double2DArrays
private final Failures

Constructor Summary

AccessConstructor and Description
public
Double2DArrayAssert(double[][] actual)

Method Summary

Modifier and TypeMethod and Description
public Double2DArrayAssert

Returns:

this assertion object.
contains
(double[]
the value to look for.
value
,
Index
the index where the value should be stored in the actual double[][].
index
)

Verifies that the actual double[][] contains the given double[] at the given index.

public Double2DArrayAssert

Returns:

this assertion object.
doesNotContain
(double[]
the value to look for.
value
,
Index
the index where the value should be stored in the actual double[][].
index
)

Verifies that the actual double[][] does not contain the given double[] at the given index.

public Double2DArrayAssert

Returns:

this assertion object.
hasDimensions
(int
the expected number of values in first dimension of the actual double[][].
expectedFirstDimension
,
int
the expected number of values in second dimension of the actual double[][].
expectedSecondDimension
)

Implements org.assertj.core.api.Array2DAssert.hasDimensions.

Verifies that the actual double[][] has the given dimensions.
public Double2DArrayAssert

Returns:

this assertion object.
hasNumberOfRows
(int
the expected number of rows of the two-dimensional array.
expected
)

Implements org.assertj.core.api.Array2DAssert.hasNumberOfRows.

Verifies that the actual two-dimensional array has the given number of rows.
public Double2DArrayAssert

Returns:

this assertion object.
hasSameDimensionsAs
(Object
the array to compare dimensions with actual double[][].
array
)

Implements org.assertj.core.api.Array2DAssert.hasSameDimensionsAs.

Verifies that the actual double[][] has the same dimensions as the given array.
public Double2DArrayAssert

Returns:

this assertion object.
isDeepEqualTo
(double[][]
the given value to compare the actual value to.
expected
)

Implements abstract org.assertj.core.api.Abstract2DArrayAssert.isDeepEqualTo.

Verifies that the actual double[][] is deeply equal to the given one.
public void
isEmpty()

Implements org.assertj.core.api.Array2DAssert.isEmpty.

Verifies that the actual double[][] is empty, empty means the array has no elements, said otherwise it can have any number of rows but all rows must be empty.
public Double2DArrayAssert

Returns:

this assertion object.
isEqualTo
(Object
the given value to compare the actual double[][] to.
expected
)

Overrides org.assertj.core.api.AbstractAssert.isEqualTo.

Implements org.assertj.core.api.Assert.isEqualTo.

Verifies that the actual double[][] is equal to the given one.
public Double2DArrayAssert

Returns:

this assertion object.
isNotEmpty
()

Implements org.assertj.core.api.Array2DAssert.isNotEmpty.

Verifies that the actual double[][] is not empty, not empty means the array has at least one element.
public void
isNullOrEmpty()

Implements org.assertj.core.api.Array2DAssert.isNullOrEmpty.

Verifies that the actual double[][] is null or empty, empty means the array has no elements, said otherwise it can have any number of rows but all rows must be empty.

Field Detail

double2dArraysback to summary
protected Double2DArrays double2dArrays
Annotations
@VisibleForTesting
failuresback to summary
private final Failures failures

Constructor Detail

Double2DArrayAssertback to summary
public Double2DArrayAssert(double[][] actual)

Method Detail

containsback to summary
public Double2DArrayAssert contains(double[] value, Index index)

Verifies that the actual double[][] contains the given double[] at the given index.

Example:

 double[][] values = new double[][] {{1.0, 2.0}, {3.0, 4.0}, {5.0, 6.0}};

// assertion will pass
assertThat(values).contains(new double[] {1.0, 2.0}, atIndex(0))
                  .contains(new double[] {5.0, 6.0}, atIndex(2));

// assertions will fail
assertThat(values).contains(new double[] {1.0, 2.0}, atIndex(1));
assertThat(values).contains(new double[] {6.0, 10.0}, atIndex(2));
Parameters
value:double[]

the value to look for.

index:Index

the index where the value should be stored in the actual double[][].

Returns:Double2DArrayAssert

this assertion object.

Exceptions
AssertionError:
  • if the actual double[][] is null or empty.
  • if the actual double[][] does not contain the given value at the given index.
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 double[][].
doesNotContainback to summary
public Double2DArrayAssert doesNotContain(double[] value, Index index)

Verifies that the actual double[][] does not contain the given double[] at the given index.

Example:

 double[][] values = new double[][] {{1.0, 2.0}, {3.0, 4.0}, {5.0, 6.0}};

// assertion will pass
assertThat(values).doesNotContain(new double[] {1.0, 2.0}, atIndex(1))
                  .doesNotContain(new double[] {3.0, 4.0}, atIndex(0));

// assertion will fail
assertThat(values).doesNotContain(new double[] {1.0, 2.0}, atIndex(0));
Parameters
value:double[]

the value to look for.

index:Index

the index where the value should be stored in the actual double[][].

Returns:Double2DArrayAssert

this assertion object.

Exceptions
AssertionError:
  • if the actual double[][] is null.
  • if the actual double[][] contains the given value at the given index.
NullPointerException:
if the given Index is null.
hasDimensionsback to summary
public Double2DArrayAssert hasDimensions(int expectedFirstDimension, int expectedSecondDimension)

Implements org.assertj.core.api.Array2DAssert.hasDimensions.

Verifies that the actual double[][] has the given dimensions.

Example:

 // assertion will pass
assertThat(new double[][] {{1.0, 2.0, 3.0}, {4.0, 5.0, 6.0}}).hasDimensions(2, 3);

// assertions will fail
assertThat(new double[][] { }).hasSize(1, 1);
assertThat(new double[][] {{1.0, 2.0, 3.0}, {4.0, 5.0, 6.0}}).hasDimensions(3, 2);
assertThat(new double[][] {{1.0, 2.0, 3.0}, {4.0, 5.0, 6.0, 7.0}}).hasDimensions(2, 3); 
Parameters
expectedFirstDimension:int

the expected number of values in first dimension of the actual double[][].

expectedSecondDimension:int

the expected number of values in second dimension of the actual double[][].

Returns:Double2DArrayAssert

this assertion object.

Annotations
@Override
Exceptions
AssertionError:
if the actual double[][]'s dimensions are not equal to the given ones.
hasNumberOfRowsback to summary
public Double2DArrayAssert hasNumberOfRows(int expected)

Implements org.assertj.core.api.Array2DAssert.hasNumberOfRows.

Verifies that the actual two-dimensional array has the given number of rows.

Example:

 // assertion will pass
assertThat(new double[][] {{1.0, 2.0, 3.0}, {4.0, 5.0, 6.0}}).hasNumberOfRows(2);
assertThat(new double[][] {{1.0}, {1.0, 2.0}, {1.0, 2.0, 3.0}}).hasNumberOfRows(3);

// assertions will fail
assertThat(new double[][] { }).hasNumberOfRows(1);
assertThat(new double[][] {{1.0, 2.0, 3.0}, {4.0, 5.0, 6.0}}).hasNumberOfRows(3);
assertThat(new double[][] {{1.0, 2.0, 3.0}, {4.0, 5.0, 6.0, 7.0}}).hasNumberOfRows(1); 
Parameters
expected:int

the expected number of rows of the two-dimensional array.

Returns:Double2DArrayAssert

this assertion object.

Annotations
@Override
Exceptions
AssertionError:
if the actual number of rows are not equal to the given one.
hasSameDimensionsAsback to summary
public Double2DArrayAssert hasSameDimensionsAs(Object array)

Implements org.assertj.core.api.Array2DAssert.hasSameDimensionsAs.

Verifies that the actual double[][] has the same dimensions as the given array.

Parameter is declared as Object to accept both Object and primitive arrays.

Example:
 double[][] doubleArray = {{1.0, 2.0, 3.0}, {4.0, 5.0, 6.0}};
char[][] charArray = {{'a', 'b', 'c'}, {'d', 'e', 'f'}};

// assertion will pass
assertThat(doubleArray).hasSameDimensionsAs(charArray);

// assertions will fail
assertThat(doubleArray).hasSameDimensionsAs(new char[][] {{'a', 'b'}, {'c', 'd'}, {'e', 'f'}});
assertThat(doubleArray).hasSameDimensionsAs(new char[][] {{'a', 'b'}, {'c', 'd', 'e'}});
assertThat(doubleArray).hasSameDimensionsAs(new char[][] {{'a', 'b', 'c'}, {'d', 'e'}});
Parameters
array:Object

the array to compare dimensions with actual double[][].

Returns:Double2DArrayAssert

this assertion object.

Annotations
@Override
Exceptions
AssertionError:
  • if the actual double[][] is null.
  • if the array parameter is null or is not a true array.
  • if actual double[][] and given array don't have the same dimensions.
isDeepEqualToback to summary
public Double2DArrayAssert isDeepEqualTo(double[][] expected)

Implements abstract org.assertj.core.api.Abstract2DArrayAssert.isDeepEqualTo.

Verifies that the actual double[][] is deeply equal to the given one.

Two arrays are considered deeply equal if both are null or if they refer to arrays that contain the same number of elements and all corresponding pairs of elements in the two arrays are deeply equal.

Example:

 // assertion will pass
assertThat(new double[][] {{1.0, 2.0}, {3.0, 4.0}}).isDeepEqualTo(new double[][] {{1.0, 2.0}, {3.0, 4.0}});

// assertions will fail
assertThat(new double[][] {{1.0, 2.0}, {3.0, 4.0}}).isDeepEqualTo(new double[][] {{1.0, 2.0}, {9.0, 10.0}});
assertThat(new double[][] {{1.0, 2.0}, {3.0, 4.0}}).isDeepEqualTo(new double[][] {{1.0, 2.0, 3.0}, {4.0}});
Parameters
expected:double[][]

the given value to compare the actual value to.

Returns:Double2DArrayAssert

this assertion object.

Annotations
@Override
Exceptions
AssertionError:
if the actual value is not deeply equal to the given one.
isEmptyback to summary
public void isEmpty()

Implements org.assertj.core.api.Array2DAssert.isEmpty.

Verifies that the actual double[][] is empty, empty means the array has no elements, said otherwise it can have any number of rows but all rows must be empty.

Example:

 // assertions will pass
assertThat(new double[][] {{}}).isEmpty();
// this is considered empty as there are no elements in the 2d array which is comprised of 3 empty rows.
assertThat(new double[][] {{ }, { }, { }}).isEmpty();

// assertions will fail
assertThat(new double[][] {{ 1.0 }, { 2.0 }}).isEmpty();
double[][] array = null;
assertThat(array).isEmpty();
Annotations
@Override
Exceptions
AssertionError:
if the actual double[][] is not empty.
isEqualToback to summary
public Double2DArrayAssert isEqualTo(Object expected)

Overrides org.assertj.core.api.AbstractAssert.isEqualTo.

Implements org.assertj.core.api.Assert.isEqualTo.

Verifies that the actual double[][] is equal to the given one.

Warning

This method will use equals to compare (it will compare arrays references only).
Unless you specify a comparator with usingComparator(Comparator), it is advised to use isDeepEqualTo(double[][]) instead.

Example:

 double[][] array = {{1.0, 2.0}, {3.0, 4.0}};

// assertion will pass
assertThat(array).isEqualTo(array);

// assertion will fail as isEqualTo calls equals which compares arrays references only.
assertThat(array).isEqualTo(new double[][] {{1.0, 2.0}, {3.0, 4.0}});
Parameters
expected:Object

the given value to compare the actual double[][] to.

Returns:Double2DArrayAssert

this assertion object.

Annotations
@Override
Exceptions
AssertionError:
if the actual double[][] is not equal to the given one.
isNotEmptyback to summary
public Double2DArrayAssert isNotEmpty()

Implements org.assertj.core.api.Array2DAssert.isNotEmpty.

Verifies that the actual double[][] is not empty, not empty means the array has at least one element.

Example:

 // assertions will pass
assertThat(new double[][] {{ 1.0 }, { 2.0 }}).isNotEmpty();
assertThat(new double[][] {{ }, { 2.0 }}).isNotEmpty();

// assertions will fail
assertThat(new double[][] { }).isNotEmpty();
assertThat(new double[][] {{ }}).isNotEmpty();
// this is considered empty as there are no elements in the 2d array which is comprised of 3 empty rows.
assertThat(new double[][] {{ }, { }, { }}).isNotEmpty();
double[][] array = null;
assertThat(array).isNotEmpty();
Returns:Double2DArrayAssert

this assertion object.

Annotations
@Override
Exceptions
AssertionError:
if the actual double[][] is empty or null.
isNullOrEmptyback to summary
public void isNullOrEmpty()

Implements org.assertj.core.api.Array2DAssert.isNullOrEmpty.

Verifies that the actual double[][] is null or empty, empty means the array has no elements, said otherwise it can have any number of rows but all rows must be empty.

Example:

 // assertions will pass
double[][] array = null;
assertThat(array).isNullOrEmpty();
assertThat(new double[][] { }).isNullOrEmpty();
assertThat(new double[][] {{ }}).isNullOrEmpty();
// this is considered empty as there are no elements in the 2d array which is comprised of 3 empty rows.
assertThat(new double[][] {{ }, { }, { }}).isNullOrEmpty();

// assertion will fail
assertThat(new double[][] {{ 1.0 }, { 2.0 }}).isNullOrEmpty();
Annotations
@Override
Exceptions
AssertionError:
if the actual double[][] is not null or not empty.