org.fest.assertions.core
Interface EnumerableAssert<S,T>

Type Parameters:
S - the "self" type of this assertion class. Please read "Emulating 'self types' using Java Generics to simplify fluent API implementation" for more details.
T - the type of elements of the "actual" value.
All Known Subinterfaces:
ObjectEnumerableAssert<S,T>
All Known Implementing Classes:
AbstractIterableAssert, BooleanArrayAssert, ByteArrayAssert, CharArrayAssert, DoubleArrayAssert, FloatArrayAssert, IntArrayAssert, IterableAssert, ListAssert, LongArrayAssert, MapAssert, ObjectArrayAssert, ShortArrayAssert, StringAssert

public interface EnumerableAssert<S,T>

Assertions applicable to groups of values that can be enumerated (e.g. arrays, collections or strings.)

Author:
Yvonne Wang, Alex Ruiz

Method Summary
 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 usingDefaultElementComparator()
          Revert to standard comparison for incoming assertion group element checks.
 S usingElementComparator(Comparator<? super T> customComparator)
          Use given custom comparator instead of relying on actual type A equals method to compare group elements for incoming assertion checks.
 

Method Detail

isNullOrEmpty

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

Throws:
AssertionError - if the actual group of values is not null or not empty.

isEmpty

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

Throws:
AssertionError - if the actual group of values is not empty.

isNotEmpty

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

Returns:
this assertion object.
Throws:
AssertionError - if the actual group of values is empty.

hasSize

S hasSize(int expected)
Verifies that the number of values in the actual group is equal to the given one.

Parameters:
expected - the expected number of values in the actual group.
Returns:
this assertion object.
Throws:
AssertionError - if the number of values of the actual group is not equal to the given one.

usingElementComparator

S usingElementComparator(Comparator<? super T> 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.
Throws:
NullPointerException - if the given comparator is null.

usingDefaultElementComparator

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 usingElementComparator(Comparator).

Returns:
this assertion object.


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