com.google.common.truth.extensions.proto

Interface MultimapWithProtoValuesFluentAssertion<M extends com.google.protobuf.Message>

public interface MultimapWithProtoValuesFluentAssertion<M extends com.google.protobuf.Message>

Fluent API to perform detailed, customizable comparison of Multimaps containing protocol buffers as values. The same comparison rules are applied to all pairs of protocol buffers which get compared.

The keys of these maps are treated as ordinary objects, and keys which happen to be protocol buffers are not given special treatment. They are compared with Object.equals(java.lang.Object) and Object.hashCode() as documented by the Multimap interface.

Methods may be chained in any order, but the chain should terminate with a method that doesn't return a MultimapWithProtoValuesFluentAssertion, such as containsExactlyEntriesIn(com.google.common.collect.Multimap<?, ? extends M>) or containsEntry(java.lang.Object, M).

The state of a MultimapWithProtoValuesFluentAssertion object after each method is called is left undefined. Users should not retain references to MultimapWithProtoValuesFluentAssertion instances.

Method Summary

Modifier and Type	Method and Description
MultimapWithProtoValuesFluentAssertion<M>	comparingExpectedFieldsOnlyForValues() Limits the comparison of Protocol buffers to the fields set in the expected proto(s).
void	containsEntry(Object expectedKey, M expectedValue) Fails if the multimap does not contain an entry with the given key and a value that corresponds to the given value.
Ordered	containsExactly() Fails if the multimap is not empty.
Ordered	containsExactly(Object k0, M v0, Object... rest) Fails if the multimap does not contain exactly the given set of key/value pairs.
Ordered	containsExactlyEntriesIn(Multimap<?,? extends M> expectedMultimap) Fails if the map does not contain exactly the keys in the given multimap, mapping to values that correspond to the values of the given multimap.
void	doesNotContainEntry(Object excludedKey, M excludedValue) Fails if the multimap contains an entry with the given key and a value that corresponds to the given value.
boolean	equals(Object o) Deprecated. Do not call equals() on a MultimapWithProtoValuesFluentAssertion.
int	hashCode() Deprecated. MultimapWithProtoValuesFluentAssertion does not support hashCode().
MultimapWithProtoValuesFluentAssertion<M>	ignoringExtraRepeatedFieldElementsForValues() Specifies that, for all repeated and map fields, any elements in the 'actual' proto which are not found in the 'expected' proto are ignored, with the exception of fields in the expected proto which are empty.
MultimapWithProtoValuesFluentAssertion<M>	ignoringFieldAbsenceForValues() Specifies that the 'has' bit of individual fields should be ignored when comparing for equality.
MultimapWithProtoValuesFluentAssertion<M>	ignoringFieldDescriptorsForValues(com.google.protobuf.Descriptors.FieldDescriptor firstFieldDescriptor, com.google.protobuf.Descriptors.FieldDescriptor... rest) Excludes all message fields matching the given Descriptors.FieldDescriptors from the comparison.
MultimapWithProtoValuesFluentAssertion<M>	ignoringFieldDescriptorsForValues(Iterable<com.google.protobuf.Descriptors.FieldDescriptor> fieldDescriptors) Excludes all message fields matching the given Descriptors.FieldDescriptors from the comparison.
MultimapWithProtoValuesFluentAssertion<M>	ignoringFieldScopeForValues(FieldScope fieldScope) Excludes all specific field paths under the argument FieldScope from the comparison.
MultimapWithProtoValuesFluentAssertion<M>	ignoringFieldsForValues(int firstFieldNumber, int... rest) Excludes the top-level message fields with the given tag numbers from the comparison.
MultimapWithProtoValuesFluentAssertion<M>	ignoringFieldsForValues(Iterable<Integer> fieldNumbers) Excludes the top-level message fields with the given tag numbers from the comparison.
MultimapWithProtoValuesFluentAssertion<M>	ignoringRepeatedFieldOrderForValues() Specifies that the ordering of repeated fields, at all levels, should be ignored when comparing for equality.
MultimapWithProtoValuesFluentAssertion<M>	reportingMismatchesOnlyForValues() If set, in the event of a comparison failure, the error message printed will list only those specific fields that did not match between the actual and expected values.
MultimapWithProtoValuesFluentAssertion<M>	usingDoubleToleranceForValues(double tolerance) Compares double fields as equal if they are both finite and their absolute difference is less than or equal to tolerance.
MultimapWithProtoValuesFluentAssertion<M>	usingFloatToleranceForValues(float tolerance) Compares float fields as equal if they are both finite and their absolute difference is less than or equal to tolerance.
MultimapWithProtoValuesFluentAssertion<M>	withPartialScopeForValues(FieldScope fieldScope) Limits the comparison of Protocol buffers to the defined FieldScope.

Method Detail

ignoringFieldAbsenceForValues

MultimapWithProtoValuesFluentAssertion<M> ignoringFieldAbsenceForValues()

Specifies that the 'has' bit of individual fields should be ignored when comparing for equality.

For version 2 Protocol Buffers, this setting determines whether two protos with the same value for a primitive field compare equal if one explicitly sets the value, and the other merely implicitly uses the schema-defined default. This setting also determines whether unknown fields should be considered in the comparison. By ignoringFieldAbsence(), unknown fields are ignored, and value-equal fields as specified above are considered equal.

For version 3 Protocol Buffers, this setting has no effect. Primitive fields set to their default value are indistinguishable from unset fields in proto 3. Proto 3 also eliminates unknown fields, so this setting has no effect there either.

ignoringRepeatedFieldOrderForValues

MultimapWithProtoValuesFluentAssertion<M> ignoringRepeatedFieldOrderForValues()

Specifies that the ordering of repeated fields, at all levels, should be ignored when comparing for equality.

This setting applies to all repeated fields recursively, but it does not ignore structure. For example, with ignoringRepeatedFieldOrderForValues(), a repeated int32 field bar, set inside a repeated message field foo, the following protos will all compare equal:

 message1: {
   foo: {
     bar: 1
     bar: 2
   }
   foo: {
     bar: 3
     bar: 4
   }
 }

 message2: {
   foo: {
     bar: 2
     bar: 1
   }
   foo: {
     bar: 4
     bar: 3
   }
 }

 message3: {
   foo: {
     bar: 4
     bar: 3
   }
   foo: {
     bar: 2
     bar: 1
   }
 }
 

However, the following message will compare equal to none of these:

 message4: {
   foo: {
     bar: 1
     bar: 3
   }
   foo: {
     bar: 2
     bar: 4
   }
 }
 

This setting does not apply to map fields, for which field order is always ignored. The serialization order of map fields is undefined, and it may change from runtime to runtime.

ignoringExtraRepeatedFieldElementsForValues

MultimapWithProtoValuesFluentAssertion<M> ignoringExtraRepeatedFieldElementsForValues()

Specifies that, for all repeated and map fields, any elements in the 'actual' proto which are not found in the 'expected' proto are ignored, with the exception of fields in the expected proto which are empty. To ignore empty repeated fields as well, use comparingExpectedFieldsOnlyForValues().

This rule is applied independently from ignoringRepeatedFieldOrderForValues(). If ignoring repeated field order AND extra repeated field elements, all that is tested is that the expected elements comprise a subset of the actual elements. If not ignoring repeated field order, but still ignoring extra repeated field elements, the actual elements must contain a subsequence that matches the expected elements for the test to pass. (The subsequence rule does not apply to Map fields, which are always compared by key.)

usingDoubleToleranceForValues

MultimapWithProtoValuesFluentAssertion<M> usingDoubleToleranceForValues(double tolerance)

Compares double fields as equal if they are both finite and their absolute difference is less than or equal to tolerance.

Parameters:

tolerance - A finite, non-negative tolerance.

usingFloatToleranceForValues

MultimapWithProtoValuesFluentAssertion<M> usingFloatToleranceForValues(float tolerance)

Compares float fields as equal if they are both finite and their absolute difference is less than or equal to tolerance.

Parameters:

tolerance - A finite, non-negative tolerance.

comparingExpectedFieldsOnlyForValues

MultimapWithProtoValuesFluentAssertion<M> comparingExpectedFieldsOnlyForValues()

Limits the comparison of Protocol buffers to the fields set in the expected proto(s). When multiple protos are specified, the comparison is limited to the union of set fields in all the expected protos.

The "expected proto(s)" are those passed to the method at the end of the call chain, such as containsEntry(java.lang.Object, M) or containsExactlyEntriesIn(com.google.common.collect.Multimap<?, ? extends M>).

Fields not set in the expected proto(s) are ignored. In particular, proto3 fields which have their default values are ignored, as these are indistinguishable from unset fields. If you want to assert that a proto3 message has certain fields with default values, you cannot use this method.

withPartialScopeForValues

MultimapWithProtoValuesFluentAssertion<M> withPartialScopeForValues(FieldScope fieldScope)

Limits the comparison of Protocol buffers to the defined FieldScope.

This method is additive and has well-defined ordering semantics. If the invoking MultimapWithProtoValuesFluentAssertion is already scoped to a FieldScope X, and this method is invoked with FieldScope Y, the resultant MultimapWithProtoValuesFluentAssertion is constrained to the intersection of FieldScopes X and Y.

By default, MultimapWithProtoValuesFluentAssertion is constrained to FieldScopes.all(), that is, no fields are excluded from comparison.

ignoringFieldsForValues

MultimapWithProtoValuesFluentAssertion<M> ignoringFieldsForValues(int firstFieldNumber,
                                                                  int... rest)

Excludes the top-level message fields with the given tag numbers from the comparison.

This method adds on any previous FieldScope related settings, overriding previous changes to ensure the specified fields are ignored recursively. All sub-fields of these field numbers are ignored, and all sub-messages of type M will also have these field numbers ignored.

If an invalid field number is supplied, the terminal comparison operation will throw a runtime exception.

ignoringFieldsForValues

MultimapWithProtoValuesFluentAssertion<M> ignoringFieldsForValues(Iterable<Integer> fieldNumbers)

Excludes the top-level message fields with the given tag numbers from the comparison.

This method adds on any previous FieldScope related settings, overriding previous changes to ensure the specified fields are ignored recursively. All sub-fields of these field numbers are ignored, and all sub-messages of type M will also have these field numbers ignored.

If an invalid field number is supplied, the terminal comparison operation will throw a runtime exception.

ignoringFieldDescriptorsForValues

MultimapWithProtoValuesFluentAssertion<M> ignoringFieldDescriptorsForValues(com.google.protobuf.Descriptors.FieldDescriptor firstFieldDescriptor,
                                                                            com.google.protobuf.Descriptors.FieldDescriptor... rest)

Excludes all message fields matching the given Descriptors.FieldDescriptors from the comparison.

This method adds on any previous FieldScope related settings, overriding previous changes to ensure the specified fields are ignored recursively. All sub-fields of these field descriptors are ignored, no matter where they occur in the tree.

If a field descriptor which does not, or cannot occur in the proto structure is supplied, it is silently ignored.

ignoringFieldDescriptorsForValues

MultimapWithProtoValuesFluentAssertion<M> ignoringFieldDescriptorsForValues(Iterable<com.google.protobuf.Descriptors.FieldDescriptor> fieldDescriptors)

Excludes all message fields matching the given Descriptors.FieldDescriptors from the comparison.

This method adds on any previous FieldScope related settings, overriding previous changes to ensure the specified fields are ignored recursively. All sub-fields of these field descriptors are ignored, no matter where they occur in the tree.

If a field descriptor which does not, or cannot occur in the proto structure is supplied, it is silently ignored.

ignoringFieldScopeForValues

MultimapWithProtoValuesFluentAssertion<M> ignoringFieldScopeForValues(FieldScope fieldScope)

Excludes all specific field paths under the argument FieldScope from the comparison.

This method is additive and has well-defined ordering semantics. If the invoking MultimapWithProtoValuesFluentAssertion is already scoped to a FieldScope X, and this method is invoked with FieldScope Y, the resultant MultimapWithProtoValuesFluentAssertion is constrained to the subtraction of X - Y.

By default, MultimapWithProtoValuesFluentAssertion is constrained to FieldScopes.all(), that is, no fields are excluded from comparison.

reportingMismatchesOnlyForValues

MultimapWithProtoValuesFluentAssertion<M> reportingMismatchesOnlyForValues()

If set, in the event of a comparison failure, the error message printed will list only those specific fields that did not match between the actual and expected values. Useful for very large protocol buffers.

This a purely cosmetic setting, and it has no effect on the behavior of the test.

containsEntry

void containsEntry(@NullableDecl
                   Object expectedKey,
                   @NullableDecl
                   M expectedValue)

Fails if the multimap does not contain an entry with the given key and a value that corresponds to the given value.

doesNotContainEntry

void doesNotContainEntry(@NullableDecl
                         Object excludedKey,
                         @NullableDecl
                         M excludedValue)

Fails if the multimap contains an entry with the given key and a value that corresponds to the given value.

containsExactlyEntriesIn

@CanIgnoreReturnValue
Ordered containsExactlyEntriesIn(Multimap<?,? extends M> expectedMultimap)

Fails if the map does not contain exactly the keys in the given multimap, mapping to values that correspond to the values of the given 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 corresponding value collections for each key iterate in the same order.

containsExactly

@CanIgnoreReturnValue
Ordered containsExactly()

Fails if the multimap is not empty.

containsExactly

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

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!

equals

@Deprecated
boolean equals(Object o)

Deprecated. Do not call equals() on a MultimapWithProtoValuesFluentAssertion.

Overrides:

equals in class Object

See Also:

Subject.equals(Object)

hashCode

@Deprecated
int hashCode()

Deprecated. MultimapWithProtoValuesFluentAssertion does not support hashCode().

Overrides:

hashCode in class Object

See Also:

Subject.hashCode()