com.google.common.truth

Class MapSubject

java.lang.Object

com.google.common.truth.Subject<MapSubject,Map<?,?>>

com.google.common.truth.MapSubject

Direct Known Subclasses:

SortedMapSubject

public class MapSubject
extends Subject<MapSubject,Map<?,?>>

Propositions for Map subjects.

Author:

Christian Gruber, Kurt Alfred Kluever

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	MapSubject.UsingCorrespondence<A,E> A partially specified check in which the actual values (i.e.

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

Subject.Factory<SubjectT extends Subject<SubjectT,ActualT>,ActualT>

Method Summary

Modifier and Type	Method and Description
<A,E> MapSubject.UsingCorrespondence<A,E>	comparingValuesUsing(Correspondence<A,E> correspondence) Starts a method chain for a check in which the actual values (i.e.
void	containsEntry(Object key, Object value) Fails if the map does not contain the given entry.
Ordered	containsExactly() Fails if the map is not empty.
Ordered	containsExactly(Object k0, Object v0, Object... rest) Fails if the map does not contain exactly the given set of key/value pairs.
Ordered	containsExactlyEntriesIn(Map<?,?> expectedMap) Fails if the map does not contain exactly the given set of entries in the given map.
void	containsKey(Object key) Fails if the map does not contain the given key.
void	doesNotContainEntry(Object key, Object value) Fails if the map contains the given entry.
void	doesNotContainKey(Object key) Fails if the map contains the given key.
void	hasSize(int expectedSize) Fails if the map does not have the given size.
void	isEmpty() Fails if the map is not empty.
void	isEqualTo(Object other) Fails if the subject is not equal to the given object.
void	isNotEmpty() Fails if the map is empty.

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

actual, actualAsString, actualCustomStringRepresentation, check, check, equals, fail, fail, fail, failComparing, failComparing, failWithActual, failWithActual, failWithBadResults, failWithCustomSubject, failWithoutActual, failWithoutActual, failWithoutSubject, failWithRawMessage, failWithRawMessageAndCause, getSubject, hashCode, ignoreCheck, internalCustomName, isAnyOf, isIn, isInstanceOf, isNoneOf, isNotEqualTo, isNotIn, isNotInstanceOf, isNotNull, isNotSameAs, isNull, isSameAs, named, toString

Methods inherited from class java.lang.Object

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

Method Detail

isEqualTo

public void isEqualTo(@NullableDecl
                      Object other)

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

Overrides:

isEqualTo in class Subject<MapSubject,Map<?,?>>

isEmpty

public void isEmpty()

Fails if the map is not empty.

isNotEmpty

public void isNotEmpty()

Fails if the map is empty.

hasSize

public void hasSize(int expectedSize)

Fails if the map does not have the given size.

containsKey

public void containsKey(@NullableDecl
                        Object key)

Fails if the map does not contain the given key.

doesNotContainKey

public void doesNotContainKey(@NullableDecl
                              Object key)

Fails if the map contains the given key.

containsEntry

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

Fails if the map does not contain the given entry.

doesNotContainEntry

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

Fails if the map contains the given entry.

containsExactly

@CanIgnoreReturnValue
public Ordered containsExactly()

Fails if the map is not empty.

containsExactly

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

Fails if the map 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!

The arguments must not contain duplicate keys.

containsExactlyEntriesIn

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

Fails if the map does not contain exactly the given set of entries in the given map.

comparingValuesUsing

public <A,E> MapSubject.UsingCorrespondence<A,E> comparingValuesUsing(Correspondence<A,E> correspondence)

Starts a method chain for a check in which the actual values (i.e. the values of the Map under test) are compared to expected values using the given Correspondence. The actual values must be of type A, the expected values must be of type E. The check is actually executed by continuing the method chain. For example:

 assertThat(actualMap)
   .comparingValuesUsing(correspondence)
   .containsEntry(expectedKey, expectedValue);
 

where actualMap is a Map<?, A> (or, more generally, a Map<?, ? extends A>), correspondence is a Correspondence<A, E>, and expectedValue is an E.

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 type A or an expected value that is not of type E.