org.assertj.core.api

Class MapAssert<K,V>

java.lang.Object

org.assertj.core.api.AbstractAssert<S,A>

org.assertj.core.api.AbstractMapAssert<MapAssert<K,V>,Map<K,V>,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<? extends K,? extends V>>, ExtensionPoints<MapAssert<K,V>,Map<K,V>>

public class MapAssert<K,V>
extends AbstractMapAssert<MapAssert<K,V>,Map<K,V>,K,V>

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<? extends K,? extends V>... entries) Verifies that the actual map contains the given entries, in any order.
MapAssert<K,V>	containsExactly(MapEntry<? extends K,? extends V>... entries) Verifies that the actual map contains only the given entries and nothing else, in order. This assertion should only be used with map that have a consistent iteration order (i.e.
MapAssert<K,V>	containsKeys(K... keys) Verifies that the actual map contains the given keys.
MapAssert<K,V>	containsOnly(MapEntry<? extends K,? extends V>... entries) Verifies that the actual map contains only the given entries and nothing else, in any order.
MapAssert<K,V>	containsOnlyKeys(K... keys) Verifies that the actual map contains only the given keys and nothing else, in any order.
MapAssert<K,V>	containsValues(V... values) Verifies that the actual map contains the given values.
MapAssert<K,V>	doesNotContain(MapEntry<? extends K,? extends V>... entries) Verifies that the actual map does not contain the given entries.
MapAssert<K,V>	doesNotContainKeys(K... keys) Verifies that the actual map does not contain any of the given keys.

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

containsEntry, containsKey, containsValue, doesNotContainEntry, doesNotContainKey, doesNotContainValue, hasSameSizeAs, hasSameSizeAs, hasSameSizeAs, hasSize, isEmpty, isNotEmpty, isNullOrEmpty, usingDefaultElementComparator, usingElementComparator

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

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

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

contains

@SafeVarargs
public final MapAssert<K,V> contains(MapEntry<? extends K,? extends V>... entries)

Description copied from class: AbstractMapAssert

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

Example :

 Map ringBearers = ... // init with elves rings and the one ring
 
 assertThat(ringBearers).contains(entry(oneRing, frodo), entry(nenya, galadriel));
 

Overrides:

contains in class AbstractMapAssert<MapAssert<K,V>,Map<K,V>,K,V>

Parameters:

entries - the given entries.

Returns:

this assertion object.

containsOnly

@SafeVarargs
public final MapAssert<K,V> containsOnly(MapEntry<? extends K,? extends V>... entries)

Description copied from class: AbstractMapAssert

Verifies that the actual map contains only the given entries and nothing else, in any order.

Examples :

 Map ringBearers = ... // init with elves rings and the one ring
 
 // assertion will pass
 assertThat(ringBearers).containsOnly(entry(oneRing, frodo), entry(nenya, galadriel), entry(narya, gandalf), entry(vilya, elrond));
 
 // assertion will fail
 assertThat(ringBearers).containsOnly(entry(oneRing, frodo), entry(nenya, galadriel));
 

Overrides:

containsOnly in class AbstractMapAssert<MapAssert<K,V>,Map<K,V>,K,V>

Parameters:

entries - the entries that should be in the actual map.

containsExactly

@SafeVarargs
public final MapAssert<K,V> containsExactly(MapEntry<? extends K,? extends V>... entries)

Description copied from class: AbstractMapAssert

Verifies that the actual map contains only the given entries and nothing else, in order.
This assertion should only be used with map that have a consistent iteration order (i.e. don't use it with HashMap, prefer AbstractMapAssert.containsOnly(org.assertj.core.data.MapEntry...) in that case).

Example :

 Map<Ring, TolkienCharacter> ringBearers = newLinkedHashMap(entry(oneRing, frodo), entry(nenya, galadriel),
                                                            entry(narya, gandalf));
 
 // assertion will pass
 assertThat(ringBearers).containsExactly(entry(oneRing, frodo), entry(nenya, galadriel), entry(narya, gandalf));
 
 // assertion will fail as actual and expected orders differ.
 assertThat(ringBearers).containsExactly(entry(nenya, galadriel), entry(narya, gandalf), entry(oneRing, frodo));
 

Overrides:

containsExactly in class AbstractMapAssert<MapAssert<K,V>,Map<K,V>,K,V>

Parameters:

entries - the given entries.

containsKeys

@SafeVarargs
public final MapAssert<K,V> containsKeys(K... keys)

Description copied from class: AbstractMapAssert

Verifies that the actual map contains the given keys.

Example :

 Map ringBearers = ... // init with elves rings and the one ring
 
 assertThat(ringBearers).containsKeys(nenya, oneRing);
 

Overrides:

containsKeys in class AbstractMapAssert<MapAssert<K,V>,Map<K,V>,K,V>

Parameters:

keys - the given keys

containsOnlyKeys

@SafeVarargs
public final MapAssert<K,V> containsOnlyKeys(K... keys)

Description copied from class: AbstractMapAssert

Verifies that the actual map contains only the given keys and nothing else, in any order.

Examples :

 Map ringBearers = ... // init with elves rings and the one ring
 
 // assertion will pass
 assertThat(ringBearers).containsOnlyKeys(oneRing, nenya, narya, vilya);
 
 // assertion will fail
 assertThat(ringBearers).containsOnlyKeys(oneRing, nenya);
 

Overrides:

containsOnlyKeys in class AbstractMapAssert<MapAssert<K,V>,Map<K,V>,K,V>

Parameters:

keys - the given keys that should be in the actual map.

containsValues

@SafeVarargs
public final MapAssert<K,V> containsValues(V... values)

Description copied from class: AbstractMapAssert

Verifies that the actual map contains the given values.

Example :

 Map ringBearers = ... // init with elves rings and the one ring

 assertThat(ringBearers).containsValues(frodo, galadriel);
 

Overrides:

containsValues in class AbstractMapAssert<MapAssert<K,V>,Map<K,V>,K,V>

Parameters:

values - the values to look for in the actual map.

doesNotContainKeys

@SafeVarargs
public final MapAssert<K,V> doesNotContainKeys(K... keys)

Description copied from class: AbstractMapAssert

Verifies that the actual map does not contain any of the given keys.

Example :

 Map ringBearers = ... // init with elves rings only
 
 assertThat(ringBearers).doesNotContainKeys(oneRing, someManRing);
 

Overrides:

doesNotContainKeys in class AbstractMapAssert<MapAssert<K,V>,Map<K,V>,K,V>

doesNotContain

@SafeVarargs
public final MapAssert<K,V> doesNotContain(MapEntry<? extends K,? extends V>... entries)

Description copied from class: AbstractMapAssert

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

Example :

 Map ringBearers = ... // init omitted
 assertThat(ringBearers).doesNotContain(entry(oneRing, aragorn));
 

Overrides:

doesNotContain in class AbstractMapAssert<MapAssert<K,V>,Map<K,V>,K,V>

Parameters:

entries - the given entries.

Returns:

this assertion object.