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

public Class Boolean2DArrayAssert

extends Abstract2DArrayAssert<Boolean2DArrayAssert, boolean[][], Boolean>
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 booleans.

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

Author
Maciej Wajcht
Since
3.17.0

Field Summary

Modifier and TypeField and Description
protected Boolean2DArrays
private final Failures

Constructor Summary

AccessConstructor and Description
public
Boolean2DArrayAssert(boolean[][] actual)

Method Summary

Modifier and TypeMethod and Description
public Boolean2DArrayAssert

Returns:

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

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

public Boolean2DArrayAssert

Returns:

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

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

public Boolean2DArrayAssert

Returns:

this assertion object.
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 Boolean2DArrayAssert

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 Boolean2DArrayAssert

Returns:

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

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

Verifies that the actual boolean[][] has the same dimensions as the given array.
public Boolean2DArrayAssert

Returns:

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

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

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

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

Verifies that the actual boolean[][]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 Boolean2DArrayAssert

Returns:

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

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

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

Verifies that the actual boolean[][] is equal to the given one.
public Boolean2DArrayAssert

Returns:

this assertion object.
isNotEmpty
()

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

Verifies that the actual boolean[][]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 boolean[][]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

boolean2dArraysback to summary
protected Boolean2DArrays boolean2dArrays
Annotations
@VisibleForTesting
failuresback to summary
private final Failures failures

Constructor Detail

Boolean2DArrayAssertback to summary
public Boolean2DArrayAssert(boolean[][] actual)

Method Detail

containsback to summary
public Boolean2DArrayAssert contains(boolean[] value, Index index)

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

Example:

 // assertion will pass
assertThat(new boolean[][] {{true, false}, {false, true}}).contains(new boolean[] {true, false}, info);

// assertion will fail
assertThat(new boolean[][] {{true, false}, {false, true}}).contains(new boolean[] {true, false}, atIndex(1));
Parameters
value:boolean[]

the value to look for.

index:Index

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

Returns:Boolean2DArrayAssert

myself assertion object.

Exceptions
AssertionError:
  • if the actual boolean[][]is null or empty.
  • if the actual boolean[][]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 Boolean2DArrayAssert doesNotContain(boolean[] value, Index index)

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

Example:

 // assertion will pass
assertThat(new boolean[][] {{true, false}, {false, true}}).doesNotContain(new boolean[] {true, false}, atIndex(1));

// assertion will fail
assertThat(new boolean[][] {{true, false}, {false, true}}).doesNotContain(new boolean[] {true, false}, atIndex(0));
Parameters
value:boolean[]

the value to look for.

index:Index

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

Returns:Boolean2DArrayAssert

myself assertion object.

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

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

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

Example:

 // assertion will pass
assertThat(new boolean[][] {{true, true, true}, {false, false, false}}).hasDimensions(2, 3);

// assertions will fail
assertThat(new boolean[][] { }).hasSize(1, 1);
assertThat(new boolean[][] {{true, true, true}, {false, false, false}}).hasDimensions(3, 2);
assertThat(new boolean[][] {{true, true, true}, {false, false, false, false}}).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:Boolean2DArrayAssert

this assertion object.

Annotations
@Override
Exceptions
AssertionError:
if the actual array's dimensions are not equal to the given ones.
hasNumberOfRowsback to summary
public Boolean2DArrayAssert 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 boolean[][] {{true, true, true}, {false, false, false}}).hasNumberOfRows(2);
assertThat(new boolean[][] {{true}, {true, false}, {true, false, false}}).hasNumberOfRows(3);

// assertions will fail
assertThat(new boolean[][] { }).hasNumberOfRows(1);
assertThat(new boolean[][] {{true, true, true}, {false, false, false}}).hasNumberOfRows(3);
assertThat(new boolean[][] {{true, true, true}, {false, false, false, false}}).hasNumberOfRows(1); 
Parameters
expected:int

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

Returns:Boolean2DArrayAssert

this assertion object.

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

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

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

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

Example:
 boolean[][] booleanArray = {{true, true, false}, {false, false, true}};
char[][] charArray = {{'a', 'b', 'c'}, {'d', 'e', 'f'}};

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

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

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

Returns:Boolean2DArrayAssert

this assertion object.

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

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

Verifies that the actual boolean[][] 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 boolean[][] {{true, false}, {false, true}}).isDeepEqualTo(new boolean[][] {{true, false}, {false, true}});

// assertions will fail
assertThat(new boolean[][] {{true, false}, {false, true}}).isDeepEqualTo(new boolean[][] {{true, false}, {true, true}});
assertThat(new boolean[][] {{true, false}, {false, true}}).isDeepEqualTo(new boolean[][] {{true}, {false, false, true}});
Parameters
expected:boolean[][]

the given value to compare the actual value to.

Returns:Boolean2DArrayAssert

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

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

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

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

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

Example:

 boolean[][] array = {{true, true}, {false, false}};

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

// assertion will fail as isEqualTo calls equals which compares arrays references only.
assertThat(array).isEqualTo(new boolean[][] {{true, true}, {false, false}});
Parameters
expected:Object

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

Returns:Boolean2DArrayAssert

this assertion object.

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

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

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

Example:

 // assertions will pass
assertThat(new boolean[][] {{ true }, { false }}).isNotEmpty();
assertThat(new boolean[][] {{ }, { false }}).isNotEmpty();

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

this assertion object.

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

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

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

// assertion will fail
assertThat(new String[][] {{"a"}, {"b"}}).isNullOrEmpty();
Annotations
@Override
Exceptions
AssertionError:
if the actual boolean[][]is not null or not empty.