com.google.common.truth

Class MapSubject

java.lang.Object

com.google.common.truth.Subject

com.google.common.truth.MapSubject

Direct Known Subclasses:

MapWithProtoValuesSubject

public class MapSubject
extends Subject

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.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MapSubject(FailureMetadata metadata, Map<?,?> map) Constructor for use by subclasses.

Method Summary

Modifier and Type	Method and Description
<A,E> MapSubject.UsingCorrespondence<A,E>	comparingValuesUsing(Correspondence<? super A,? super E> correspondence) Starts a method chain for a check in which the actual values (i.e.
Ordered	containsAtLeast(Object k0, Object v0, Object... rest)
Ordered	containsAtLeastEntriesIn(Map<?,?> expectedMap) Fails if the map does not contain at least the given set of entries in the given map.
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

actualCustomStringRepresentation, check, equals, failWithActual, failWithActual, failWithoutActual, hashCode, ignoreCheck, isAnyOf, isIn, isInstanceOf, isNoneOf, isNotEqualTo, isNotIn, isNotInstanceOf, isNotNull, isNotSameInstanceAs, isNull, isSameInstanceAs, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

MapSubject

protected MapSubject(FailureMetadata metadata,
                     @NullableDecl
                     Map<?,?> map)

Constructor for use by subclasses. If you want to create an instance of this class itself, call Subject.check().that(actual).

Method Detail

isEqualTo

public final void isEqualTo(@NullableDecl
                            Object other)

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, or Long) and they are numerically equal when converted to Long.

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 an equals 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 as equals is implemented according to the contract for its type.

Overrides:

isEqualTo in class Subject

isEmpty

public final void isEmpty()

Fails if the map is not empty.

isNotEmpty

public final void isNotEmpty()

Fails if the map is empty.

hasSize

public final void hasSize(int expectedSize)

Fails if the map does not have the given size.

containsKey

public final void containsKey(@NullableDecl
                              Object key)

Fails if the map does not contain the given key.

doesNotContainKey

public final void doesNotContainKey(@NullableDecl
                                    Object key)

Fails if the map contains the given key.

containsEntry

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

Fails if the map does not contain the given entry.

doesNotContainEntry

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

Fails if the map contains the given entry.

containsExactly

@CanIgnoreReturnValue
public final Ordered containsExactly()

Fails if the map is not empty.

containsExactly

@CanIgnoreReturnValue
public final 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.

containsAtLeast

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

containsExactlyEntriesIn

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

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

containsAtLeastEntriesIn

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

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

comparingValuesUsing

public final <A,E> MapSubject.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 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.