org.assertj.core.api

Class AbstractIntArrayAssert<S extends AbstractIntArrayAssert<S>>

java.lang.Object

org.assertj.core.api.AbstractAssert<S,int[]>

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

All Implemented Interfaces:

ArraySortedAssert<AbstractIntArrayAssert<S>,Integer>, Assert<S,int[]>, Descriptable<S>, EnumerableAssert<AbstractIntArrayAssert<S>,Integer>, ExtensionPoints<S,int[]>

Direct Known Subclasses:

IntArrayAssert

public abstract class AbstractIntArrayAssert<S extends AbstractIntArrayAssert<S>>
extends AbstractAssert<S,int[]>
implements EnumerableAssert<AbstractIntArrayAssert<S>,Integer>, ArraySortedAssert<AbstractIntArrayAssert<S>,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
S	contains(int... values) Verifies that the actual array contains the given values, in any order.
S	contains(int value, Index index) Verifies that the actual array contains the given value at the given index.
S	containsExactly(int... values) Verifies that the actual group contains only the given values and nothing else, in order.
S	containsOnly(int... values) Verifies that the actual array contains only the given values and nothing else, in any order.
S	containsOnlyOnce(int... values) Verifies that the actual array contains the given values only once.
S	containsSequence(int... sequence) Verifies that the actual array contains the given sequence, without any other values between them.
S	doesNotContain(int... values) Verifies that the actual array does not contain the given values.
S	doesNotContain(int value, Index index) Verifies that the actual array does not contain the given value at the given index.
S	doesNotHaveDuplicates() Verifies that the actual array does not contain duplicates.
S	endsWith(int... sequence) Verifies that the actual array ends with the given sequence of values, without any other values between them.
S	hasSameSizeAs(Iterable<?> other) Verifies that the actual group has the same size as given Iterable.
S	hasSameSizeAs(Object[] other) Verifies that the actual group has the same size as given array.
S	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.
S	isNotEmpty() Verifies that the actual group of values is not empty.
void	isNullOrEmpty() Verifies that the actual group of values is null or empty.
S	isSorted() Verifies that the actual array is sorted into ascending order according to the natural ordering of its elements.
S	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 element is compatible with comparator, otherwise an AssertionError is thrown.
S	startsWith(int... sequence) Verifies that the actual array starts with the given sequence of values, without any other values between them.
S	usingDefaultElementComparator() Revert to standard comparison for incoming assertion group element checks.
S	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.AbstractAssert

as, as, describedAs, describedAs, descriptionText, doesNotHave, doesNotHaveSameClassAs, equals, failWithMessage, getWritableAssertionInfo, has, hashCode, hasSameClassAs, is, isEqualTo, isExactlyInstanceOf, isIn, isIn, isInstanceOf, isInstanceOfAny, isNot, isNotEqualTo, isNotExactlyInstanceOf, isNotIn, isNotIn, isNotInstanceOf, isNotInstanceOfAny, isNotNull, isNotOfAnyClassIn, isNotSameAs, isNull, isOfAnyClassIn, isSameAs, overridingErrorMessage, usingComparator, usingDefaultComparator

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.

Specified by:

isNullOrEmpty in interface EnumerableAssert<AbstractIntArrayAssert<S extends AbstractIntArrayAssert<S>>,Integer>

isEmpty

public void isEmpty()

Verifies that the actual group of values is empty.

Specified by:

isEmpty in interface EnumerableAssert<AbstractIntArrayAssert<S extends AbstractIntArrayAssert<S>>,Integer>

isNotEmpty

public S isNotEmpty()

Verifies that the actual group of values is not empty.

Specified by:

isNotEmpty in interface EnumerableAssert<AbstractIntArrayAssert<S extends AbstractIntArrayAssert<S>>,Integer>

Returns:

this assertion object.

hasSize

public S hasSize(int expected)

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

Specified by:

hasSize in interface EnumerableAssert<AbstractIntArrayAssert<S extends AbstractIntArrayAssert<S>>,Integer>

Parameters:

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

Returns:

this assertion object.

hasSameSizeAs

public S hasSameSizeAs(Object[] other)

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

Specified by:

hasSameSizeAs in interface EnumerableAssert<AbstractIntArrayAssert<S extends AbstractIntArrayAssert<S>>,Integer>

Parameters:

other - the array to compare size with actual group.

Returns:

this assertion object.

hasSameSizeAs

public S hasSameSizeAs(Iterable<?> other)

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

Specified by:

hasSameSizeAs in interface EnumerableAssert<AbstractIntArrayAssert<S extends AbstractIntArrayAssert<S>>,Integer>

Parameters:

other - the Iterable to compare size with actual group.

Returns:

this assertion object.

contains

public S contains(int... values)

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

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 S containsOnly(int... values)

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

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 S 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 S containsSequence(int... sequence)

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

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.

contains

public S contains(int value,
         Index index)

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

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 S doesNotContain(int... values)

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

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 S doesNotContain(int value,
               Index index)

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

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 S doesNotHaveDuplicates()

Verifies that the actual array does not contain duplicates.

Returns:

this assertion object.

Throws:

AssertionError - if the actual array is null.

AssertionError - if the actual array contains duplicates.

startsWith

public S 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.

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 S 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.

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 S isSorted()

Verifies that the actual array is sorted into 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).

Specified by:

isSorted in interface ArraySortedAssert<AbstractIntArrayAssert<S extends AbstractIntArrayAssert<S>>,Integer>

Returns:

this assertion object.

isSortedAccordingTo

public S 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 element is compatible with comparator, otherwise an AssertionError is thrown.

Specified by:

isSortedAccordingTo in interface ArraySortedAssert<AbstractIntArrayAssert<S extends AbstractIntArrayAssert<S>>,Integer>

Parameters:

comparator - the Comparator used to compare array elements

Returns:

this assertion object.

usingElementComparator

public S 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);
 

Specified by:

usingElementComparator in interface EnumerableAssert<AbstractIntArrayAssert<S extends AbstractIntArrayAssert<S>>,Integer>

Parameters:

customComparator - the comparator to use for incoming assertion checks.

Returns:

this assertion object.

usingDefaultElementComparator

public S 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).

Specified by:

usingDefaultElementComparator in interface EnumerableAssert<AbstractIntArrayAssert<S extends AbstractIntArrayAssert<S>>,Integer>

Returns:

this assertion object.

containsExactly

public S 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 orders 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.