Class MultimapSubject
Multimap
subjects.-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprivate static final class
private static class
private class
final class
A partially specified check in which the actual values (i.e.Nested classes/interfaces inherited from class com.google.common.truth.Subject
Subject.EqualityCheck, Subject.Factory<SubjectT extends Subject,
ActualT> -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final com.google.common.collect.Multimap
<?, ?> private static final Ordered
Ordered implementation that does nothing because an earlier check already caused a failure. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
MultimapSubject
(FailureMetadata metadata, com.google.common.collect.Multimap<?, ?> multimap) Constructor for use by subclasses.(package private)
MultimapSubject
(FailureMetadata metadata, com.google.common.collect.Multimap<?, ?> multimap, String typeDescription) -
Method Summary
Modifier and TypeMethodDescriptionaccumulateMultimap
(Object k0, Object v0, Object... rest) private static boolean
advanceToFind
(Iterator<?> iterator, Object value) Advances the iterator until it either returns value, or has no more elements.private static com.google.common.collect.Multimap
<?, ?> annotateEmptyStringsMultimap
(com.google.common.collect.Multimap<?, ?> multimap) Returns a multimap with all empty strings (as keys or values) replaced by a non-empty human understandable indicator for an empty string.<A,
E> MultimapSubject.UsingCorrespondence <A, E> comparingValuesUsing
(Correspondence<? super A, ? super E> correspondence) Starts a method chain for a check in which the actual values (i.e.final Ordered
containsAtLeast
(Object k0, Object v0, Object... rest) Fails if the multimap does not contain at least the given key/value pairs.final Ordered
containsAtLeastEntriesIn
(com.google.common.collect.Multimap<?, ?> expectedMultimap) Fails if theMultimap
does not contain at least the entries in the argumentMultimap
.final void
containsEntry
(Object key, Object value) Fails if the multimap does not contain the given entry.final Ordered
Fails if the multimap is not empty.final Ordered
containsExactly
(Object k0, Object v0, Object... rest) Fails if the multimap does not contain exactly the given set of key/value pairs.final Ordered
containsExactlyEntriesIn
(com.google.common.collect.Multimap<?, ?> expectedMultimap) Fails if theMultimap
does not contain precisely the same entries as the argumentMultimap
.final void
containsKey
(Object key) Fails if the multimap does not contain the given key.private static String
countDuplicatesMultimap
(com.google.common.collect.Multimap<?, ?> multimap) private static com.google.common.collect.ListMultimap
<?, ?> difference
(com.google.common.collect.Multimap<?, ?> minuend, com.google.common.collect.Multimap<?, ?> subtrahend) private static List
<?> difference
(List<?> minuend, List<?> subtrahend) final void
doesNotContainEntry
(Object key, Object value) Fails if the multimap contains the given entry.final void
doesNotContainKey
(Object key) Fails if the multimap contains the given key.private static <V> Collection
<V> final void
hasSize
(int expectedSize) Fails if the multimap does not have the given size.final void
isEmpty()
Fails if the multimap is not empty.final void
Fails if the subject is not equal to the given object.final void
Fails if the multimap is empty.private Subject.Factory
<IterableSubject, Iterable<?>> valuesForKey
(Object key) Returns a context-awareSubject
for making assertions about the values for the given key within theMultimap
.Methods inherited from class com.google.common.truth.Subject
actual, actualCustomStringRepresentation, actualCustomStringRepresentationForPackageMembersToCall, butWas, check, check, checkNoNeedToDisplayBothValues, equals, fail, fail, fail, failEqualityCheckForEqualsWithoutDescription, failWithActual, failWithActual, failWithActual, failWithActual, failWithBadResults, failWithCustomSubject, failWithoutActual, failWithoutActual, failWithoutActual, failWithoutActual, failWithoutSubject, hashCode, ignoreCheck, isAnyOf, isIn, isInstanceOf, isNoneOf, isNotEqualTo, isNotIn, isNotInstanceOf, isNotNull, isNotSameInstanceAs, isNull, isSameInstanceAs, toString, typeDescription
-
Field Details
-
ALREADY_FAILED
Ordered implementation that does nothing because an earlier check already caused a failure. -
actual
private final com.google.common.collect.Multimap<?,?> actual
-
-
Constructor Details
-
MultimapSubject
protected MultimapSubject(FailureMetadata metadata, com.google.common.collect.Multimap<?, ?> multimap) Constructor for use by subclasses. If you want to create an instance of this class itself, callcheck(...)
.that(actual)
. -
MultimapSubject
MultimapSubject(FailureMetadata metadata, com.google.common.collect.Multimap<?, ?> multimap, String typeDescription)
-
-
Method Details
-
isEmpty
public final void isEmpty()Fails if the multimap is not empty. -
isNotEmpty
public final void isNotEmpty()Fails if the multimap is empty. -
hasSize
public final void hasSize(int expectedSize) Fails if the multimap does not have the given size. -
containsKey
Fails if the multimap does not contain the given key. -
doesNotContainKey
Fails if the multimap contains the given key. -
containsEntry
Fails if the multimap does not contain the given entry. -
doesNotContainEntry
Fails if the multimap contains the given entry. -
valuesForKey
Returns a context-awareSubject
for making assertions about the values for the given key within theMultimap
.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
Description copied from class:Subject
Fails if the subject is not equal to the given object. For the purposes of this comparison, two objects are equal if any of the following is true:- they are equal according to
Objects.equal(java.lang.Object, java.lang.Object)
- they are arrays and are considered equal by the appropriate
Arrays.equals(long[], long[])
overload - they are boxed integer types (
Byte
,Short
,Character
,Integer
, orLong
) and they are numerically equal when converted toLong
. - the actual value is a boxed floating-point type (
Double
orFloat
), the expected value is anInteger
, and the two are numerically equal when converted toDouble
. (This allowsassertThat(someDouble).isEqualTo(0)
to pass.)
Note: This method does not test the
Object.equals(java.lang.Object)
implementation itself; it assumes that method is functioning correctly according to its contract. Testing anequals
implementation requires a utility such as guava-testlib's EqualsTester.In some cases, this method might not even call
equals
. It may instead perform other tests that will return the same result as long asequals
is implemented according to the contract for its type. - they are equal according to
-
containsExactlyEntriesIn
public final Ordered containsExactlyEntriesIn(com.google.common.collect.Multimap<?, ?> expectedMultimap) Fails if theMultimap
does not contain precisely the same entries as the argumentMultimap
.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. -
containsAtLeastEntriesIn
public final Ordered containsAtLeastEntriesIn(com.google.common.collect.Multimap<?, ?> expectedMultimap) Fails if theMultimap
does not contain at least the entries in the argumentMultimap
.A subsequent call to
Ordered.inOrder()
may be made if the caller wishes to verify that the entries are present in the same order as given. That is, the keys are present in the given order in the key set, and the values for each key are present in the given order order in the value collections. -
containsExactly
Fails if the multimap is not empty. -
containsExactly
Fails if the multimap does not contain exactly the given set of key/value pairs.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
Fails if the multimap does not contain at least the given key/value pairs.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!
-
accumulateMultimap
-
iterableEntries
-
advanceToFind
Advances the iterator until it either returns value, or has no more elements.Returns true if the value was found, false if the end was reached before finding it.
This is basically the same as
Iterables.contains(java.lang.Iterable<? extends java.lang.Object>, java.lang.Object)
, but where the contract explicitly states that the iterator isn't advanced beyond the value if the value is found. -
get
-
difference
private static com.google.common.collect.ListMultimap<?,?> difference(com.google.common.collect.Multimap<?, ?> minuend, com.google.common.collect.Multimap<?, ?> subtrahend) -
difference
-
countDuplicatesMultimap
-
annotateEmptyStringsMultimap
private static com.google.common.collect.Multimap<?,?> annotateEmptyStringsMultimap(com.google.common.collect.Multimap<?, ?> multimap) Returns a multimap with all empty strings (as keys or values) replaced by a non-empty human understandable indicator for an empty string.Returns the given multimap if it contains no empty strings.
-
comparingValuesUsing
public <A,E> MultimapSubject.UsingCorrespondence<A,E> comparingValuesUsing(Correspondence<? super A, ? super E> correspondence) Starts a method chain for a check in which the actual values (i.e. the values of theMultimap
under test) are compared to expected values using the givenCorrespondence
. The actual values must be of typeA
, and the expected values must be of typeE
. The check is actually executed by continuing the method chain. For example:
whereassertThat(actualMultimap) .comparingValuesUsing(correspondence) .containsEntry(expectedKey, expectedValue);
actualMultimap
is aMultimap<?, A>
(or, more generally, aMultimap<?, ? extends A>
),correspondence
is aCorrespondence<A, E>
, andexpectedValue
is anE
.Note that keys will always be compared with regular object equality (
Object.equals(java.lang.Object)
).Any of the methods on the returned object may throw
ClassCastException
if they encounter an actual value that is not of typeA
.
-