org.fest.assertions.api
Class ObjectArrayAssert

java.lang.Object
  extended by org.fest.assertions.api.AbstractAssert<ObjectArrayAssert,Object[]>
      extended by org.fest.assertions.api.ObjectArrayAssert
All Implemented Interfaces:
ArraySortedAssert<ObjectArrayAssert,Object>, Assert<ObjectArrayAssert,Object[]>, Descriptable<ObjectArrayAssert>, EnumerableAssert<ObjectArrayAssert>, ExtensionPoints<ObjectArrayAssert,Object[]>, IndexedObjectEnumerableAssert, ObjectEnumerableAssert<ObjectArrayAssert>

public class ObjectArrayAssert
extends AbstractAssert<ObjectArrayAssert,Object[]>
implements ObjectEnumerableAssert<ObjectArrayAssert>, IndexedObjectEnumerableAssert, ArraySortedAssert<ObjectArrayAssert,Object>

Assertion methods for arrays of objects.

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

Author:
Yvonne Wang, Alex Ruiz, Joel Costigliola, Nicolas François

Field Summary
 
Fields inherited from class org.fest.assertions.api.AbstractAssert
actual, myself
 
Constructor Summary
protected ObjectArrayAssert(Object[] actual)
           
 
Method Summary
<E> ObjectArrayAssert
are(Condition<E> condition)
          Verifies that each element value satisfies the given condition
<E> ObjectArrayAssert
areAtLeast(int times, Condition<E> condition)
          Verifies that there is at least n elements in the actual group satisfying the given condition.
<E> ObjectArrayAssert
areAtMost(int times, Condition<E> condition)
          Verifies that there is at most n elements in the actual group satisfying the given condition.
<E> ObjectArrayAssert
areExactly(int times, Condition<E> condition)
          Verifies that there is exactly n elements in the actual group satisfying the given condition.
<E> ObjectArrayAssert
areNot(Condition<E> condition)
          Verifies that each element value not satisfies the given condition
<E> ObjectArrayAssert
areNotAtLeast(int times, Condition<E> condition)
          Verifies that there is at least n elements in the actual group not satisfying the given condition.
<E> ObjectArrayAssert
areNotAtMost(int times, Condition<E> condition)
          Verifies that there is at most n elements in the actual group not satisfying the given condition.
<E> ObjectArrayAssert
areNotExactly(int times, Condition<E> condition)
          Verifies that there is exactly n elements in the actual group not satisfying the given condition.
 ObjectArrayAssert contains(Object... values)
          Verifies that the actual group contains the given values, in any order.
 ObjectArrayAssert contains(Object value, Index index)
          Verifies that the actual group contains the given object at the given index.
 ObjectArrayAssert containsNull()
          Verifies that the actual group contains at least a null element.
 ObjectArrayAssert containsOnly(Object... values)
          Verifies that the actual group contains only the given values and nothing else, in any order.
 ObjectArrayAssert containsSequence(Object... sequence)
          Verifies that the actual group contains the given sequence, without any other values between them.
 ObjectArrayAssert doesNotContain(Object... values)
          Verifies that the actual group does not contain the given values.
 ObjectArrayAssert doesNotContain(Object value, Index index)
          Verifies that the actual group does not contain the given object at the given index.
 ObjectArrayAssert doesNotContainNull()
          Verifies that the actual group does not contain null elements.
 ObjectArrayAssert doesNotHaveDuplicates()
          Verifies that the actual group does not contain duplicates.
<E> ObjectArrayAssert
doNotHave(Condition<E> condition)
          Verifies that each element value not satisfies the given condition
<E> ObjectArrayAssert
doNotHaveAtLeast(int times, Condition<E> condition)
          This method is an alias ObjectEnumerableAssert.areNotAtLeast(int, Condition).
<E> ObjectArrayAssert
doNotHaveAtMost(int times, Condition<E> condition)
          This method is an alias ObjectEnumerableAssert.areNotAtMost(int, Condition).
<E> ObjectArrayAssert
doNotHaveExactly(int times, Condition<E> condition)
          This method is an alias ObjectEnumerableAssert.areNotExactly(int, Condition).
 ObjectArrayAssert endsWith(Object... sequence)
          Verifies that the actual group ends with the given sequence of objects, without any other objects between them.
 ObjectArrayAssert hasSameSizeAs(Iterable<?> other)
          Verifies that the actual group has the same size as given Iterable.
 ObjectArrayAssert hasSameSizeAs(Object[] other)
          Verifies that the actual group has the same size as given array.
 ObjectArrayAssert hasSize(int expected)
          Verifies that the number of values in the actual group is equal to the given one.
<E> ObjectArrayAssert
have(Condition<E> condition)
          Verifies that each element value satisfies the given condition
<E> ObjectArrayAssert
haveAtLeast(int times, Condition<E> condition)
          This method is an alias for ObjectEnumerableAssert.areAtLeast(int, Condition).
<E> ObjectArrayAssert
haveAtMost(int times, Condition<E> condition)
          This method is an alias ObjectEnumerableAssert.areAtMost(int, Condition).
<E> ObjectArrayAssert
haveExactly(int times, Condition<E> condition)
          This method is an alias ObjectEnumerableAssert.areExactly(int, Condition).
 void isEmpty()
          Verifies that the actual group of values is empty.
 ObjectArrayAssert isNotEmpty()
          Verifies that the actual group of values is not empty.
 void isNullOrEmpty()
          Verifies that the actual group of values is null or empty.
 ObjectArrayAssert isSorted()
          Verifies that the actual array is sorted into ascending order according to the natural ordering of its elements.
 ObjectArrayAssert isSortedAccordingTo(Comparator<? extends Object> comparator)
          Verifies that the actual array is sorted according to the given comparator.
 ObjectArrayAssert startsWith(Object... sequence)
          Verifies that the actual group starts with the given sequence of objects, without any other objects between them.
 ObjectArrayAssert usingComparator(Comparator<?> customComparator)
          Use given custom comparator instead of relying on actual type A equals method for incoming assertion checks.
 ObjectArrayAssert usingDefaultComparator()
          Revert to standard comparison for incoming assertion checks.
 
Methods inherited from class org.fest.assertions.api.AbstractAssert
as, as, describedAs, describedAs, descriptionText, doesNotHave, equals, has, hashCode, is, isEqualTo, isIn, isIn, isNot, isNotEqualTo, isNotIn, isNotIn, isNotNull, isNotSameAs, isNull, isSameAs
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ObjectArrayAssert

protected ObjectArrayAssert(Object[] actual)
Method Detail

isNullOrEmpty

public void isNullOrEmpty()
Verifies that the actual group of values is null or empty.

Specified by:
isNullOrEmpty in interface EnumerableAssert<ObjectArrayAssert>

isEmpty

public void isEmpty()
Verifies that the actual group of values is empty.

Specified by:
isEmpty in interface EnumerableAssert<ObjectArrayAssert>

isNotEmpty

public ObjectArrayAssert isNotEmpty()
Verifies that the actual group of values is not empty.

Specified by:
isNotEmpty in interface EnumerableAssert<ObjectArrayAssert>
Returns:
this assertion object.

hasSize

public ObjectArrayAssert 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<ObjectArrayAssert>
Parameters:
expected - the expected number of values in the actual group.
Returns:
this assertion object.

hasSameSizeAs

public ObjectArrayAssert hasSameSizeAs(Object[] other)
Verifies that the actual group has the same size as given array.

Specified by:
hasSameSizeAs in interface ObjectEnumerableAssert<ObjectArrayAssert>
Parameters:
other - the array to compare size with actual group.
Returns:
this assertion object.

hasSameSizeAs

public ObjectArrayAssert hasSameSizeAs(Iterable<?> other)
Verifies that the actual group has the same size as given Iterable.

Specified by:
hasSameSizeAs in interface ObjectEnumerableAssert<ObjectArrayAssert>
Parameters:
other - the Iterable to compare size with actual group.
Returns:
this assertion object.

contains

public ObjectArrayAssert contains(Object... values)
Verifies that the actual group contains the given values, in any order.

Specified by:
contains in interface ObjectEnumerableAssert<ObjectArrayAssert>
Parameters:
values - the given values.
Returns:
this assertion object.

containsOnly

public ObjectArrayAssert containsOnly(Object... values)
Verifies that the actual group contains only the given values and nothing else, in any order.

Specified by:
containsOnly in interface ObjectEnumerableAssert<ObjectArrayAssert>
Parameters:
values - the given values.
Returns:
this assertion object.

containsSequence

public ObjectArrayAssert containsSequence(Object... sequence)
Verifies that the actual group contains the given sequence, without any other values between them.

Specified by:
containsSequence in interface ObjectEnumerableAssert<ObjectArrayAssert>
Parameters:
sequence - the sequence of objects to look for.
Returns:
this assertion object.

contains

public ObjectArrayAssert contains(Object value,
                                  Index index)
Verifies that the actual group contains the given object at the given index.

Specified by:
contains in interface IndexedObjectEnumerableAssert
Parameters:
value - the object to look for.
index - the index where the object should be stored in the actual group.
Returns:
this assertion object.

doesNotContain

public ObjectArrayAssert doesNotContain(Object value,
                                        Index index)
Verifies that the actual group does not contain the given object at the given index.

Specified by:
doesNotContain in interface IndexedObjectEnumerableAssert
Parameters:
value - the object to look for.
index - the index where the object should be stored in the actual group.
Returns:
this assertion object.

doesNotContain

public ObjectArrayAssert doesNotContain(Object... values)
Verifies that the actual group does not contain the given values.

Specified by:
doesNotContain in interface ObjectEnumerableAssert<ObjectArrayAssert>
Parameters:
values - the given values.
Returns:
this assertion object.

doesNotHaveDuplicates

public ObjectArrayAssert doesNotHaveDuplicates()
Verifies that the actual group does not contain duplicates.

Specified by:
doesNotHaveDuplicates in interface ObjectEnumerableAssert<ObjectArrayAssert>
Returns:
this assertion object.

startsWith

public ObjectArrayAssert startsWith(Object... sequence)
Verifies that the actual group starts with the given sequence of objects, without any other objects between them. Similar to ObjectEnumerableAssert.containsSequence(Object...), but it also verifies that the first element in the sequence is also first element of the actual group.

Specified by:
startsWith in interface ObjectEnumerableAssert<ObjectArrayAssert>
Parameters:
sequence - the sequence of objects to look for.
Returns:
this assertion object.

endsWith

public ObjectArrayAssert endsWith(Object... sequence)
Verifies that the actual group ends with the given sequence of objects, without any other objects between them. Similar to ObjectEnumerableAssert.containsSequence(Object...), but it also verifies that the last element in the sequence is also last element of the actual group.

Specified by:
endsWith in interface ObjectEnumerableAssert<ObjectArrayAssert>
Parameters:
sequence - the sequence of objects to look for.
Returns:
this assertion object.

containsNull

public ObjectArrayAssert containsNull()
Verifies that the actual group contains at least a null element.

Specified by:
containsNull in interface ObjectEnumerableAssert<ObjectArrayAssert>
Returns:
this assertion object.

doesNotContainNull

public ObjectArrayAssert doesNotContainNull()
Verifies that the actual group does not contain null elements.

Specified by:
doesNotContainNull in interface ObjectEnumerableAssert<ObjectArrayAssert>
Returns:
this assertion object.

are

public <E> ObjectArrayAssert are(Condition<E> condition)
Verifies that each element value satisfies the given condition

Specified by:
are in interface ObjectEnumerableAssert<ObjectArrayAssert>
Parameters:
condition - the given condition.
Returns:
this object.

areNot

public <E> ObjectArrayAssert areNot(Condition<E> condition)
Verifies that each element value not satisfies the given condition

Specified by:
areNot in interface ObjectEnumerableAssert<ObjectArrayAssert>
Parameters:
condition - the given condition.
Returns:
this object.

have

public <E> ObjectArrayAssert have(Condition<E> condition)
Verifies that each element value satisfies the given condition

Specified by:
have in interface ObjectEnumerableAssert<ObjectArrayAssert>
Parameters:
condition - the given condition.
Returns:
this object.

doNotHave

public <E> ObjectArrayAssert doNotHave(Condition<E> condition)
Verifies that each element value not satisfies the given condition

Specified by:
doNotHave in interface ObjectEnumerableAssert<ObjectArrayAssert>
Parameters:
condition - the given condition.
Returns:
this object.

areAtLeast

public <E> ObjectArrayAssert areAtLeast(int times,
                                        Condition<E> condition)
Verifies that there is at least n elements in the actual group satisfying the given condition.

Specified by:
areAtLeast in interface ObjectEnumerableAssert<ObjectArrayAssert>
Parameters:
times - the minimum number of times the condition should be verified.
condition - the given condition.
Returns:
this object.

areNotAtLeast

public <E> ObjectArrayAssert areNotAtLeast(int times,
                                           Condition<E> condition)
Verifies that there is at least n elements in the actual group not satisfying the given condition.

Specified by:
areNotAtLeast in interface ObjectEnumerableAssert<ObjectArrayAssert>
Parameters:
times - the number of times the condition should not be verified at least.
condition - the given condition.
Returns:
this object.

areAtMost

public <E> ObjectArrayAssert areAtMost(int times,
                                       Condition<E> condition)
Verifies that there is at most n elements in the actual group satisfying the given condition.

Specified by:
areAtMost in interface ObjectEnumerableAssert<ObjectArrayAssert>
Parameters:
times - the number of times the condition should be at most verified.
condition - the given condition.
Returns:
this object.

areNotAtMost

public <E> ObjectArrayAssert areNotAtMost(int times,
                                          Condition<E> condition)
Verifies that there is at most n elements in the actual group not satisfying the given condition.

Specified by:
areNotAtMost in interface ObjectEnumerableAssert<ObjectArrayAssert>
Parameters:
times - the number of times the condition should not be verified at most.
condition - the given condition.
Returns:
this object.

areExactly

public <E> ObjectArrayAssert areExactly(int times,
                                        Condition<E> condition)
Verifies that there is exactly n elements in the actual group satisfying the given condition.

Specified by:
areExactly in interface ObjectEnumerableAssert<ObjectArrayAssert>
Parameters:
times - the exact number of times the condition should be verified.
condition - the given condition.
Returns:
this object.

areNotExactly

public <E> ObjectArrayAssert areNotExactly(int times,
                                           Condition<E> condition)
Verifies that there is exactly n elements in the actual group not satisfying the given condition.

Specified by:
areNotExactly in interface ObjectEnumerableAssert<ObjectArrayAssert>
Parameters:
times - the exact number of times the condition should not be verified.
condition - the given condition.
Returns:
this object.

haveAtLeast

public <E> ObjectArrayAssert haveAtLeast(int times,
                                         Condition<E> condition)
This method is an alias for ObjectEnumerableAssert.areAtLeast(int, Condition).

Specified by:
haveAtLeast in interface ObjectEnumerableAssert<ObjectArrayAssert>

doNotHaveAtLeast

public <E> ObjectArrayAssert doNotHaveAtLeast(int times,
                                              Condition<E> condition)
This method is an alias ObjectEnumerableAssert.areNotAtLeast(int, Condition).

Specified by:
doNotHaveAtLeast in interface ObjectEnumerableAssert<ObjectArrayAssert>

haveAtMost

public <E> ObjectArrayAssert haveAtMost(int times,
                                        Condition<E> condition)
This method is an alias ObjectEnumerableAssert.areAtMost(int, Condition).

Specified by:
haveAtMost in interface ObjectEnumerableAssert<ObjectArrayAssert>

doNotHaveAtMost

public <E> ObjectArrayAssert doNotHaveAtMost(int times,
                                             Condition<E> condition)
This method is an alias ObjectEnumerableAssert.areNotAtMost(int, Condition).

Specified by:
doNotHaveAtMost in interface ObjectEnumerableAssert<ObjectArrayAssert>

haveExactly

public <E> ObjectArrayAssert haveExactly(int times,
                                         Condition<E> condition)
This method is an alias ObjectEnumerableAssert.areExactly(int, Condition).

Specified by:
haveExactly in interface ObjectEnumerableAssert<ObjectArrayAssert>

doNotHaveExactly

public <E> ObjectArrayAssert doNotHaveExactly(int times,
                                              Condition<E> condition)
This method is an alias ObjectEnumerableAssert.areNotExactly(int, Condition).

Specified by:
doNotHaveExactly in interface ObjectEnumerableAssert<ObjectArrayAssert>

isSorted

public ObjectArrayAssert 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 :

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

Specified by:
isSorted in interface ArraySortedAssert<ObjectArrayAssert,Object>
Returns:
this assertion object.

isSortedAccordingTo

public ObjectArrayAssert isSortedAccordingTo(Comparator<? extends Object> 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<ObjectArrayAssert,Object>
Parameters:
comparator - the Comparator used to compare array elements
Returns:
this assertion object.

usingComparator

public ObjectArrayAssert usingComparator(Comparator<?> customComparator)
Description copied from class: AbstractAssert
Use given custom comparator instead of relying on actual type A equals method 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.

Example :
 // 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 uses standard comparison strategy (Invoice's equal method) to compare invoiceList elements to lowestInvoice.                                                      
 assertThat(invoiceList).contains(lowestInvoice).
 
Custom comparator is not parameterized with actual type A (ie. Comparator<A>) because if it was, we could not write the following code :
 // frodo and sam are instances of Character (a Character having a Race)
 // raceComparator implements Comparator<Character> 
 // assertThat(frodo) returns an ObjectAssert and not a custom CharacterAssert implementing Assert<CharacterAssert, Character>  
 assertThat(frodo).usingComparator(raceComparator).isEqualTo(sam); // won't compile !
 
 The code does not compile because assertThat(frodo) returns an ObjectAssert, thus usingComparator expects a Comparator<Object> 
 and Comparator<Character> is not a Comparator<Object> as generics are not reified.
 
 Note that, it would have worked if assertThat(frodo) returned a CharacterAssert implementing Assert<CharacterAssert, Character>. 
 

Specified by:
usingComparator in interface Assert<ObjectArrayAssert,Object[]>
Overrides:
usingComparator in class AbstractAssert<ObjectArrayAssert,Object[]>
Parameters:
customComparator - the comparator to use for incoming assertion checks.
Returns:
this assertion object.

usingDefaultComparator

public ObjectArrayAssert usingDefaultComparator()
Description copied from class: AbstractAssert
Revert to standard comparison for incoming assertion checks.
This method should be used to disable a custom comparison strategy set by calling Assert.usingComparator(Comparator).

Specified by:
usingDefaultComparator in interface Assert<ObjectArrayAssert,Object[]>
Overrides:
usingDefaultComparator in class AbstractAssert<ObjectArrayAssert,Object[]>
Returns:
this assertion object.


Copyright © 2007-2012 FEST (Fixtures for Easy Software Testing). All Rights Reserved.