Class MapSubject.UsingCorrespondence<A extends @Nullable Object, E extends @Nullable Object>

java.lang.Object

com.google.common.truth.MapSubject.UsingCorrespondence<A,E>

Enclosing class:

MapSubject

public static final class MapSubject.UsingCorrespondence<A extends @Nullable Object, E extends @Nullable Object>
extends Object

A partially specified check in which the actual values (i.e. the values of the Map under test) are compared to expected values using a Correspondence. The expected values are of type E. Call methods on this object to actually execute the check.

Note that keys will always be compared with regular object equality (Object.equals(java.lang.Object)).

Author:

Christian Gruber, Kurt Alfred Kluever

Method Summary

Modifier and Type	Method	Description
Ordered	containsAtLeast(@Nullable Object k0, @Nullable E v0, @Nullable Object... rest)	Checks that the actual map contains at least the given set of keys mapping to values that correspond to the given values.
Ordered	containsAtLeastEntriesIn(Map<?, ? extends E> expectedMap)	Checks that the actual map contains at least the keys in the given map, mapping to values that correspond to the values of the given map.
void	containsEntry(@Nullable Object expectedKey, E expectedValue)	Checks that the actual map contains an entry with the given key and a value that corresponds to the given value.
Ordered	containsExactly(@Nullable Object k0, @Nullable E v0, @Nullable Object... rest)	Checks that the actual map contains exactly the given set of keys mapping to values that correspond to the given values.
Ordered	containsExactlyEntriesIn(Map<?, ? extends E> expectedMap)	Checks that the actual map contains exactly the keys in the given map, mapping to values that correspond to the values of the given map.
void	doesNotContainEntry(@Nullable Object excludedKey, E excludedValue)	Checks that the actual map does not contain an entry with the given key and a value that corresponds to the given value.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

containsEntry

public void containsEntry(@Nullable Object expectedKey,
 E expectedValue)

Checks that the actual map contains an entry with the given key and a value that corresponds to the given value.

doesNotContainEntry

public void doesNotContainEntry(@Nullable Object excludedKey,
 E excludedValue)

Checks that the actual map does not contain an entry with the given key and a value that corresponds to the given value.

containsExactly

@CanIgnoreReturnValue
public Ordered containsExactly(@Nullable Object k0,
 @Nullable E v0,
 @Nullable Object... rest)

Checks that the actual map contains exactly the given set of keys mapping to values that correspond to the given values.

The values must all be of type E, and a ClassCastException will be thrown if any other type is encountered.

Warning: the use of varargs means that we cannot guarantee an equal number of key/value pairs at compile time. Please make sure you provide varargs in key/value pairs!

containsAtLeast

@CanIgnoreReturnValue
public Ordered containsAtLeast(@Nullable Object k0,
 @Nullable E v0,
 @Nullable Object... rest)

Checks that the actual map contains at least the given set of keys mapping to values that correspond to the given values.

The values must all be of type E, and a ClassCastException will be thrown if any other type is encountered.

Warning: the use of varargs means that we cannot guarantee an equal number of key/value pairs at compile time. Please make sure you provide varargs in key/value pairs!

containsExactlyEntriesIn

@CanIgnoreReturnValue
public Ordered containsExactlyEntriesIn(Map<?, ? extends E> expectedMap)

Checks that the actual map contains exactly the keys in the given map, mapping to values that correspond to the values of the given map.

containsAtLeastEntriesIn

@CanIgnoreReturnValue
public Ordered containsAtLeastEntriesIn(Map<?, ? extends E> expectedMap)

Checks that the actual map contains at least the keys in the given map, mapping to values that correspond to the values of the given map.