Package org.assertj.core.api
Class MapAssert<KEY,VALUE>
java.lang.Object
org.assertj.core.api.AbstractAssert<MapAssert<KEY,VALUE>,Map<KEY,VALUE>>
org.assertj.core.api.AbstractObjectAssert<MapAssert<KEY,VALUE>,Map<KEY,VALUE>>
org.assertj.core.api.AbstractMapAssert<MapAssert<KEY,VALUE>,Map<KEY,VALUE>,KEY,VALUE>
org.assertj.core.api.MapAssert<KEY,VALUE>
- All Implemented Interfaces:
Assert<MapAssert<KEY,
,VALUE>, Map<KEY, VALUE>> Descriptable<MapAssert<KEY,
,VALUE>> EnumerableAssert<MapAssert<KEY,
,VALUE>, Map.Entry<? extends KEY, ? extends VALUE>> ExtensionPoints<MapAssert<KEY,
VALUE>, Map<KEY, VALUE>>
public class MapAssert<KEY,VALUE>
extends AbstractMapAssert<MapAssert<KEY,VALUE>,Map<KEY,VALUE>,KEY,VALUE>
Assertions for
Map
s.
To create a new instance of this class, invoke
.
Assertions.assertThat(Map)
-
Field Summary
Fields inherited from class org.assertj.core.api.AbstractMapAssert
maps
Fields inherited from class org.assertj.core.api.AbstractAssert
actual, conditions, info, myself, objects
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionVerifies that the actual map contains the given entries, in any order.containsAnyOf
(Map.Entry<? extends KEY, ? extends VALUE>... entries) Verifies that the actual map contains at least one of the given entries.containsExactly
(Map.Entry<? extends KEY, ? extends VALUE>... entries) Verifies that the actual map contains only the given entries and nothing else, in order.
This assertion should only be used with maps that have a consistent iteration order (i.e.containsKeys
(KEY... keys) Verifies that the actual map contains the given keys.containsOnly
(Map.Entry<? extends KEY, ? extends VALUE>... entries) Verifies that the actual map contains only the given entries and nothing else, in any order.containsOnlyKeys
(KEY... keys) Verifies that the actual map contains only the given keys and nothing else, in any order.containsValues
(VALUE... values) Verifies that the actual map contains the given values.doesNotContain
(Map.Entry<? extends KEY, ? extends VALUE>... entries) Verifies that the actual map does not contain the given entries.doesNotContainKeys
(KEY... keys) Verifies that the actual map does not contain any of the given keys.Methods inherited from class org.assertj.core.api.AbstractMapAssert
as, as, containsAllEntriesOf, containsEntry, containsKey, containsValue, describedAs, describedAs, doesNotContainEntry, doesNotContainKey, doesNotContainValue, doesNotHave, doesNotHaveSameClassAs, extracting, has, hasEntrySatisfying, hasEntrySatisfying, hasEntrySatisfying, hasEntrySatisfying, hasKeySatisfying, hasSameClassAs, hasSameSizeAs, hasSameSizeAs, hasSameSizeAs, hasSize, hasToString, hasValueSatisfying, is, isEmpty, isEqualTo, isExactlyInstanceOf, isIn, isIn, isInstanceOf, isInstanceOfAny, isNot, isNotEmpty, isNotEqualTo, isNotExactlyInstanceOf, isNotIn, isNotIn, isNotInstanceOf, isNotInstanceOfAny, isNotNull, isNotOfAnyClassIn, isNotSameAs, isNullOrEmpty, isOfAnyClassIn, isSameAs, overridingErrorMessage, size, usingComparator, usingDefaultComparator, usingDefaultElementComparator, usingElementComparator, withFailMessage, withThreadDumpOnError
Methods inherited from class org.assertj.core.api.AbstractObjectAssert
defaultTypeComparators, extracting, hasFieldOrProperty, hasFieldOrPropertyWithValue, hasNoNullFieldsOrProperties, hasNoNullFieldsOrPropertiesExcept, isEqualToComparingFieldByField, isEqualToComparingFieldByFieldRecursively, isEqualToComparingOnlyGivenFields, isEqualToIgnoringGivenFields, isEqualToIgnoringNullFields, returns, usingComparatorForFields, usingComparatorForType
Methods inherited from class org.assertj.core.api.AbstractAssert
asList, asString, descriptionText, equals, failWithMessage, getWritableAssertionInfo, hashCode, inBinary, inHexadecimal, isInstanceOfSatisfying, isNull, matches, matches, satisfies, setCustomRepresentation, throwAssertionError, withRepresentation
-
Constructor Details
-
MapAssert
-
-
Method Details
-
contains
@SafeVarargs public final MapAssert<KEY,VALUE> contains(Map.Entry<? extends KEY, ? extends VALUE>... entries) Description copied from class:AbstractMapAssert
Verifies that the actual map contains the given entries, in any order.This assertion succeeds if both actual map and given entries are empty.
Example :
Map<Ring, TolkienCharacter> ringBearers = new HashMap<>(); ringBearers.put(nenya, galadriel); ringBearers.put(narya, gandalf); ringBearers.put(vilya, elrond); ringBearers.put(oneRing, frodo); // assertions will pass assertThat(ringBearers).contains(entry(oneRing, frodo), entry(nenya, galadriel)); assertThat(emptyMap).contains(); // assertions will fail assertThat(ringBearers).contains(entry(oneRing, sauron)); assertThat(ringBearers).contains(entry(oneRing, sauron), entry(oneRing, aragorn)); assertThat(ringBearers).contains(entry(narya, gandalf), entry(oneRing, sauron));
-
containsAnyOf
@SafeVarargs public final MapAssert<KEY,VALUE> containsAnyOf(Map.Entry<? extends KEY, ? extends VALUE>... entries) Description copied from class:AbstractMapAssert
Verifies that the actual map contains at least one of the given entries.Example :
Map<Ring, TolkienCharacter> ringBearers = new HashMap<>(); ringBearers.put(nenya, galadriel); ringBearers.put(narya, gandalf); ringBearers.put(vilya, elrond); ringBearers.put(oneRing, frodo); // assertions will pass assertThat(ringBearers).containsAnyOf(entry(oneRing, frodo), entry(oneRing, sauron)); assertThat(emptyMap).containsAnyOf(); // assertion will fail assertThat(ringBearers).containsAnyOf(entry(oneRing, gandalf), entry(oneRing, aragorn));
- Overrides:
containsAnyOf
in classAbstractMapAssert<MapAssert<KEY,
VALUE>, Map<KEY, VALUE>, KEY, VALUE> - Parameters:
entries
- the given entries.- Returns:
this
assertion object.
-
containsOnly
@SafeVarargs public final MapAssert<KEY,VALUE> containsOnly(Map.Entry<? extends KEY, ? extends VALUE>... entries) Description copied from class:AbstractMapAssert
Verifies that the actual map contains only the given entries and nothing else, in any order.Examples :
Map<Ring, TolkienCharacter> ringBearers = new HashMap<>(); ringBearers.put(nenya, galadriel); ringBearers.put(narya, gandalf); ringBearers.put(vilya, elrond); ringBearers.put(oneRing, frodo); // 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 classAbstractMapAssert<MapAssert<KEY,
VALUE>, Map<KEY, VALUE>, KEY, VALUE> - Parameters:
entries
- the entries that should be in the actual map.
-
containsExactly
@SafeVarargs public final MapAssert<KEY,VALUE> containsExactly(Map.Entry<? extends KEY, ? extends VALUE>... 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 maps that have a consistent iteration order (i.e. don't use it withHashMap
, preferAbstractMapAssert.containsOnly(java.util.Map.Entry...)
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 order differ assertThat(ringBearers).containsExactly(entry(nenya, galadriel), entry(narya, gandalf), entry(oneRing, frodo));
- Overrides:
containsExactly
in classAbstractMapAssert<MapAssert<KEY,
VALUE>, Map<KEY, VALUE>, KEY, VALUE> - Parameters:
entries
- the given entries.
-
containsKeys
Description copied from class:AbstractMapAssert
Verifies that the actual map contains the given keys.Example :
Map<Ring, TolkienCharacter> ringBearers = new HashMap<>(); ringBearers.put(nenya, galadriel); ringBearers.put(narya, gandalf); ringBearers.put(oneRing, frodo); // assertions will pass assertThat(ringBearers).containsKeys(nenya, oneRing); // assertions will fail assertThat(ringBearers).containsKeys(vilya); assertThat(ringBearers).containsKeys(vilya, oneRing);
- Overrides:
containsKeys
in classAbstractMapAssert<MapAssert<KEY,
VALUE>, Map<KEY, VALUE>, KEY, VALUE> - Parameters:
keys
- the given keys
-
containsOnlyKeys
Description copied from class:AbstractMapAssert
Verifies that the actual map contains only the given keys and nothing else, in any order.Examples :
Map<Ring, TolkienCharacter> ringBearers = new HashMap<>(); ringBearers.put(nenya, galadriel); ringBearers.put(narya, gandalf); ringBearers.put(vilya, elrond); ringBearers.put(oneRing, frodo); // assertion will pass assertThat(ringBearers).containsOnlyKeys(oneRing, nenya, narya, vilya); // assertion will fail assertThat(ringBearers).containsOnlyKeys(oneRing, nenya);
- Overrides:
containsOnlyKeys
in classAbstractMapAssert<MapAssert<KEY,
VALUE>, Map<KEY, VALUE>, KEY, VALUE> - Parameters:
keys
- the given keys that should be in the actual map.
-
containsValues
Description copied from class:AbstractMapAssert
Verifies that the actual map contains the given values.Example :
Map<Ring, TolkienCharacter> ringBearers = new HashMap<>(); ringBearers.put(nenya, galadriel); ringBearers.put(narya, gandalf); ringBearers.put(vilya, elrond); ringBearers.put(oneRing, frodo); // assertion will pass assertThat(ringBearers).containsValues(frodo, galadriel); // assertions will fail assertThat(ringBearers).containsValues(sauron, aragorn); assertThat(ringBearers).containsValues(sauron, frodo);
- Overrides:
containsValues
in classAbstractMapAssert<MapAssert<KEY,
VALUE>, Map<KEY, VALUE>, KEY, VALUE> - Parameters:
values
- the values to look for in the actual map.
-
doesNotContainKeys
Description copied from class:AbstractMapAssert
Verifies that the actual map does not contain any of the given keys.Example :
Map<Ring, TolkienCharacter> elvesRingBearers = new HashMap<>(); elvesRingBearers.put(nenya, galadriel); elvesRingBearers.put(narya, gandalf); elvesRingBearers.put(vilya, elrond); // assertion will pass assertThat(elvesRingBearers).doesNotContainKeys(oneRing, someManRing); // assertions will fail assertThat(elvesRingBearers).doesNotContainKeys(vilya, nenya); assertThat(elvesRingBearers).doesNotContainKeys(vilya, oneRing);
- Overrides:
doesNotContainKeys
in classAbstractMapAssert<MapAssert<KEY,
VALUE>, Map<KEY, VALUE>, KEY, VALUE> - Parameters:
keys
- the given keys
-
doesNotContain
@SafeVarargs public final MapAssert<KEY,VALUE> doesNotContain(Map.Entry<? extends KEY, ? extends VALUE>... entries) Description copied from class:AbstractMapAssert
Verifies that the actual map does not contain the given entries.Example :
Map<Ring, TolkienCharacter> ringBearers = new HashMap<>(); ringBearers.put(nenya, galadriel); ringBearers.put(narya, gandalf); ringBearers.put(vilya, elrond); ringBearers.put(oneRing, frodo); // assertion will pass assertThat(ringBearers).doesNotContain(entry(oneRing, aragorn), entry(oneRing, sauron)); // assertions will fail assertThat(ringBearers).doesNotContain(entry(oneRing, frodo)); assertThat(ringBearers).doesNotContain(entry(oneRing, frodo), entry(oneRing, aragorn));
- Overrides:
doesNotContain
in classAbstractMapAssert<MapAssert<KEY,
VALUE>, Map<KEY, VALUE>, KEY, VALUE> - Parameters:
entries
- the given entries.- Returns:
this
assertion object.
-