Deprecated API

Contents

• Deprecated Interfaces
• Deprecated Classes
• Deprecated Methods

Deprecated Interfaces

Interface and Description
com.google.common.truth.DelegatedVerbFactory This class is being renamed to CustomSubjectBuilderFactory.
com.google.common.truth.ExpectFailure.AssertionCallback Implement ExpectFailure.StandardSubjectBuilderCallback, which is identical except that its parameter is a StandardSubjectBuilder, the new name of TestVerb.
com.google.common.truth.ExpectFailure.DelegatedAssertionCallback Implement ExpectFailure.SimpleSubjectBuilderCallback, which is identical except that its parameter is of SimpleSubjectBuilder, the new name of AbstractVerb.DelegatedVerb.

Deprecated Classes

Class and Description
com.google.common.truth.AbstractDelegatedVerb This class is being renamed to CustomSubjectBuilder.
com.google.common.truth.AbstractVerb Instead of subclassing AbstractVerb, subclass CustomSubjectBuilder. CustomSubjectBuilder is the new way of defining custom that() methods, and it doesn't require you to write boilerplate to store and propagate the failure message.
com.google.common.truth.AbstractVerb.DelegatedVerb This class is being renamed to SimpleSubjectBuilder.
com.google.common.truth.AbstractVerb.MessagePrependingFailureStrategy To prepend a message, use StandardSubjectBuilder.withMessage(java.lang.String). If you are using MessagePrependingFailureStrategy to store and propagate the failure message as part of subclassing AbstractVerb or TestVerb, you will no longer need it when you migrate off those classes, as described in their deprecation text.
com.google.common.truth.Expect.ExpectationGatherer To provide your own failure handling, use StandardSubjectBuilder.forCustomFailureStrategy(new AbstractFailureStrategy() { ... }) instead of Expect.create(new ExpectationGatherer() { ... }). Or, if you're testing that assertions on a custom Subject fail (using ExpectationGatherer to capture the failures), use ExpectFailure.
com.google.common.truth.FailureContext If you are using this class to store and propagate the failure message as part of subclassing AbstractVerb or TestVerb, you will no longer need it when you migrate away from those classes, as described in their deprecation text.
com.google.common.truth.TestVerb Instead of subclassing TestVerb, subclass CustomSubjectBuilder. CustomSubjectBuilder is the new way of defining custom that() methods, and it doesn't require you to write boilerplate to store and propagate the failure message.

Deprecated Methods

Method and Description
com.google.common.truth.AbstractVerb.about(DelegatedVerbFactory<V>) When you switch from implementing DelegatedVerbFactory to implementing CustomSubjectBuilderFactory, you'll switch from this overload to the overload that accepts a CustomSubjectBuilderFactory.
com.google.common.truth.Truth.assertAbout(DelegatedVerbFactory<V>) When you switch from implementing DelegatedVerbFactory to implementing CustomSubjectBuilderFactory, you'll switch from this overload to the overload that accepts a CustomSubjectBuilderFactory.
com.google.common.truth.ComparableSubject.comparesEqualTo(T) Use ComparableSubject.isEquivalentAccordingToCompareTo(T) instead.
com.google.common.truth.MultimapSubject.containsExactly(Multimap<?, ?>) Use MultimapSubject.containsExactlyEntriesIn(com.google.common.collect.Multimap<?, ?>) instead.
com.google.common.truth.Expect.create(Expect.ExpectationGatherer) To provide your own failure handling, use StandardSubjectBuilder.forCustomFailureStrategy(new AbstractFailureStrategy() { ... }) instead of Expect.create(new ExpectationGatherer() { ... }).
com.google.common.truth.DoubleSubject.TolerantDoubleComparison.equals(Object) Object.equals(Object) is not supported on TolerantDoubleComparison. If you meant to compare doubles, use DoubleSubject.TolerantDoubleComparison.of(double) instead.
com.google.common.truth.PrimitiveDoubleArraySubject.TolerantPrimitiveDoubleArrayComparison.equals(Object) Object.equals(Object) is not supported on TolerantPrimitiveDoubleArrayComparison. If you meant to compare double arrays, use PrimitiveDoubleArraySubject.TolerantPrimitiveDoubleArrayComparison.of(double...) or PrimitiveDoubleArraySubject.TolerantPrimitiveDoubleArrayComparison.ofElementsIn(java.lang.Iterable<? extends java.lang.Number>) instead.
com.google.common.truth.Correspondence.equals(Object) Object.equals(Object) is not supported. If you meant to compare objects using this Correspondence, use Correspondence.compare(A, E).
com.google.common.truth.FloatSubject.TolerantFloatComparison.equals(Object) Object.equals(Object) is not supported on TolerantFloatComparison. If you meant to compare floats, use FloatSubject.TolerantFloatComparison.of(float) instead.
com.google.common.truth.Subject.equals(Object) Object.equals(Object) is not supported on Truth subjects. If you meant to test object equality between an expected and the actual value, use Subject.isEqualTo(Object) instead.
com.google.common.truth.PrimitiveFloatArraySubject.TolerantPrimitiveFloatArrayComparison.equals(Object) Object.equals(Object) is not supported on TolerantPrimitiveFloatArrayComparison. If you meant to compare float arrays, use PrimitiveFloatArraySubject.TolerantPrimitiveFloatArrayComparison.of(float...) or PrimitiveFloatArraySubject.TolerantPrimitiveFloatArrayComparison.ofElementsIn(java.lang.Iterable<? extends java.lang.Number>) instead.
com.google.common.truth.extensions.proto.MultimapWithProtoValuesFluentAssertion.equals(Object) Do not call equals() on a MultimapWithProtoValuesFluentAssertion.
com.google.common.truth.extensions.proto.IterableOfProtosFluentAssertion.equals(Object) Do not call equals() on a IterableOfProtosFluentAssertion.
com.google.common.truth.extensions.proto.MapWithProtoValuesFluentAssertion.equals(Object) Do not call equals() on a MapWithProtoValuesFluentAssertion.
com.google.common.truth.extensions.proto.ProtoFluentAssertion.equals(Object) Do not call equals() on a ProtoFluentAssertion. Use ProtoFluentAssertion.isEqualTo(Object) instead.
com.google.common.truth.ExpectFailure.expectFailure(ExpectFailure.AssertionCallback) Switch to the overload of this method that accepts a ExpectFailure.StandardSubjectBuilderCallback.
com.google.common.truth.ExpectFailure.expectFailureAbout(SubjectFactory<S, D>, ExpectFailure.DelegatedAssertionCallback<S, D>) Switch to the overload of this method that accepts a ExpectFailure.SimpleSubjectBuilderCallback.
com.google.common.truth.Subject.failWithoutSubject(String) Use Subject.failWithoutActual(String)
com.google.common.truth.Subject.getDisplaySubject() Prefer #actualAsString() for display-formatted access to the subject.
com.google.common.truth.Subject.getSubject() Prefer #actual() for direct access to the subject.
com.google.common.truth.DoubleSubject.TolerantDoubleComparison.hashCode() Object.hashCode() is not supported on TolerantDoubleComparison
com.google.common.truth.PrimitiveDoubleArraySubject.TolerantPrimitiveDoubleArrayComparison.hashCode() Object.hashCode() is not supported on TolerantPrimitiveDoubleArrayComparison
com.google.common.truth.Correspondence.hashCode() Object.hashCode() is not supported.
com.google.common.truth.FloatSubject.TolerantFloatComparison.hashCode() Object.hashCode() is not supported on TolerantFloatComparison
com.google.common.truth.Subject.hashCode() Object.hashCode() is not supported on Truth subjects.
com.google.common.truth.PrimitiveFloatArraySubject.TolerantPrimitiveFloatArrayComparison.hashCode() Object.hashCode() is not supported on TolerantPrimitiveFloatArrayComparison
com.google.common.truth.extensions.proto.MultimapWithProtoValuesFluentAssertion.hashCode() MultimapWithProtoValuesFluentAssertion does not support hashCode().
com.google.common.truth.extensions.proto.IterableOfProtosFluentAssertion.hashCode() IterableOfProtosFluentAssertion does not support hashCode().
com.google.common.truth.extensions.proto.MapWithProtoValuesFluentAssertion.hashCode() MapWithProtoValuesFluentAssertion does not support hashCode().
com.google.common.truth.extensions.proto.ProtoFluentAssertion.hashCode() ProtoFluentAssertion does not support hashCode(). Use ProtoFluentAssertion.isEqualTo(Object) for testing.
com.google.common.truth.ThrowableSubject.hasMessage(String) Use hasMessageThat().isEqualTo(expected) instead. You may also consider using inexact matching of the message (e.g. hasMessageThat().contains(substring)) for less brittle tests.
com.google.common.truth.PrimitiveDoubleArraySubject.hasValuesNotWithin(double) Write a for loop over the values looking for mismatches (see this implementation for an example)
com.google.common.truth.PrimitiveFloatArraySubject.hasValuesNotWithin(float) Write a for loop over the values looking for mismatches (see this implementation for an example)
com.google.common.truth.PrimitiveDoubleArraySubject.hasValuesWithin(double) Use PrimitiveDoubleArraySubject.usingTolerance(double), e.g. assertThat(doubleArray).usingTolerance(1e-5).containsExactly(1.2, 3.4, 5.6).inOrder();
com.google.common.truth.PrimitiveFloatArraySubject.hasValuesWithin(float) Use PrimitiveFloatArraySubject.usingTolerance(double), e.g. assertThat(floatArray).usingTolerance(1e-5).containsExactly(1.2f, 3.4f, 5.6f).inOrder();
com.google.common.truth.SetMultimapSubject.isEqualTo(ListMultimap<?, ?>) #isEqualTo A ListMultimap can never compare equal with a SetMultimap if either Multimap is non-empty, because List and Set can never compare equal. Prefer MultimapSubject.containsExactlyEntriesIn(com.google.common.collect.Multimap) instead. Consult Multimap.equals(java.lang.Object) for more information.
com.google.common.truth.extensions.proto.SetMultimapWithProtoValuesSubject.isEqualTo(ListMultimap<?, ?>) #isEqualTo A ListMultimap can never compare equal with a SetMultimap if either Multimap is non-empty, because List and Set can never compare equal. Prefer MultimapSubject.containsExactlyEntriesIn(com.google.common.collect.Multimap) instead. Consult Multimap.equals(java.lang.Object) for more information.
com.google.common.truth.extensions.proto.LiteProtoSubject.isEqualTo(MessageLite.Builder) A Builder can never compare equal to a MessageLite instance. Use build(), or buildPartial() on the argument to get a MessageLite for comparison instead.
com.google.common.truth.AtomicLongMapSubject.isEqualTo(Object) AtomicLongMap does not define equality (i.e., it does not implement equals()), so you probably don't want to call this method. Instead, perform your assertion on the map view (e.g., assertThat(atomicLongMap.asMap()).isEqualTo(EXPECTED_MAP)).
com.google.common.truth.PrimitiveDoubleArraySubject.isEqualTo(Object, double) use usingTolerance(someTolerance).containsExactly(someValues).inOrder(), noting the different behaviour for non-finite values
com.google.common.truth.PrimitiveFloatArraySubject.isEqualTo(Object, float) use usingTolerance(someTolerance).containsExactly(someValues).inOrder(), noting the different behaviour for non-finite values
com.google.common.truth.ListMultimapSubject.isEqualTo(SetMultimap<?, ?>) #isEqualTo A SetMultimap can never compare equal with a ListMultimap if either Multimap is non-empty, because Set and List can never compare equal. Prefer MultimapSubject.containsExactlyEntriesIn(com.google.common.collect.Multimap) instead. Consult Multimap.equals(java.lang.Object) for more information.
com.google.common.truth.extensions.proto.ListMultimapWithProtoValuesSubject.isEqualTo(SetMultimap<?, ?>) #isEqualTo A SetMultimap can never compare equal with a ListMultimap if either Multimap is non-empty, because Set and List can never compare equal. Prefer MultimapWithProtoValuesSubject.containsExactlyEntriesIn( com.google.common.collect.Multimap) instead. Consult Multimap.equals(java.lang.Object) for more information.
com.google.common.truth.DoubleSubject.isEquivalentAccordingToCompareTo(Double) Use DoubleSubject.isWithin(double) or DoubleSubject.isEqualTo(java.lang.Double) instead (see documentation for advice).
com.google.common.truth.FloatSubject.isEquivalentAccordingToCompareTo(Float) Use FloatSubject.isWithin(float) or FloatSubject.isEqualTo(java.lang.Float) instead (see documentation for advice).
com.google.common.truth.IntegerSubject.isEquivalentAccordingToCompareTo(Integer) Use Subject.isEqualTo(java.lang.Object) instead. Integer comparison is consistent with equality.
com.google.common.truth.LongSubject.isEquivalentAccordingToCompareTo(Long) Use Subject.isEqualTo(java.lang.Object) instead. Long comparison is consistent with equality.
com.google.common.truth.StringSubject.isEquivalentAccordingToCompareTo(String) Use StringSubject.isEqualTo(java.lang.Object) instead. String comparison is consistent with equality.
com.google.common.truth.extensions.proto.LiteProtoSubject.isNotEqualTo(MessageLite.Builder) A Builder will never compare equal to a MessageLite instance. Use build(), or buildPartial() on the argument to get a MessageLite for comparison instead.
com.google.common.truth.AtomicLongMapSubject.isNotEqualTo(Object) AtomicLongMap does not define equality (i.e., it does not implement equals()), so you probably don't want to call this method. Instead, perform your assertion on the map view (e.g., assertThat(atomicLongMap.asMap()).isNotEqualTo(UNEXPECTED_MAP)).
com.google.common.truth.PrimitiveDoubleArraySubject.isNotEqualTo(Object, double) Write a for loop over the values looking for mismatches (see this implementation for an example)
com.google.common.truth.PrimitiveFloatArraySubject.isNotEqualTo(Object, float) Write a for loop over the values looking for mismatches (see this implementation for an example)
com.google.common.truth.IterableSubject.isPartiallyOrdered() Use IterableSubject.isOrdered() instead.
com.google.common.truth.IterableSubject.isPartiallyOrdered(Comparator<?>) Use IterableSubject.isOrdered(Comparator) instead.