Interface Correspondence.DiffFormatter<A extends @Nullable Object, E extends @Nullable Object>

Enclosing class:
Correspondence<A extends @Nullable Object, E extends @Nullable Object>
public static interface Correspondence.DiffFormatter<A extends @Nullable Object, E extends @Nullable Object>
A functional interface to be used format the diff between a pair of objects of types A and E.

This interface will normally be implemented using a lambda or a method reference, and the resulting object will normally be passed directly to Correspondence.formattingDiffsUsing(com.google.common.truth.Correspondence.DiffFormatter<? super A, ? super E>). As a result, you should almost never see DiffFormatter used as the type of a field or variable, or a return type.

Author:
Pete Gillin

  • Method Summary

    Modifier and Type
    Method
    Description
    @Nullable String
    formatDiff(A actual, E expected)
    Returns a String describing the difference between the actual and expected values, if possible, or null if not.

  • Method Details

    • formatDiff

      @Nullable String formatDiff(A actual, E expected)
      Returns a String describing the difference between the actual and expected values, if possible, or null if not.