org.assertj.core.api

Class MapAssert<K,V>

java.lang.Object

org.assertj.core.api.AbstractAssert<MapAssert<K,V>,Map<K,V>>

org.assertj.core.api.MapAssert<K,V>

All Implemented Interfaces:

Assert<MapAssert<K,V>,Map<K,V>>, Descriptable<MapAssert<K,V>>, EnumerableAssert<MapAssert<K,V>,MapEntry>, ExtensionPoints<MapAssert<K,V>,Map<K,V>>

public class MapAssert<K,V>
extends AbstractAssert<MapAssert<K,V>,Map<K,V>>
implements EnumerableAssert<MapAssert<K,V>,MapEntry>

Assertions for Maps.

To create a new instance of this class, invoke Assertions.assertThat(Map).

Author:

David DIDIER, Yvonne Wang, Alex Ruiz, Mikhail Mazursky, Nicolas François

Field Summary

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

actual, info, myself

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MapAssert(Map<K,V> actual)

Method Summary

Methods

Modifier and Type	Method and Description
MapAssert<K,V>	contains(MapEntry... entries) Verifies that the actual map contains the given entries, in any order.
MapAssert<K,V>	containsKey(K key) Verifies that the actual map contains the given key.
MapAssert<K,V>	containsValue(V value) Verifies that the actual map contains the given value.
MapAssert<K,V>	doesNotContain(MapEntry... entries) Verifies that the actual map does not contain the given entries.
MapAssert<K,V>	doesNotContainKey(K key) Verifies that the actual map does not contain the given key.
MapAssert<K,V>	doesNotContainValue(V value) Verifies that the actual map does not contain the given value.
MapAssert<K,V>	hasSameSizeAs(Iterable<?> other) Verifies that the actual group has the same size as given Iterable.
MapAssert<K,V>	hasSameSizeAs(Object[] other) Verifies that the actual group has the same size as given array.
MapAssert<K,V>	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.
MapAssert<K,V>	isNotEmpty() Verifies that the actual group of values is not empty.
void	isNullOrEmpty() Verifies that the actual group of values is null or empty.
MapAssert<K,V>	usingDefaultElementComparator() Revert to standard comparison for incoming assertion group element checks.
MapAssert<K,V>	usingElementComparator(Comparator<? super MapEntry> 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

Constructor Detail

MapAssert

protected MapAssert(Map<K,V> actual)

Method Detail

isNullOrEmpty

public void isNullOrEmpty()

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

Specified by:

isNullOrEmpty in interface EnumerableAssert<MapAssert<K,V>,MapEntry>

isEmpty

public void isEmpty()

Verifies that the actual group of values is empty.

Specified by:

isEmpty in interface EnumerableAssert<MapAssert<K,V>,MapEntry>

isNotEmpty

public MapAssert<K,V> isNotEmpty()

Verifies that the actual group of values is not empty.

Specified by:

isNotEmpty in interface EnumerableAssert<MapAssert<K,V>,MapEntry>

Returns:

this assertion object.

hasSize

public MapAssert<K,V> 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<MapAssert<K,V>,MapEntry>

Parameters:

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

Returns:

this assertion object.

hasSameSizeAs

public MapAssert<K,V> hasSameSizeAs(Object[] other)

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

Specified by:

hasSameSizeAs in interface EnumerableAssert<MapAssert<K,V>,MapEntry>

Parameters:

other - the array to compare size with actual group.

Returns:

this assertion object.

hasSameSizeAs

public MapAssert<K,V> hasSameSizeAs(Iterable<?> other)

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

Specified by:

hasSameSizeAs in interface EnumerableAssert<MapAssert<K,V>,MapEntry>

Parameters:

other - the Iterable to compare size with actual group.

Returns:

this assertion object.

contains

public MapAssert<K,V> contains(MapEntry... entries)

Verifies that the actual map contains the given entries, in any order.

Parameters:

entries - the given entries.

Returns:

this assertion object.

Throws:

NullPointerException - if the given argument is null.

IllegalArgumentException - if the given argument is an empty array.

NullPointerException - if any of the entries in the given array is null.

AssertionError - if the actual map is null.

AssertionError - if the actual map does not contain the given entries.

doesNotContain

public MapAssert<K,V> doesNotContain(MapEntry... entries)

Verifies that the actual map does not contain the given entries.

Parameters:

entries - the given entries.

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 map is null.

AssertionError - if the actual map contains any of the given entries.

containsKey

public MapAssert<K,V> containsKey(K key)

Verifies that the actual map contains the given key.

Parameters:

key - the given key

Throws:

AssertionError - if the actual map is null.

AssertionError - if the actual map does not contain the given key.

doesNotContainKey

public MapAssert<K,V> doesNotContainKey(K key)

Verifies that the actual map does not contain the given key.

Parameters:

key - the given key

Throws:

AssertionError - if the actual map is null.

AssertionError - if the actual map contains the given key.

containsValue

public MapAssert<K,V> containsValue(V value)

Verifies that the actual map contains the given value.

Parameters:

value - the value to look for.

Throws:

AssertionError - if the actual map is null.

AssertionError - if the actual map does not contain the given value.

doesNotContainValue

public MapAssert<K,V> doesNotContainValue(V value)

Verifies that the actual map does not contain the given value.

Parameters:

value - the value that should not be in actual map.

Throws:

AssertionError - if the actual map is null.

AssertionError - if the actual map contains the given value.

usingElementComparator

public MapAssert<K,V> usingElementComparator(Comparator<? super MapEntry> 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<MapAssert<K,V>,MapEntry>

Parameters:

customComparator - the comparator to use for incoming assertion checks.

Returns:

this assertion object.

usingDefaultElementComparator

public MapAssert<K,V> 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<MapAssert<K,V>,MapEntry>

Returns:

this assertion object.