org.truth0.subjects
Class Subject<S extends Subject<S,T>,T>

java.lang.Object
  org.truth0.subjects.Subject<S,T>

Direct Known Subclasses:

BooleanSubject, ClassSubject, DefaultSubject, IntegerSubject, IterableSubject, MapSubject, StringSubject

public class Subject<S extends Subject<S,T>,T>
extends Object

Propositions for arbitrarily typed subjects and for properties of Object

Author:

David Saff, Christian Gruber (cgruber@israfil.net)

Field Summary

protected FailureStrategy

failureStrategy

Constructor Summary

Subject(FailureStrategy failureStrategy, T subject)

Method Summary

protected TestVerb	check()
boolean	equals(Object o) Deprecated. This method is not a proposition, but the default Object equality method. Testing code should use "is" or "isEqualTo" propositions for equality tests.
protected void	fail(String verb, Object... messageParts) Assembles a failure message and passes such to the FailureStrategy
protected void	failWithBadResults(String verb, Object expected, String failVerb, Object actual) Assembles a failure message and passes it to the FailureStrategy
protected 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 FailureStrategy
protected void	failWithoutSubject(String verb) Assembles a failure message wihtout a given subject and passes it to the FailureStrategy
protected void	failWithRawMessage(String message, Object... parameters) Passes through a failure message verbatim.
protected T	getDisplaySubject()
protected T	getSubject()
int	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.
void	is(Object other)
void	isEqualTo(Object other)
void	isNotEqualTo(Object other)
void	isNotNull()
void	isNull()

Methods inherited from class java.lang.Object

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

Field Detail

failureStrategy

protected final FailureStrategy failureStrategy

Constructor Detail

Subject

public Subject(FailureStrategy failureStrategy,
               T subject)

Method Detail

is

public void is(Object other)

isNull

public void isNull()

isNotNull

public void isNotNull()

isEqualTo

public void isEqualTo(Object other)

isNotEqualTo

public void isNotEqualTo(Object other)

getSubject

protected T getSubject()

getDisplaySubject

protected T getDisplaySubject()

check

protected TestVerb check()

fail

protected void fail(String verb,
                    Object... messageParts)

Assembles a failure message and passes such to the FailureStrategy

Parameters:

verb - the proposition being asserted

messageParts - the expectations against which the subject is compared

failWithBadResults

protected void failWithBadResults(String verb,
                                  Object expected,
                                  String failVerb,
                                  Object actual)

Assembles a failure message and passes it to the FailureStrategy

Parameters:

verb - the proposition being asserted

messageParts - the expectations against which the subject is compared

failWithCustomSubject

protected 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 FailureStrategy

Parameters:

verb - the proposition being asserted

expected - the expected value of the proposition

actual - the custom representation of the subject to be reported in the failure.

failWithoutSubject

protected void failWithoutSubject(String verb)

Assembles a failure message wihtout a given subject and passes it to the FailureStrategy

Parameters:

verb - the proposition being asserted

failWithRawMessage

protected void failWithRawMessage(String message,
                                  Object... parameters)

Passes through a failure message verbatim. Used for Subject subclasses which need to provide alternate language for more fit-to-purpose error messages.

Parameters:

message - the full message to be passed to the failure.

equals

@Deprecated
public boolean equals(Object o)

Deprecated. This method is not a proposition, but the default Object equality method. Testing code should use "is" or "isEqualTo" propositions for equality tests.

Overrides:

equals in class Object

hashCode

@Deprecated
public int 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.

Overrides:

hashCode in class Object