com.google.common.truth

Class MultimapSubject<S extends MultimapSubject<S,K,V,M>,K,V,M extends com.google.common.collect.Multimap<K,V>>

java.lang.Object

com.google.common.truth.Subject<S,M>

com.google.common.truth.MultimapSubject<S,K,V,M>

Direct Known Subclasses:

ListMultimapSubject, SetMultimapSubject

public class MultimapSubject<S extends MultimapSubject<S,K,V,M>,K,V,M extends com.google.common.collect.Multimap<K,V>>
extends Subject<S,M>

Propositions for Multimap subjects.

Author:

Daniel Ploch, Kurt Alfred Kluever

Nested Class Summary

Nested classes/interfaces inherited from class com.google.common.truth.Subject

Subject.HasField

Field Summary

Fields inherited from class com.google.common.truth.Subject

failureStrategy

Method Summary

Methods

Modifier and Type	Method and Description
void	containsEntry(Object key, Object value) Fails if the multimap does not contain the given entry.
Ordered	containsExactly(com.google.common.collect.Multimap<?,?> expectedMultimap) Fails if the Multimap does not contain precisely the same entries as the argument Multimap.
void	containsKey(Object key) Fails if the multimap does not contain the given key.
void	doesNotContainEntry(Object key, Object value) Fails if the multimap contains the given entry.
void	doesNotContainKey(Object key) Fails if the multimap contains the given key.
void	hasSize(int expectedSize) Fails if the multimap does not have the given size.
void	isEmpty() Fails if the multimap is not empty.
void	isEqualTo(Object other) Fails if the subject is not equal to the given object.
void	isNotEmpty() Fails if the multimap is empty.
IterableSubject<? extends IterableSubject<?,V,? extends Collection<V>>,V,? extends Collection<V>>	valuesForKey(K key) Returns a context-aware Subject for making assertions about the values for the given key within the Multimap.
protected static String	valuesForKeyDisplaySubject(Object key, Subject<?,?> valuesForKeySubject)

Methods inherited from class com.google.common.truth.Subject

check, equals, fail, fail, fail, failWithBadResults, failWithCustomSubject, failWithoutSubject, failWithRawMessage, getDisplaySubject, getSubject, hasField, hashCode, internalCustomName, is, isA, isInstanceOf, isNotA, isNotEqualTo, isNotInstanceOf, isNotNull, isNotSameAs, isNull, isSameAs, labeled, named

Methods inherited from class java.lang.Object

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

Method Detail

isEmpty

public void isEmpty()

Fails if the multimap is not empty.

isNotEmpty

public void isNotEmpty()

Fails if the multimap is empty.

hasSize

public void hasSize(int expectedSize)

Fails if the multimap does not have the given size.

containsKey

public void containsKey(@Nullable
               Object key)

Fails if the multimap does not contain the given key.

doesNotContainKey

public void doesNotContainKey(@Nullable
                     Object key)

Fails if the multimap contains the given key.

containsEntry

public void containsEntry(@Nullable
                 Object key,
                 @Nullable
                 Object value)

Fails if the multimap does not contain the given entry.

doesNotContainEntry

public void doesNotContainEntry(@Nullable
                       Object key,
                       @Nullable
                       Object value)

Fails if the multimap contains the given entry.

valuesForKey

@CheckReturnValue
public IterableSubject<? extends IterableSubject<?,V,? extends Collection<V>>,V,? extends Collection<V>> valuesForKey(@Nullable
                                                                                                                              K key)

Returns a context-aware Subject for making assertions about the values for the given key within the Multimap.

This method performs no checks on its own and cannot cause test failures. Subsequent assertions must be chained onto this method call to test properties of the Multimap.

isEqualTo

public void isEqualTo(Object other)

Description copied from class: Subject

Fails if the subject is not equal to the given object.

Overrides:

isEqualTo in class Subject<S extends MultimapSubject<S,K,V,M>,M extends com.google.common.collect.Multimap<K,V>>

containsExactly

public Ordered containsExactly(com.google.common.collect.Multimap<?,?> expectedMultimap)

Fails if the Multimap does not contain precisely the same entries as the argument Multimap.

A subsequent call to Ordered.inOrder() may be made if the caller wishes to verify that the two Multimaps iterate fully in the same order. That is, their key sets iterate in the same order, and the value collections for each key iterate in the same order.

valuesForKeyDisplaySubject

protected static String valuesForKeyDisplaySubject(@Nullable
                                Object key,
                                Subject<?,?> valuesForKeySubject)