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

public Class Int2DArrayAssert

extends Abstract2DArrayAssert<Int2DArrayAssert, int[][], Integer>
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 ints.

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

Author
Maciej Wajcht
Since
3.17.0

Field Summary

Modifier and TypeField and Description
private final Failures
protected Int2DArrays

Constructor Summary

AccessConstructor and Description
public
Int2DArrayAssert(int[][] actual)

Method Summary

Modifier and TypeMethod and Description
public Int2DArrayAssert

Returns:

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

Verifies that the actual array contains the given int[] at the given index.

public Int2DArrayAssert

Returns:

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

Verifies that the actual array does not contain the given value at the given index.

public Int2DArrayAssert
hasDimensions(int
the expected number of values in first dimension of the actual array.
expectedFirstDimension
,
int
the expected number of values in second dimension of the actual array.
expectedSecondDimension
)

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

Verifies that the actual 2D array has the given dimensions.
public Int2DArrayAssert

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 Int2DArrayAssert

Returns:

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

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

Verifies that the actual int[][] has the same dimensions as the given array.
public Int2DArrayAssert
isDeepEqualTo(int[][]
the given value to compare the actual value to.
expected
)

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

Verifies that the actual 2D array is deeply equal to the given one.
public void
isEmpty()

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

Verifies that the actual array 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 Int2DArrayAssert

Returns:

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

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

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

Verifies that the actual int[][] is equal to the given one.
public Int2DArrayAssert
isNotEmpty()

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

Verifies that the actual array 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 array 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

failuresback to summary
private final Failures failures
int2dArraysback to summary
protected Int2DArrays int2dArrays
Annotations
@VisibleForTesting

Constructor Detail

Int2DArrayAssertback to summary
public Int2DArrayAssert(int[][] actual)

Method Detail

containsback to summary
public Int2DArrayAssert contains(int[] value, Index index)

Verifies that the actual array contains the given int[] at the given index.

Example:

 // assertion will pass
assertThat(new int[][] {{1, 2}, {3, 4}, {5, 6}}).contains(new int[] {3, 4}, atIndex(1));

// assertions will fail
assertThat(new int[][] {{1, 2}, {3, 4}, {5, 6}}).contains(new int[] {3, 4}, atIndex(0));
assertThat(new int[][] {{1, 2}, {3, 4}, {5, 6}}).contains(new int[] {7, 8}, atIndex(2));
Parameters
value:int[]

the value to look for.

index:Index

the index where the value should be stored in the actual array.

Returns:Int2DArrayAssert

myself assertion object.

Exceptions
AssertionError:
  • if the actual array is null or empty.
  • if the actual array 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 array.
doesNotContainback to summary
public Int2DArrayAssert doesNotContain(int[] value, Index index)

Verifies that the actual array does not contain the given value at the given index.

Example:

 // assertions will pass
assertThat(new int[][] {{1, 2}, {3, 4}, {5, 6}}).doesNotContain(new int[] {3, 4}, atIndex(0));
assertThat(new int[][] {{1, 2}, {3, 4}, {5, 6}}).doesNotContain(new int[] {7, 8}, atIndex(2));

// assertion will fail
assertThat(new int[][] {{1, 2}, {3, 4}, {5, 6}}).doesNotContain(new int[] {3, 4}, atIndex(1));
Parameters
value:int[]

the value to look for.

index:Index

the index where the value should be stored in the actual array.

Returns:Int2DArrayAssert

myself assertion object.

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

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

Doc from org.assertj.core.api.Array2DAssert.hasDimensions.

Verifies that the actual 2D array has the given dimensions.

Example:

 // assertion will pass
assertThat(new int[][] {{1, 2, 3}, {4, 5, 6}}).hasDimensions(2, 3);

// assertions will fail
assertThat(new int[][] { }).hasSize(1, 1);
assertThat(new int[][] {{1, 2, 3}, {4, 5, 6}}).hasDimensions(3, 2);
assertThat(new int[][] {{1, 2, 3}, {4, 5, 6, 7}}).hasDimensions(2, 3); 
Parameters
expectedFirstDimension:int

the expected number of values in first dimension of the actual array.

expectedSecondDimension:int

the expected number of values in second dimension of the actual array.

Returns:Int2DArrayAssert

this assertion object.

Annotations
@Override
hasNumberOfRowsback to summary
public Int2DArrayAssert 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 int[][] {{1, 2, 3}, {4, 5, 6}}).hasNumberOfRows(2);
assertThat(new int[][] {{1}, {1, 2}, {1, 2, 3}}).hasNumberOfRows(3);

// assertions will fail
assertThat(new int[][] { }).hasNumberOfRows(1);
assertThat(new int[][] {{1, 2, 3}, {4, 5, 6}}).hasNumberOfRows(3);
assertThat(new int[][] {{1, 2, 3}, {4, 5, 6, 7}}).hasNumberOfRows(1); 
Parameters
expected:int

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

Returns:Int2DArrayAssert

this assertion object.

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

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

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

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

Example:
 int[][] intArray = {{1, 2, 3}, {4, 5, 6}};
char[][] charArray = {{'a', 'b', 'c'}, {'d', 'e', 'f'}};

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

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

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

Returns:Int2DArrayAssert

this assertion object.

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

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

Doc from org.assertj.core.api.Abstract2DArrayAssert.isDeepEqualTo.

Verifies that the actual 2D array 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 int[][] {{1, 2}, {3, 4}}).isDeepEqualTo(new int[][] {{1, 2}, {3, 4}});

// assertions will fail
assertThat(new int[][] {{1, 2}, {3, 4}}).isDeepEqualTo(new int[][] {{1, 2}, {9, 10}});
assertThat(new int[][] {{1, 2}, {3, 4}}).isDeepEqualTo(new int[][] {{1, 2, 3}, {4}});
Parameters
expected:int[][]

the given value to compare the actual value to.

Returns:Int2DArrayAssert

this assertion object.

Annotations
@Override
isEmptyback to summary
public void isEmpty()

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

Doc from org.assertj.core.api.Array2DAssert.isEmpty.

Verifies that the actual array 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 int[][] {{}}).isEmpty();
// this is considered empty as there are no elements in the 2d array which is comprised of 3 empty rows.
assertThat(new int[][] {{ }, { }, { }}).isEmpty();

// assertions will fail
assertThat(new int[][] {{ 1 }, { 2 }}).isEmpty();
int[][] array = null;
assertThat(array).isEmpty();
Annotations
@Override
isEqualToback to summary
public Int2DArrayAssert isEqualTo(Object expected)

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

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

Verifies that the actual int[][] 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(int[][]) instead.

Example:

 int[][] array = {{1, 2}, {3, 4}};

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

// assertion will fail as isEqualTo calls equals which compares arrays references only.
assertThat(array).isEqualTo(new int[][] {{1, 2}, {3, 4}});
Parameters
expected:Object

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

Returns:Int2DArrayAssert

this assertion object.

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

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

Doc from org.assertj.core.api.Array2DAssert.isNotEmpty.

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

Example:

 // assertions will pass
assertThat(new int[][] {{ 1 }, { 2 }}).isNotEmpty();
assertThat(new int[][] {{ }, { 2 }}).isNotEmpty();

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

this assertion object.

Annotations
@Override
isNullOrEmptyback to summary
public void isNullOrEmpty()

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

Doc from org.assertj.core.api.Array2DAssert.isNullOrEmpty.

Verifies that the actual array 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
int[][] array = null;
assertThat(array).isNullOrEmpty();
assertThat(new int[][] { }).isNullOrEmpty();
assertThat(new int[][] {{ }}).isNullOrEmpty();
// this is considered empty as there are no elements in the 2d array which is comprised of 3 empty rows.
assertThat(new int[][] {{ }, { }, { }}).isNullOrEmpty();

// assertion will fail
assertThat(new int[][] {{ 1 }, { 2 }}).isNullOrEmpty();
Annotations
@Override