Class LiteProtoSubject

java.lang.Object

com.google.common.truth.Subject

com.google.common.truth.extensions.proto.LiteProtoSubject

Direct Known Subclasses:

ProtoSubject

@CheckReturnValue
@NullMarked
public class LiteProtoSubject
extends Subject

Truth subjects for the Lite version of Protocol Buffers.

LiteProtoSubject supports versions 2 and 3 of Protocol Buffers. Due to the lack of runtime descriptors, its functionality is limited compared to ProtoSubject, in particular in performing detailed comparisons between messages.

Nested Class Summary

Nested classes/interfaces inherited from class Subject

Subject.Factory<SubjectT,ActualT>

Modifier and Type	Class	Description
static interface	Subject.Factory<SubjectT extends Subject, ActualT>	In a fluent assertion chain, the argument to the common overload of about, the method that specifies what kind of Subject to create.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	LiteProtoSubject(FailureMetadata failureMetadata, @Nullable MessageLite messageLite)

Method Summary

Modifier and Type	Method	Description
protected String	actualCustomStringRepresentation()	Returns a string representation of the actual value for inclusion in failure messages.
void	hasAllRequiredFields()	Checks whether the subject has all required fields set.
void	isEqualTo(@Nullable MessageLite.Builder builder)	DO NOT CALL THIS METHOD!
void	isEqualTo(@Nullable Object expected)	Checks whether the MessageLite is equivalent to the argument, using the standard equals() implementation.
void	isEqualToDefaultInstance()	Checks whether the subject is a MessageLite with no fields set.
void	isNotEqualTo(@Nullable MessageLite.Builder builder)	DO NOT CALL THIS METHOD!
void	isNotEqualTo(@Nullable Object expected)	Checks that the value under test is not equal to the given object.
void	isNotEqualToDefaultInstance()	Checks whether the subject is not equivalent to a MessageLite with no fields set.
IntegerSubject	serializedSize()	Returns an IntegerSubject on the serialized size of the MessageLite.

Methods inherited from class Subject

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

Modifier and Type	Method	Description
protected final StandardSubjectBuilder	check(String format, @Nullable Object... args)	Returns a builder for creating a derived subject.
final boolean	equals(@Nullable Object other)	Deprecated. Object.equals(Object) is not supported on Truth subjects.
protected final void	failWithActual(Fact first, Fact... rest)	Fails, reporting a message with the given facts, followed by an automatically added fact of the form: but was: actual value.
protected final void	failWithActual(String key, @Nullable Object value)	Fails, reporting a message with two "facts": key: value but was: actual value.
protected final void	failWithoutActual(Fact first, Fact... rest)	Fails, reporting a message with the given facts, without automatically adding the actual value.
final int	hashCode()	Deprecated. Object.hashCode() is not supported on Truth subjects.
protected final StandardSubjectBuilder	ignoreCheck()	Begins a new call chain that ignores any failures.
void	isAnyOf(@Nullable Object first, @Nullable Object second, @Nullable Object... rest)	Checks that the value under test is equal to any of the given elements.
void	isIn(@Nullable Iterable<?> iterable)	Checks that the value under test is equal to any element in the given iterable.
void	isInstanceOf(@Nullable Class<?> clazz)	Checks that the value under test is an instance of the given class.
void	isNoneOf(@Nullable Object first, @Nullable Object second, @Nullable Object... rest)	Checks that the value under test is not equal to any of the given elements.
void	isNotIn(@Nullable Iterable<?> iterable)	Checks that the value under test is not equal to any element in the given iterable.
void	isNotInstanceOf(@Nullable Class<?> clazz)	Checks that the value under test is not an instance of the given class.
void	isNotNull()	Checks that the value under test is not null.
final void	isNotSameInstanceAs(@Nullable Object other)	Checks that the value under test is not the same instance as the given object.
void	isNull()	Checks that the value under test is null.
final void	isSameInstanceAs(@Nullable Object expected)	Checks that the value under test is the same instance as the given object.
String	toString()	Deprecated. Object.toString() is not supported on Truth subjects.

Methods inherited from class Object

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

Constructor Details

LiteProtoSubject

protected LiteProtoSubject(FailureMetadata failureMetadata,
 @Nullable MessageLite messageLite)

Method Details

actualCustomStringRepresentation

protected String actualCustomStringRepresentation()

Description copied from class: Subject

Returns a string representation of the actual value for inclusion in failure messages.

Subjects should override this with care.

By default, this method returns String.valueOf(getActualValue()) for most types. It does have some special logic for a few cases, like arrays.

Overrides:

actualCustomStringRepresentation in class Subject

isEqualTo

public void isEqualTo(@Nullable Object expected)

Checks whether the MessageLite is equivalent to the argument, using the standard equals() implementation.

Overrides:

isEqualTo in class Subject

isEqualTo

public void isEqualTo(@Nullable MessageLite.Builder builder)

DO NOT CALL THIS METHOD!. A MessageLite.Builder will never compare equal to a MessageLite instance. Use build(), or buildPartial() on the argument to get a MessageLite for comparison instead. Or, if you are passing null, use Subject.isNull().

isNotEqualTo

public void isNotEqualTo(@Nullable Object expected)

Description copied from class: Subject

Checks that the value under test is not equal to the given object. The meaning of equality is the same as for the Subject.isEqualTo(Object) method.

Overrides:

isNotEqualTo in class Subject

isNotEqualTo

public void isNotEqualTo(@Nullable MessageLite.Builder builder)

DO NOT CALL THIS METHOD!. A MessageLite.Builder will never compare equal to a MessageLite instance. Use build(), or buildPartial() on the argument to get a MessageLite for comparison instead. Or, if you are passing null, use Subject.isNotNull().

isEqualToDefaultInstance

@J2ObjCIncompatible
public void isEqualToDefaultInstance()

Checks whether the subject is a MessageLite with no fields set.

isNotEqualToDefaultInstance

@J2ObjCIncompatible
public void isNotEqualToDefaultInstance()

Checks whether the subject is not equivalent to a MessageLite with no fields set.

hasAllRequiredFields

@J2ObjCIncompatible
@GwtIncompatible
public void hasAllRequiredFields()

Checks whether the subject has all required fields set. Cannot fail for a proto built with build(), which itself fails if required fields aren't set.

serializedSize

@GwtIncompatible
public IntegerSubject serializedSize()

Returns an IntegerSubject on the serialized size of the MessageLite.

Assertions can then be changed on the serialized size, to support checks such as assertThat(myProto).serializedSize().isAtLeast(16), etc.