Package org.assertj.core.internal
Class Maps
- java.lang.Object
-
- org.assertj.core.internal.Maps
-
public class Maps extends java.lang.Object
Reusable assertions for
s.Map
-
-
Field Summary
Fields Modifier and Type Field Description (package private) Conditions
conditions
(package private) Failures
failures
private static Maps
INSTANCE
-
Constructor Summary
Constructors Constructor Description Maps()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description <K,V>
voidassertContains(AssertionInfo info, java.util.Map<K,V> actual, java.util.Map.Entry<? extends K,? extends V>[] entries)
Asserts that the givenMap
contains the given entries, in any order.<K,V>
voidassertContainsAnyOf(AssertionInfo info, java.util.Map<K,V> actual, java.util.Map.Entry<? extends K,? extends V>[] entries)
<K,V>
voidassertContainsExactly(AssertionInfo info, java.util.Map<K,V> actual, java.util.Map.Entry<? 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.<K,V>
voidassertContainsKeys(AssertionInfo info, java.util.Map<K,V> actual, K... keys)
Verifies that the actual map contain the given key.<K,V>
voidassertContainsOnly(AssertionInfo info, java.util.Map<K,V> actual, java.util.Map.Entry<? extends K,? extends V>... entries)
Verifies that the actual map contains only the given entries and nothing else, in any order.<K,V>
voidassertContainsOnlyKeys(AssertionInfo info, java.util.Map<K,V> actual, K... keys)
Verifies that the actual map contains only the given keys and nothing else, in any order.<K,V>
voidassertContainsValue(AssertionInfo info, java.util.Map<K,V> actual, V value)
Verifies that the actual map contain the given value.<K,V>
voidassertContainsValues(AssertionInfo info, java.util.Map<K,V> actual, V... values)
Verifies that the actual map contain the given values.<K,V>
voidassertDoesNotContain(AssertionInfo info, java.util.Map<K,V> actual, java.util.Map.Entry<? extends K,? extends V>[] entries)
Asserts that the givenMap
does not contain the given entries.<K,V>
voidassertDoesNotContainKey(AssertionInfo info, java.util.Map<K,V> actual, K key)
Verifies that the actual map not contains the given key.<K,V>
voidassertDoesNotContainKeys(AssertionInfo info, java.util.Map<K,V> actual, K... keys)
Verifies that the actual map not contains all the given keys.<K,V>
voidassertDoesNotContainValue(AssertionInfo info, java.util.Map<K,V> actual, V value)
Verifies that the actual map not contains the given value.void
assertEmpty(AssertionInfo info, java.util.Map<?,?> actual)
Asserts that the givenMap
is empty.<K,V>
voidassertHasEntrySatisfying(AssertionInfo info, java.util.Map<K,V> actual, K key, java.util.function.Consumer<? super V> valueRequirements)
Verifies that theMap
contains the value for givenkey
that satisfy givenvalueRequirements
.<K,V>
voidassertHasEntrySatisfying(AssertionInfo info, java.util.Map<K,V> actual, K key, Condition<? super V> valueCondition)
Verifies that the givenMap
contains the value for givenkey
that satisfy givenvalueCondition
.<K,V>
voidassertHasEntrySatisfying(AssertionInfo info, java.util.Map<K,V> actual, Condition<? super java.util.Map.Entry<K,V>> entryCondition)
Verifies that the givenMap
contains an entry satisfying givenentryCondition
.<K,V>
voidassertHasEntrySatisfyingConditions(AssertionInfo info, java.util.Map<K,V> actual, Condition<? super K> keyCondition, Condition<? super V> valueCondition)
Verifies that the givenMap
contains an entry with key satisfyingkeyCondition
and value satisfyingvalueCondition
.<K> void
assertHasKeySatisfying(AssertionInfo info, java.util.Map<K,?> actual, Condition<? super K> keyCondition)
Verifies that the givenMap
contains an entry with key satisfyingkeyCondition
.void
assertHasSameSizeAs(AssertionInfo info, java.util.Map<?,?> map, java.lang.Iterable<?> other)
Asserts that the number of entries in the givenMap
has the same size as the otherIterable
.void
assertHasSameSizeAs(AssertionInfo info, java.util.Map<?,?> map, java.lang.Object other)
Asserts that the number of entries in the givenMap
has the same size as the other array.void
assertHasSameSizeAs(AssertionInfo info, java.util.Map<?,?> map, java.util.Map<?,?> other)
Asserts that the size of the givenMap
is equal to the size of the otherMap
.void
assertHasSize(AssertionInfo info, java.util.Map<?,?> actual, int expectedSize)
Asserts that the number of entries in the givenMap
is equal to the expected one.<V> void
assertHasValueSatisfying(AssertionInfo info, java.util.Map<?,V> actual, Condition<? super V> valueCondition)
Verifies that the givenMap
contains an entry with value satisfyingvalueCondition
.void
assertNotEmpty(AssertionInfo info, java.util.Map<?,?> actual)
Asserts that the givenMap
is not empty.private void
assertNotNull(AssertionInfo info, java.util.Map<?,?> actual)
void
assertNullOrEmpty(AssertionInfo info, java.util.Map<?,?> actual)
Asserts that the givenMap
isnull
or empty.private <K,V>
voidcompareActualMapAndExpectedEntries(java.util.Map<K,V> actual, java.util.Map.Entry<? extends K,? extends V>[] entries, java.util.Set<java.util.Map.Entry<? extends K,? extends V>> notExpected, java.util.Set<java.util.Map.Entry<? extends K,? extends V>> notFound)
private <K,V>
voidcompareActualMapAndExpectedKeys(java.util.Map<K,V> actual, K[] keys, java.util.Set<K> notExpected, java.util.Set<K> notFound)
private <K,V>
booleancontainsEntry(java.util.Map<K,V> actual, java.util.Map.Entry<? extends K,? extends V> entry)
private <K,V>
voiddoCommonContainsCheck(AssertionInfo info, java.util.Map<K,V> actual, java.util.Map.Entry<? extends K,? extends V>[] entries)
private static <K,V>
java.util.Map<K,V>entriesToMap(java.util.Map.Entry<? extends K,? extends V>[] entries)
private static <K,V>
voidfailIfEmpty(java.util.Map.Entry<? extends K,? extends V>[] entries)
private static <K> void
failIfEmpty(K[] keys)
private static <K,V>
voidfailIfEmptySinceActualIsNotEmpty(java.util.Map.Entry<? extends K,? extends V>[] values)
private static <K,V>
voidfailIfNull(java.util.Map.Entry<? extends K,? extends V>[] entries)
private static <K> void
failIfNull(K[] keys)
private static <K,V>
voidfailIfNullOrEmpty(java.util.Map.Entry<? extends K,? extends V>[] entries)
static Maps
instance()
Returns the singleton instance of this class.
-
-
-
Field Detail
-
INSTANCE
private static final Maps INSTANCE
-
failures
Failures failures
-
conditions
Conditions conditions
-
-
Method Detail
-
instance
public static Maps instance()
Returns the singleton instance of this class.- Returns:
- the singleton instance of this class.
-
assertNullOrEmpty
public void assertNullOrEmpty(AssertionInfo info, java.util.Map<?,?> actual)
Asserts that the givenMap
isnull
or empty.- Parameters:
info
- contains information about the assertion.actual
- the given map.- Throws:
java.lang.AssertionError
- if the givenMap
is notnull
*and* contains one or more entries.
-
assertEmpty
public void assertEmpty(AssertionInfo info, java.util.Map<?,?> actual)
Asserts that the givenMap
is empty.- Parameters:
info
- contains information about the assertion.actual
- the givenMap
.- Throws:
java.lang.AssertionError
- if the givenMap
isnull
.java.lang.AssertionError
- if the givenMap
is not empty.
-
assertNotEmpty
public void assertNotEmpty(AssertionInfo info, java.util.Map<?,?> actual)
Asserts that the givenMap
is not empty.- Parameters:
info
- contains information about the assertion.actual
- the givenMap
.- Throws:
java.lang.AssertionError
- if the givenMap
isnull
.java.lang.AssertionError
- if the givenMap
is empty.
-
assertHasSize
public void assertHasSize(AssertionInfo info, java.util.Map<?,?> actual, int expectedSize)
Asserts that the number of entries in the givenMap
is equal to the expected one.- Parameters:
info
- contains information about the assertion.actual
- the givenMap
.expectedSize
- the expected size ofactual
.- Throws:
java.lang.AssertionError
- if the givenMap
isnull
.java.lang.AssertionError
- if the number of entries in the givenMap
is different than the expected one.
-
assertHasSameSizeAs
public void assertHasSameSizeAs(AssertionInfo info, java.util.Map<?,?> map, java.lang.Iterable<?> other)
Asserts that the number of entries in the givenMap
has the same size as the otherIterable
.- Parameters:
info
- contains information about the assertion.map
- the givenMap
.other
- the group to compare- Throws:
java.lang.AssertionError
- if the givenMap
isnull
.java.lang.AssertionError
- if the givenIterable
isnull
.java.lang.AssertionError
- if the number of entries in the givenMap
does not have the same size.
-
assertHasSameSizeAs
public void assertHasSameSizeAs(AssertionInfo info, java.util.Map<?,?> map, java.lang.Object other)
Asserts that the number of entries in the givenMap
has the same size as the other array.- Parameters:
info
- contains information about the assertion.map
- the givenMap
.other
- the group to compare- Throws:
java.lang.AssertionError
- if the givenMap
isnull
.java.lang.AssertionError
- if the given array isnull
.java.lang.AssertionError
- if the number of entries in the givenMap
does not have the same size.
-
assertHasSameSizeAs
public void assertHasSameSizeAs(AssertionInfo info, java.util.Map<?,?> map, java.util.Map<?,?> other)
Asserts that the size of the givenMap
is equal to the size of the otherMap
.- Parameters:
info
- contains information about the assertion.map
- the givenMap
.other
- the otherMap
to compare- Throws:
java.lang.NullPointerException
- if the otherMap
isnull
.java.lang.AssertionError
- if the givenMap
isnull
.java.lang.AssertionError
- if the size of the givenMap
is not equal to the otherMap
size
-
assertContains
public <K,V> void assertContains(AssertionInfo info, java.util.Map<K,V> actual, java.util.Map.Entry<? extends K,? extends V>[] entries)
Asserts that the givenMap
contains the given entries, in any order.- Parameters:
info
- contains information about the assertion.actual
- the givenMap
.entries
- the entries that are expected to be in the givenMap
.- Throws:
java.lang.NullPointerException
- if the array of entries isnull
.java.lang.IllegalArgumentException
- if the array of entries is empty.java.lang.NullPointerException
- if any of the entries in the given array isnull
.java.lang.AssertionError
- if the givenMap
isnull
.java.lang.AssertionError
- if the givenMap
does not contain the given entries.
-
assertContainsAnyOf
public <K,V> void assertContainsAnyOf(AssertionInfo info, java.util.Map<K,V> actual, java.util.Map.Entry<? extends K,? extends V>[] entries)
-
assertHasEntrySatisfying
public <K,V> void assertHasEntrySatisfying(AssertionInfo info, java.util.Map<K,V> actual, K key, Condition<? super V> valueCondition)
Verifies that the givenMap
contains the value for givenkey
that satisfy givenvalueCondition
.- Parameters:
info
- contains information about the assertion.actual
- the givenMap
.key
- he given key to check.valueCondition
- the given condition for check value.- Throws:
java.lang.NullPointerException
- if the given values isnull
.java.lang.AssertionError
- if the actual map isnull
.java.lang.AssertionError
- if the actual map not contains the givenkey
.java.lang.AssertionError
- if the actual map contains the given key, but value not match the givenvalueCondition
.- Since:
- 2.6.0 / 3.6.0
-
assertHasEntrySatisfying
public <K,V> void assertHasEntrySatisfying(AssertionInfo info, java.util.Map<K,V> actual, K key, java.util.function.Consumer<? super V> valueRequirements)
Verifies that theMap
contains the value for givenkey
that satisfy givenvalueRequirements
.- Parameters:
info
- contains information about the assertion.actual
- the givenMap
.key
- he given key to check.valueRequirements
- the given requirements for check value.- Throws:
java.lang.NullPointerException
- if the given values isnull
.java.lang.AssertionError
- if the actual map isnull
.java.lang.AssertionError
- if the actual map not contains the givenkey
.java.lang.AssertionError
- if the actual map contains the given key, but value not pass the givenvalueRequirements
.
-
assertHasEntrySatisfying
public <K,V> void assertHasEntrySatisfying(AssertionInfo info, java.util.Map<K,V> actual, Condition<? super java.util.Map.Entry<K,V>> entryCondition)
Verifies that the givenMap
contains an entry satisfying givenentryCondition
.- Parameters:
info
- contains information about the assertion.actual
- the givenMap
.entryCondition
- the condition for searching entry.- Throws:
java.lang.NullPointerException
- if the given condition isnull
.java.lang.AssertionError
- if the actual map isnull
.java.lang.AssertionError
- if there is no entry matching givenentryCondition
.- Since:
- 2.7.0 / 3.7.0
-
assertHasEntrySatisfyingConditions
public <K,V> void assertHasEntrySatisfyingConditions(AssertionInfo info, java.util.Map<K,V> actual, Condition<? super K> keyCondition, Condition<? super V> valueCondition)
Verifies that the givenMap
contains an entry with key satisfyingkeyCondition
and value satisfyingvalueCondition
.- Parameters:
info
- contains information about the assertion.actual
- the givenMap
.keyCondition
- the condition for entry key.valueCondition
- the condition for entry value.- Throws:
java.lang.NullPointerException
- if any of the given conditions isnull
.java.lang.AssertionError
- if the actual map isnull
.java.lang.AssertionError
- if there is no entry matching givenkeyCondition
andvalueCondition
.- Since:
- 2.7.0 / 3.7.0
-
assertHasKeySatisfying
public <K> void assertHasKeySatisfying(AssertionInfo info, java.util.Map<K,?> actual, Condition<? super K> keyCondition)
Verifies that the givenMap
contains an entry with key satisfyingkeyCondition
.- Parameters:
info
- contains information about the assertion.actual
- the givenMap
.keyCondition
- the condition for key search.- Throws:
java.lang.NullPointerException
- if the given condition isnull
.java.lang.AssertionError
- if the actual map isnull
.java.lang.AssertionError
- if there is no key matching givenkeyCondition
.- Since:
- 2.7.0 / 3.7.0
-
assertHasValueSatisfying
public <V> void assertHasValueSatisfying(AssertionInfo info, java.util.Map<?,V> actual, Condition<? super V> valueCondition)
Verifies that the givenMap
contains an entry with value satisfyingvalueCondition
.- Parameters:
info
- contains information about the assertion.actual
- the givenMap
.valueCondition
- the condition for value search.- Throws:
java.lang.NullPointerException
- if the given condition isnull
.java.lang.AssertionError
- if the actual map isnull
.java.lang.AssertionError
- if there is no value matching givenvalueCondition
.- Since:
- 2.7.0 / 3.7.0
-
assertDoesNotContain
public <K,V> void assertDoesNotContain(AssertionInfo info, java.util.Map<K,V> actual, java.util.Map.Entry<? extends K,? extends V>[] entries)
Asserts that the givenMap
does not contain the given entries.- Parameters:
info
- contains information about the assertion.actual
- the givenMap
.entries
- the entries that are expected to be in the givenMap
.- Throws:
java.lang.NullPointerException
- if the array of entries isnull
.java.lang.IllegalArgumentException
- if the array of entries is empty.java.lang.NullPointerException
- if any of the entries in the given array isnull
.java.lang.AssertionError
- if the givenMap
isnull
.java.lang.AssertionError
- if the givenMap
contains any of the given entries.
-
assertContainsKeys
public <K,V> void assertContainsKeys(AssertionInfo info, java.util.Map<K,V> actual, K... keys)
Verifies that the actual map contain the given key.- Parameters:
info
- contains information about the assertion.actual
- the givenMap
.keys
- the given keys- Throws:
java.lang.AssertionError
- if the actual map isnull
.java.lang.AssertionError
- if the actual map not contains the given key.
-
assertDoesNotContainKey
public <K,V> void assertDoesNotContainKey(AssertionInfo info, java.util.Map<K,V> actual, K key)
Verifies that the actual map not contains the given key.- Parameters:
info
- contains information about the assertion.actual
- the givenMap
.key
- the given key- Throws:
java.lang.AssertionError
- if the actual map isnull
.java.lang.AssertionError
- if the actual map contains the given key.
-
assertDoesNotContainKeys
public <K,V> void assertDoesNotContainKeys(AssertionInfo info, java.util.Map<K,V> actual, K... keys)
Verifies that the actual map not contains all the given keys.- Parameters:
info
- contains information about the assertion.actual
- the givenMap
.keys
- the given keys- Throws:
java.lang.AssertionError
- if the actual map isnull
.java.lang.AssertionError
- if the actual map contains all the given keys.
-
assertContainsOnlyKeys
public <K,V> void assertContainsOnlyKeys(AssertionInfo info, java.util.Map<K,V> actual, K... keys)
Verifies that the actual map contains only the given keys and nothing else, in any order.- Parameters:
info
- contains information about the assertion.actual
- the givenMap
.keys
- the keys that are expected to be in the givenMap
.- Throws:
java.lang.NullPointerException
- if the array of keys isnull
.java.lang.IllegalArgumentException
- if the array of keys is empty.java.lang.AssertionError
- if the givenMap
isnull
.java.lang.AssertionError
- if the givenMap
does not contain the given keys or if the givenMap
contains keys that are not in the given array.
-
assertContainsValue
public <K,V> void assertContainsValue(AssertionInfo info, java.util.Map<K,V> actual, V value)
Verifies that the actual map contain the given value.- Parameters:
info
- contains information about the assertion.actual
- the givenMap
.value
- the given value- Throws:
java.lang.AssertionError
- if the actual map isnull
.java.lang.AssertionError
- if the actual map not contains the given value.
-
assertContainsValues
public <K,V> void assertContainsValues(AssertionInfo info, java.util.Map<K,V> actual, V... values)
Verifies that the actual map contain the given values.- Parameters:
info
- contains information about the assertion.actual
- the givenMap
.values
- the given values- Throws:
java.lang.AssertionError
- if the actual map isnull
.java.lang.AssertionError
- if the actual map not contains the given values.java.lang.NullPointerException
- if values vararg isnull
.
-
assertDoesNotContainValue
public <K,V> void assertDoesNotContainValue(AssertionInfo info, java.util.Map<K,V> actual, V value)
Verifies that the actual map not contains the given value.- Parameters:
info
- contains information about the assertion.actual
- the givenMap
.value
- the given value- Throws:
java.lang.AssertionError
- if the actual map isnull
.java.lang.AssertionError
- if the actual map contains the given value.
-
assertContainsOnly
public <K,V> void assertContainsOnly(AssertionInfo info, java.util.Map<K,V> actual, java.util.Map.Entry<? extends K,? extends V>... entries)
Verifies that the actual map contains only the given entries and nothing else, in any order.- Parameters:
info
- contains information about the assertion.actual
- the givenMap
.entries
- the entries that should be in the actual map.- Throws:
java.lang.AssertionError
- if the actual map isnull
.java.lang.NullPointerException
- if the given entries array isnull
.java.lang.IllegalArgumentException
- if the given entries array is empty.java.lang.AssertionError
- if the actual map does not contain the given entries, i.e. the actual map contains some or none of the given entries, or the actual map contains more entries than the given ones.
-
assertContainsExactly
public <K,V> void assertContainsExactly(AssertionInfo info, java.util.Map<K,V> actual, java.util.Map.Entry<? 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. don't use it withHashMap
).- Parameters:
info
- contains information about the assertion.actual
- the givenMap
.entries
- the given entries.- Throws:
java.lang.NullPointerException
- if the given entries array isnull
.java.lang.AssertionError
- if the actual map isnull
.java.lang.IllegalArgumentException
- if the given entries array is empty.java.lang.AssertionError
- if the actual map does not contain the given entries with same order, i.e. the actual map contains some or none of the given entries, or the actual map contains more entries than the given ones or entries are the same but the order is not.
-
compareActualMapAndExpectedKeys
private <K,V> void compareActualMapAndExpectedKeys(java.util.Map<K,V> actual, K[] keys, java.util.Set<K> notExpected, java.util.Set<K> notFound)
-
compareActualMapAndExpectedEntries
private <K,V> void compareActualMapAndExpectedEntries(java.util.Map<K,V> actual, java.util.Map.Entry<? extends K,? extends V>[] entries, java.util.Set<java.util.Map.Entry<? extends K,? extends V>> notExpected, java.util.Set<java.util.Map.Entry<? extends K,? extends V>> notFound)
-
doCommonContainsCheck
private <K,V> void doCommonContainsCheck(AssertionInfo info, java.util.Map<K,V> actual, java.util.Map.Entry<? extends K,? extends V>[] entries)
-
entriesToMap
private static <K,V> java.util.Map<K,V> entriesToMap(java.util.Map.Entry<? extends K,? extends V>[] entries)
-
failIfEmpty
private static <K> void failIfEmpty(K[] keys)
-
failIfEmpty
private static <K,V> void failIfEmpty(java.util.Map.Entry<? extends K,? extends V>[] entries)
-
failIfNullOrEmpty
private static <K,V> void failIfNullOrEmpty(java.util.Map.Entry<? extends K,? extends V>[] entries)
-
failIfNull
private static <K> void failIfNull(K[] keys)
-
failIfNull
private static <K,V> void failIfNull(java.util.Map.Entry<? extends K,? extends V>[] entries)
-
containsEntry
private <K,V> boolean containsEntry(java.util.Map<K,V> actual, java.util.Map.Entry<? extends K,? extends V> entry)
-
assertNotNull
private void assertNotNull(AssertionInfo info, java.util.Map<?,?> actual)
-
failIfEmptySinceActualIsNotEmpty
private static <K,V> void failIfEmptySinceActualIsNotEmpty(java.util.Map.Entry<? extends K,? extends V>[] values)
-
-