com.google.common.truth.extensions.proto

Class ProtoTruth

java.lang.Object

com.google.common.truth.extensions.proto.ProtoTruth

public final class ProtoTruth
extends Object

A set of static methods to begin a Truth assertion chain for protocol buffers.

Note: Usage of different failure strategies such as assume and expect should rely on CustomSubjectBuilderFactory#about(CustomSubjectBuilderFactory) to begin a chain with those alternative behaviors.

Method Summary

Modifier and Type	Method and Description
static <M extends com.google.protobuf.Message> IterableOfProtosSubject<?,M,Iterable<M>>	assertThat(Iterable<M> messages) Assert on a sequence of Messages.
static <K,M extends com.google.protobuf.Message> ListMultimapWithProtoValuesSubject<?,K,M,com.google.common.collect.ListMultimap<K,M>>	assertThat(com.google.common.collect.ListMultimap<K,M> listMultimap) Assert on a ListMultimap with Message values.
static <K,M extends com.google.protobuf.Message> MapWithProtoValuesSubject<?,K,M,Map<K,M>>	assertThat(Map<K,M> map) Assert on a map with Message values.
static ProtoSubject<?,com.google.protobuf.Message>	assertThat(com.google.protobuf.Message message) Assert on a single Message instance.
static LiteProtoSubject<?,com.google.protobuf.MessageLite>	assertThat(com.google.protobuf.MessageLite messageLite) Assert on a single MessageLite instance.
static <K,M extends com.google.protobuf.Message> MultimapWithProtoValuesSubject<?,K,M,com.google.common.collect.Multimap<K,M>>	assertThat(com.google.common.collect.Multimap<K,M> multimap) Assert on a Multimap with Message values.
static <K,M extends com.google.protobuf.Message> SetMultimapWithProtoValuesSubject<?,K,M,com.google.common.collect.SetMultimap<K,M>>	assertThat(com.google.common.collect.SetMultimap<K,M> setMultimap) Assert on a Multimap with Message values.
static CustomSubjectBuilderFactory<ProtoSubjectBuilder>	protos() Returns a CustomSubjectBuilderFactory, akin to a SubjectFactory, which can be used to assert on multiple types of Protos and collections containing them.

Methods inherited from class java.lang.Object

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

Method Detail

protos

public static CustomSubjectBuilderFactory<ProtoSubjectBuilder> protos()

Returns a CustomSubjectBuilderFactory, akin to a SubjectFactory, which can be used to assert on multiple types of Protos and collections containing them.

assertThat

public static LiteProtoSubject<?,com.google.protobuf.MessageLite> assertThat(@Nullable
                                                                             com.google.protobuf.MessageLite messageLite)

Assert on a single MessageLite instance.

assertThat

public static ProtoSubject<?,com.google.protobuf.Message> assertThat(@Nullable
                                                                     com.google.protobuf.Message message)

Assert on a single Message instance.

assertThat

public static <M extends com.google.protobuf.Message> IterableOfProtosSubject<?,M,Iterable<M>> assertThat(@Nullable
                                                                                                          Iterable<M> messages)

Assert on a sequence of Messages.

This allows for the equality configurations on ProtoSubject to be applied to all comparison tests available on IterableSubject#UsingCorrespondence.

assertThat

public static <K,M extends com.google.protobuf.Message> MapWithProtoValuesSubject<?,K,M,Map<K,M>> assertThat(@Nullable
                                                                                                             Map<K,M> map)

Assert on a map with Message values.

This allows for the equality configurations on ProtoSubject to be applied to all comparison tests available on MapSubject#UsingCorrespondence.

assertThat

public static <K,M extends com.google.protobuf.Message> MultimapWithProtoValuesSubject<?,K,M,com.google.common.collect.Multimap<K,M>> assertThat(@Nullable
                                                                                                                                                 com.google.common.collect.Multimap<K,M> multimap)

Assert on a Multimap with Message values.

This allows for the equality configurations on ProtoSubject to be applied to all comparison tests available on MultimapSubject#UsingCorrespondence.

assertThat

public static <K,M extends com.google.protobuf.Message> ListMultimapWithProtoValuesSubject<?,K,M,com.google.common.collect.ListMultimap<K,M>> assertThat(@Nullable
                                                                                                                                                         com.google.common.collect.ListMultimap<K,M> listMultimap)

Assert on a ListMultimap with Message values.

This allows for the equality configurations on ProtoSubject to be applied to all comparison tests available on MultimapSubject#UsingCorrespondence.

assertThat

public static <K,M extends com.google.protobuf.Message> SetMultimapWithProtoValuesSubject<?,K,M,com.google.common.collect.SetMultimap<K,M>> assertThat(@Nullable
                                                                                                                                                       com.google.common.collect.SetMultimap<K,M> setMultimap)

Assert on a Multimap with Message values.

This allows for the equality configurations on ProtoSubject to be applied to all comparison tests available on MultimapSubject#UsingCorrespondence.