Package com.google.common.truth
Class Subject<S extends Subject<S,T>,T>
java.lang.Object
com.google.common.truth.Subject<S,T>
- Direct Known Subclasses:
AbstractArraySubject
,ClassSubject
,ComparableSubject
,DefaultSubject
,IterableSubject
,MapSubject
,OptionalSubject
,Subject
Propositions for arbitrarily typed subjects and for properties
of Object
-
Nested Class Summary
Nested Classes -
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected TestVerb
check()
A convenience for implementers ofSubject
subclasses to use other truthSubject
wrappers within their own propositional logic.boolean
Deprecated.This method is not a proposition, but the default Object equality method.protected void
Assembles a failure message and passes such to the FailureStrategyprotected void
Assembles a failure message and passes such to the FailureStrategy.protected void
Assembles a failure message and passes such to the FailureStrategyprotected void
failWithBadResults
(String verb, Object expected, String failVerb, Object actual) Assembles a failure message and passes it to the FailureStrategyprotected void
failWithCustomSubject
(String verb, Object expected, Object actual) Assembles a failure message with an alternative representation of the wrapped subject and passes it to the FailureStrategyprotected void
failWithoutSubject
(String verb) Assembles a failure message without a given subject and passes it to the FailureStrategyprotected void
failWithRawMessage
(String message, Object... parameters) Passes through a failure message verbatim.protected String
protected T
int
hashCode()
Deprecated.Equals/Hashcode is not supported on Subjects.protected String
void
Deprecated.UseisEqualTo(Object)
to check object equality orisSameAs(Object)
to check reference equality.void
Deprecated.UseisInstanceOf(java.lang.Class<?>)
instead.void
Fails if the subject is not equal to the given object.void
isInstanceOf
(Class<?> clazz) Fails if the subject is not an instance of the given class.void
Deprecated.UseisNotInstanceOf(Class)
instead.void
isNotEqualTo
(Object other) Fails if the subject is equal to the given object.void
isNotInstanceOf
(Class<?> clazz) Fails if the subject is an instance of the given class.void
Fails if the subject is null.void
isNotSameAs
(Object other) Fails if the subject is the same instance as the given object.void
isNull()
Fails if the subject is not null.void
Fails if the subject is not the same instance as the given object.Deprecated.Usenamed(String)
instead.Renames the subject so that this name appears in the error messages in place of string representations of the subject.
-
Field Details
-
failureStrategy
-
subject
-
customName
-
-
Constructor Details
-
Subject
-
-
Method Details
-
internalCustomName
-
named
Renames the subject so that this name appears in the error messages in place of string representations of the subject. -
labeled
Deprecated.Usenamed(String)
instead. -
is
Deprecated.UseisEqualTo(Object)
to check object equality orisSameAs(Object)
to check reference equality. -
isNull
public void isNull()Fails if the subject is not null. -
isNotNull
public void isNotNull()Fails if the subject is null. -
isEqualTo
Fails if the subject is not equal to the given object. -
isNotEqualTo
Fails if the subject is equal to the given object. -
isSameAs
Fails if the subject is not the same instance as the given object. -
isNotSameAs
Fails if the subject is the same instance as the given object. -
isA
Deprecated.UseisInstanceOf(java.lang.Class<?>)
instead.Fails if the subject is not an instance of the given class. -
isNotA
Deprecated.UseisNotInstanceOf(Class)
instead.Fails if the subject is an instance of the given class. -
isInstanceOf
Fails if the subject is not an instance of the given class. -
isNotInstanceOf
Fails if the subject is an instance of the given class. -
getSubject
-
getDisplaySubject
-
check
A convenience for implementers ofSubject
subclasses to use other truthSubject
wrappers within their own propositional logic. -
fail
Assembles a failure message and passes such to the FailureStrategy- Parameters:
verb
- the proposition being asserted
-
fail
Assembles a failure message and passes such to the FailureStrategy. Also performs disambiguation if the subject andpart
have the same toString()'s.- Parameters:
verb
- the proposition being assertedpart
- the value against which the subject is compared
-
fail
Assembles a failure message and passes such to the FailureStrategy- Parameters:
verb
- the proposition being assertedmessageParts
- the expectations against which the subject is compared
-
failWithBadResults
Assembles a failure message and passes it to the FailureStrategy- Parameters:
verb
- the proposition being assertedmessageParts
- the expectations against which the subject is compared
-
failWithCustomSubject
Assembles a failure message with an alternative representation of the wrapped subject and passes it to the FailureStrategy- Parameters:
verb
- the proposition being assertedexpected
- the expected value of the propositionactual
- the custom representation of the subject to be reported in the failure.
-
failWithoutSubject
Assembles a failure message without a given subject and passes it to the FailureStrategy- Parameters:
verb
- the proposition being asserted
-
failWithRawMessage
Passes through a failure message verbatim. Used forSubject
subclasses which need to provide alternate language for more fit-to-purpose error messages.- Parameters:
message
- the message template to be passed to the failure. Note, this method only guarantees to process%s
tokens. It is not guaranteed to be compatible withString.format()
. Any other formatting desired (such as floats or scientific notation) should be performed before the method call and the formatted value passed in as a string.paramters
- the object parameters which will be applied to the message template.
-
hasField
-
equals
Deprecated.This method is not a proposition, but the default Object equality method. Testing code should use "is" or "isEqualTo" propositions for equality tests. -
hashCode
Deprecated.Equals/Hashcode is not supported on Subjects. Their only use is as a holder of propositions. Use of equals() is deprecated and forwards to isEqualTo() and hashCode() is disallowed.
-