org.assertj.core.api

Class AbstractIntArrayAssert<SELF extends AbstractIntArrayAssert<SELF>>

java.lang.Object

org.assertj.core.api.AbstractAssert<SELF,ACTUAL>

org.assertj.core.api.AbstractEnumerableAssert<SELF,ACTUAL,ELEMENT>

org.assertj.core.api.AbstractArrayAssert<SELF,int[],Integer>

org.assertj.core.api.AbstractIntArrayAssert<SELF>

All Implemented Interfaces:

ArraySortedAssert<AbstractArrayAssert<SELF,int[],Integer>,Integer>, Assert<SELF,int[]>, Descriptable<SELF>, EnumerableAssert<AbstractEnumerableAssert<SELF,int[],Integer>,Integer>, ExtensionPoints<SELF,int[]>

Direct Known Subclasses:

IntArrayAssert

public abstract class AbstractIntArrayAssert<SELF extends AbstractIntArrayAssert<SELF>>
extends AbstractArrayAssert<SELF,int[],Integer>

Field Summary

Fields

Modifier and Type	Field and Description
protected IntArrays	arrays

Fields inherited from class org.assertj.core.api.AbstractAssert

actual, info, myself

Constructor Summary

Constructors

Constructor and Description
AbstractIntArrayAssert(int[] actual, Class<?> selfType)

Method Summary

Methods

Modifier and Type	Method and Description
SELF	contains(int... values) Verifies that the actual array contains the given values, in any order.
SELF	contains(int value, Index index) Verifies that the actual array contains the given value at the given index.
SELF	containsAnyOf(int... values) Verifies that the actual array contains at least one of the given values.
SELF	containsExactly(int... values) Verifies that the actual group contains only the given values and nothing else, in order.
SELF	containsExactlyInAnyOrder(int... values) Verifies that the actual group contains exactly the given values and nothing else, in any order.
SELF	containsOnly(int... values) Verifies that the actual array contains only the given values and nothing else, in any order.
SELF	containsOnlyOnce(int... values) Verifies that the actual array contains the given values only once.
SELF	containsSequence(int... sequence) Verifies that the actual array contains the given sequence, without any other values between them.
SELF	containsSubsequence(int... subsequence) Verifies that the actual array contains the given subsequence (possibly with other values between them).
SELF	doesNotContain(int... values) Verifies that the actual array does not contain the given values.
SELF	doesNotContain(int value, Index index) Verifies that the actual array does not contain the given value at the given index.
SELF	doesNotHaveDuplicates() Verifies that the actual array does not contain duplicates.
SELF	endsWith(int... sequence) Verifies that the actual array ends with the given sequence of values, without any other values between them.
SELF	hasSameSizeAs(Iterable<?> other) Verifies that the actual group has the same size as given Iterable.
SELF	hasSize(int expected) Verifies that the number of values in the actual group is equal to the given one.
void	isEmpty() Verifies that the actual group of values is empty.
SELF	isNotEmpty() Verifies that the actual group of values is not empty.
void	isNullOrEmpty() Verifies that the actual group of values is null or empty.
SELF	isSorted() Verifies that the actual array is sorted in ascending order according to the natural ordering of its elements.
SELF	isSortedAccordingTo(Comparator<? super Integer> comparator) Verifies that the actual array is sorted according to the given comparator. Empty arrays are considered sorted whatever the comparator is. One element arrays are considered sorted if the element is compatible with comparator, otherwise an AssertionError is thrown.
SELF	startsWith(int... sequence) Verifies that the actual array starts with the given sequence of values, without any other values between them.
SELF	usingDefaultElementComparator() Revert to standard comparison for incoming assertion group element checks.
SELF	usingElementComparator(Comparator<? super Integer> customComparator) Use given custom comparator instead of relying on actual type A equals method to compare group elements for incoming assertion checks.

Methods inherited from class org.assertj.core.api.AbstractEnumerableAssert

hasSameSizeAs, inBinary, inHexadecimal

Methods inherited from class org.assertj.core.api.AbstractAssert

as, as, asList, asString, describedAs, describedAs, descriptionText, doesNotHave, doesNotHaveSameClassAs, equals, failWithMessage, getWritableAssertionInfo, has, hashCode, hasSameClassAs, hasSameHashCodeAs, hasToString, is, isEqualTo, isExactlyInstanceOf, isIn, isIn, isInstanceOf, isInstanceOfAny, isNot, isNotEqualTo, isNotExactlyInstanceOf, isNotIn, isNotIn, isNotInstanceOf, isNotInstanceOfAny, isNotNull, isNotOfAnyClassIn, isNotSameAs, isNull, isOfAnyClassIn, isSameAs, overridingErrorMessage, setCustomRepresentation, throwAssertionError, usingComparator, usingComparator, usingDefaultComparator, withFailMessage, withRepresentation, withThreadDumpOnError

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

arrays

protected IntArrays arrays

Constructor Detail

AbstractIntArrayAssert

public AbstractIntArrayAssert(int[] actual,
                      Class<?> selfType)

Method Detail

isNullOrEmpty

public void isNullOrEmpty()

Verifies that the actual group of values is null or empty.

Example:

 // assertions will pass
 List<String> strings = new ArrayList<>();
 assertThat(strings).isNullOrEmpty();
 assertThat(new int[] { }).isNullOrEmpty();
 
 // assertions will fail
 assertThat(new String[] { "a", "b"}).isNullOrEmpty();
 assertThat(Arrays.asList(1, 2, 3)).isNullOrEmpty();

isEmpty

public void isEmpty()

Verifies that the actual group of values is empty.

Example:

 // assertions will pass
 assertThat(new ArrayList()).isEmpty();
 assertThat(new int[] { }).isEmpty();
 
 // assertions will fail
 assertThat(new String[] { "a", "b" }).isEmpty();
 assertThat(Arrays.asList(1, 2, 3)).isEmpty();

isNotEmpty

public SELF isNotEmpty()

Verifies that the actual group of values is not empty.

Example:

 // assertions will pass
 assertThat(new String[] { "a", "b" }).isNotEmpty();
 assertThat(Arrays.asList(1, 2, 3)).isNotEmpty();
 
 // assertions will fail
 assertThat(new ArrayList()).isNotEmpty();
 assertThat(new int[] { }).isNotEmpty();

Returns:

this assertion object.

hasSize

public SELF hasSize(int expected)

Verifies that the number of values in the actual group is equal to the given one.

Example:

 // assertions will pass
 assertThat(new String[] { "a", "b" }).hasSize(2);
 assertThat(Arrays.asList(1, 2, 3)).hasSize(3);
 
 // assertions will fail
 assertThat(new ArrayList()).hasSize(1);
 assertThat(new int[] { 1, 2, 3 }).hasSize(2);

Parameters:

expected - the expected number of values in the actual group.

Returns:

this assertion object.

hasSameSizeAs

public SELF hasSameSizeAs(Iterable<?> other)

Verifies that the actual group has the same size as given Iterable.

Example:

 Iterable<String> abc = newArrayList("a", "b", "c");
 Iterable<Ring> elvesRings = newArrayList(vilya, nenya, narya); 
 
 // assertion will pass
 assertThat(elvesRings).hasSameSizeAs(abc);
 
 // assertions will fail
 assertThat(elvesRings).hasSameSizeAs(Arrays.asList(1, 2));
 assertThat(elvesRings).hasSameSizeAs(Arrays.asList(1, 2, 3, 4));

Parameters:

other - the Iterable to compare size with actual group.

Returns:

this assertion object.

contains

public SELF contains(int... values)

Verifies that the actual array contains the given values, in any order.

Example:

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

 // assertions will fail
 assertThat(new int[] { 1, 2, 3 }).contains(1, 4);
 assertThat(new int[] { 1, 2, 3 }).contains(4, 7);

Parameters:

values - the given values.

Returns:

this assertion object.

Throws:

NullPointerException - if the given argument is null.

IllegalArgumentException - if the given argument is an empty array.

AssertionError - if the actual array is null.

AssertionError - if the actual array does not contain the given values.

containsOnly

public SELF containsOnly(int... values)

Verifies that the actual array contains only the given values and nothing else, in any order.

Example:

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

 // assertions will fail
 assertThat(new int[] { 1, 2, 3 }).containsOnly(1, 2, 3, 4);
 assertThat(new int[] { 1, 2, 3 }).containsOnly(4, 7);

Parameters:

values - the given values.

Returns:

this assertion object.

Throws:

NullPointerException - if the given argument is null.

IllegalArgumentException - if the given argument is an empty array.

AssertionError - if the actual array is null.

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.

containsOnlyOnce

public SELF containsOnlyOnce(int... values)

Verifies that the actual array contains the given values only once.

Examples :

 // assertion will pass
 assertThat(new int[] { 1, 2, 3 }).containsOnlyOnce(1, 2);
 
 // assertions will fail
 assertThat(new int[] { 1, 2, 1 }).containsOnlyOnce(1);
 assertThat(new int[] { 1, 2, 3 }).containsOnlyOnce(4);
 assertThat(new int[] { 1, 2, 3, 3 }).containsOnlyOnce(0, 1, 2, 3, 4, 5);

Parameters:

values - the given values.

Returns:

this assertion object.

Throws:

NullPointerException - if the given argument is null.

IllegalArgumentException - if the given argument is an empty array.

AssertionError - if the actual array is null.

AssertionError - if the actual group does not contain the given values, i.e. the actual group contains some or none of the given values, or the actual group contains more than once these values.

containsSequence

public SELF containsSequence(int... sequence)

Verifies that the actual array contains the given sequence, without any other values between them.

Example:

 // assertion will pass
 assertThat(new int[] { 1, 2, 3 }).containsSequence(1, 2);
 
 // assertion will fail
 assertThat(new int[] { 1, 2, 3 }).containsSequence(1, 3);
 assertThat(new int[] { 1, 2, 3 }).containsSequence(2, 1);

Parameters:

sequence - the sequence of values to look for.

Returns:

myself assertion object.

Throws:

AssertionError - if the actual array is null.

AssertionError - if the given array is null.

AssertionError - if the actual array does not contain the given sequence.

containsSubsequence

public SELF containsSubsequence(int... subsequence)

Verifies that the actual array contains the given subsequence (possibly with other values between them).

Example:

 // assertion will pass
 assertThat(new int[] { 1, 2, 3 }).containsSubsequence(1, 2);
 assertThat(new int[] { 1, 2, 3 }).containsSubsequence(1, 3);
 
 // assertion will fail
 assertThat(new int[] { 1, 2, 3 }).containsSubsequence(2, 1);

Parameters:

subsequence - the subsequence of values to look for.

Returns:

myself assertion object.

Throws:

AssertionError - if the actual array is null.

AssertionError - if the given array is null.

AssertionError - if the actual array does not contain the given subsequence.

contains

public SELF contains(int value,
            Index index)

Verifies that the actual array contains the given value at the given index.

Example:

 // assertions will pass
 assertThat(new int[] { 1, 2, 3 }).contains(1, atIndex(O));
 assertThat(new int[] { 1, 2, 3 }).contains(3, atIndex(2));

 // assertions will fail
 assertThat(new int[] { 1, 2, 3 }).contains(1, atIndex(1));
 assertThat(new int[] { 1, 2, 3 }).contains(4, atIndex(2));

Parameters:

value - the value to look for.

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

Returns:

myself assertion object.

Throws:

AssertionError - if the actual array is null or empty.

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.

AssertionError - if the actual array does not contain the given value at the given index.

doesNotContain

public SELF doesNotContain(int... values)

Verifies that the actual array does not contain the given values.

Example:

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

 // assertion will fail
 assertThat(new int[] { 1, 2, 3 }).doesNotContain(2);

Parameters:

values - the given values.

Returns:

this assertion object.

Throws:

NullPointerException - if the given argument is null.

IllegalArgumentException - if the given argument is an empty array.

AssertionError - if the actual array is null.

AssertionError - if the actual array contains any of the given values.

doesNotContain

public SELF 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 }).doesNotContain(1, atIndex(1));
 assertThat(new int[] { 1, 2, 3 }).doesNotContain(2, atIndex(0));

 // assertions will fail
 assertThat(new int[] { 1, 2, 3 }).doesNotContain(1, atIndex(0));
 assertThat(new int[] { 1, 2, 3 }).doesNotContain(2, atIndex(1));

Parameters:

value - the value to look for.

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

Returns:

myself assertion object.

Throws:

AssertionError - if the actual array is null.

NullPointerException - if the given Index is null.

AssertionError - if the actual array contains the given value at the given index.

doesNotHaveDuplicates

public SELF doesNotHaveDuplicates()

Verifies that the actual array does not contain duplicates.

Example:

 // assertion will pass
 assertThat(new int[] { 1, 2, 3 }).doesNotHaveDuplicates();

 // assertion will fail
 assertThat(new int[] { 1, 1, 2, 3 }).doesNotHaveDuplicates();

Returns:

this assertion object.

Throws:

AssertionError - if the actual array is null.

AssertionError - if the actual array contains duplicates.

startsWith

public SELF startsWith(int... sequence)

Verifies that the actual array starts with the given sequence of values, without any other values between them. Similar to containsSequence(int...), but it also verifies that the first element in the sequence is also first element of the actual array.

Example:

 // assertion will pass
 assertThat(new int[] { 1, 2, 3 }).startsWith(1, 2);

 // assertion will fail
 assertThat(new int[] { 1, 2, 3 }).startsWith(2, 3);

Parameters:

sequence - the sequence of values to look for.

Returns:

myself assertion object.

Throws:

NullPointerException - if the given argument is null.

IllegalArgumentException - if the given argument is an empty array.

AssertionError - if the actual array is null.

AssertionError - if the actual array does not start with the given sequence.

endsWith

public SELF endsWith(int... sequence)

Verifies that the actual array ends with the given sequence of values, without any other values between them. Similar to containsSequence(int...), but it also verifies that the last element in the sequence is also last element of the actual array.

Example:

 // assertion will pass
 assertThat(new int[] { 1, 2, 3 }).endsWith(2, 3);

 // assertion will fail
 assertThat(new int[] { 1, 2, 3 }).endsWith(3, 4);

Parameters:

sequence - the sequence of values to look for.

Returns:

myself assertion object.

Throws:

NullPointerException - if the given argument is null.

IllegalArgumentException - if the given argument is an empty array.

AssertionError - if the actual array is null.

AssertionError - if the actual array does not end with the given sequence.

isSorted

public SELF isSorted()

Verifies that the actual array is sorted in ascending order according to the natural ordering of its elements.

All array elements must be primitive or implement the Comparable interface and must be mutually comparable (that is, e1.compareTo(e2) must not throw a ClassCastException for any elements e1 and e2 in the array), examples :

• a array composed of {2, 4, 6} is ok because the element type is a primitive type.
• a array composed of {"a1", "a2", "a3"} is ok because the element type (String) is Comparable
• a array composed of Rectangle {r1, r2, r3} is NOT ok because Rectangle is not Comparable
• a array composed of {True, "abc", False} is NOT ok because elements are not mutually comparable (even though each element type implements Comparable)

Empty or one element arrays are considered sorted (unless the array element type is not Comparable).

Returns:

this assertion object.

isSortedAccordingTo

public SELF isSortedAccordingTo(Comparator<? super Integer> comparator)

Verifies that the actual array is sorted according to the given comparator.
Empty arrays are considered sorted whatever the comparator is.
One element arrays are considered sorted if the element is compatible with comparator, otherwise an AssertionError is thrown.

Parameters:

comparator - the Comparator used to compare array elements

Returns:

this assertion object.

usingElementComparator

public SELF usingElementComparator(Comparator<? super Integer> customComparator)

Use given custom comparator instead of relying on actual type A equals method to compare group elements for incoming assertion checks.

Custom comparator is bound to assertion instance, meaning that if a new assertion is created, it will use default comparison strategy.

Examples :

 // compares invoices by payee
 assertThat(invoiceList).usingComparator(invoicePayeeComparator).isEqualTo(expectedInvoiceList);
 
 // compares invoices by date, doesNotHaveDuplicates and contains both use the given invoice date comparator
 assertThat(invoiceList).usingComparator(invoiceDateComparator).doesNotHaveDuplicates().contains(may2010Invoice);
 
 // as assertThat(invoiceList) creates a new assertion, it falls back to standard comparison strategy 
 // based on Invoice's equal method to compare invoiceList elements to lowestInvoice.                                                      
 assertThat(invoiceList).contains(lowestInvoice);
 
 // standard comparison : the fellowshipOfTheRing includes Gandalf but not Sauron (believe me) ...
 assertThat(fellowshipOfTheRing).contains(gandalf)
                                .doesNotContain(sauron);
 
 // ... but if we compare only races, Sauron is in fellowshipOfTheRing because he's a Maia like Gandalf.
 assertThat(fellowshipOfTheRing).usingElementComparator(raceComparator)
                                .contains(sauron);

Parameters:

customComparator - the comparator to use for incoming assertion checks.

Returns:

this assertion object.

usingDefaultElementComparator

public SELF usingDefaultElementComparator()

Revert to standard comparison for incoming assertion group element checks.

This method should be used to disable a custom comparison strategy set by calling EnumerableAssert.usingElementComparator(Comparator).

Returns:

this assertion object.

containsExactly

public SELF containsExactly(int... values)

Verifies that the actual group contains only the given values and nothing else, in order.

Example :

 int[] ints = { 1, 2, 3 };
 
 // assertion will pass
 assertThat(ints).containsExactly(1, 2, 3);
 
 // assertion will fail as actual and expected order differ
 assertThat(ints).containsExactly(2, 1, 3);

Parameters:

values - the given values.

Returns:

this assertion object.

Throws:

NullPointerException - if the given argument is null.

AssertionError - if the actual group is null.

AssertionError - if the actual group does not contain the given values with same order, i.e. the actual group contains some or none of the given values, or the actual group contains more values than the given ones or values are the same but the order is not.

containsExactlyInAnyOrder

public SELF containsExactlyInAnyOrder(int... values)

Verifies that the actual group contains exactly the given values and nothing else, in any order.

Example :

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

Parameters:

values - the given values.

Returns:

this assertion object.

Throws:

NullPointerException - if the given argument is null.

AssertionError - if the actual group is null.

AssertionError - if the actual group does not contain the given values, i.e. the actual group contains some or none of the given values, or the actual group contains more values than the given ones.

Since:

2.6.0 / 3.6.0

containsAnyOf

public SELF containsAnyOf(int... values)

Verifies that the actual array contains at least one of the given values.

Example :

 int[] oneTwoThree = { 1, 2, 3 }; 

 // assertions will pass
 assertThat(oneTwoThree).containsAnyOf(2)
                        .containsAnyOf(2, 3)
                        .containsAnyOf(1, 2, 3)
                        .containsAnyOf(1, 2, 3, 4)
                        .containsAnyOf(5, 6, 7, 2);

 // assertions will fail
 assertThat(oneTwoThree).containsAnyOf(4);
 assertThat(oneTwoThree).containsAnyOf(4, 5, 6, 7);

Parameters:

values - the values whose at least one which is expected to be in the array under test.

Returns:

this assertion object.

Throws:

NullPointerException - if the array of values is null.

IllegalArgumentException - if the array of values is empty and the array under test is not empty.

AssertionError - if the array under test is null.

AssertionError - if the array under test does not contain any of the given values.

Since:

2.9.0 / 3.9.0