com.google.common.truth

Class Truth

java.lang.Object

com.google.common.truth.Truth

public final class Truth
extends Object

Truth - a proposition framework for tests, supporting JUnit style assertion and assumption semantics in a fluent style. Truth is the simplest entry point class. A developer can statically import the assertThat() method to get easy access to the library's capabilities. Then, instead of writing:

Assert.assertEquals(a, b);
 Assert.assertTrue(c);
 Assert.assertTrue(d.contains(a));
 Assert.assertTrue(d.contains(a) && d.contains(b));
 Assert.assertTrue(d.contains(a) || d.contains(b) || d.contains(c));
 

one would write:

assertThat(a).isEqualTo(b);
 assertThat(c).isTrue();
 assertThat(d).contains(a);
 assertThat(d).containsAllOf(a, b);
 assertThat(d).containsAnyOf(a, b, c);
 

Tests should be easier to read, and flow more clearly.

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
static TestVerb	ASSERT
static FailureStrategy	THROW_ASSERTION_ERROR

Constructor Summary

Constructors

Constructor and Description
Truth()

Method Summary

Methods

Modifier and Type	Method and Description
static TestVerb	assert_()
static <S extends Subject<S,T>,T,SF extends SubjectFactory<S,T>> AbstractVerb.DelegatedVerb<S,T>	assertAbout(SF factory) The recommended method of extension of Truth to new types, which is documented in com.google.common.truth.delegation.DelegationTest.
static BooleanSubject	assertThat(Boolean target)
static PrimitiveBooleanArraySubject	assertThat(boolean[] target)
static PrimitiveByteArraySubject	assertThat(byte[] target)
static PrimitiveCharArraySubject	assertThat(char[] target)
static ClassSubject	assertThat(Class<?> target)
static <T,C extends Collection<T>> CollectionSubject<? extends CollectionSubject<?,T,C>,T,C>	assertThat(Collection<T> target) Deprecated. Use the Iterable overload instead.
static PrimitiveDoubleArraySubject	assertThat(double[] target)
static PrimitiveFloatArraySubject	assertThat(float[] target)
static PrimitiveIntArraySubject	assertThat(int[] target)
static IntegerSubject	assertThat(Integer target)
static <T,C extends Iterable<T>> IterableSubject<? extends IterableSubject<?,T,C>,T,C>	assertThat(Iterable<T> target)
static <T,C extends List<T>> ListSubject<? extends ListSubject<?,T,C>,T,C>	assertThat(List<T> target)
static <K,V,M extends com.google.common.collect.ListMultimap<K,V>> ListMultimapSubject<? extends ListMultimapSubject<?,K,V,M>,K,V,M>	assertThat(com.google.common.collect.ListMultimap<K,V> target)
static LongSubject	assertThat(Long target)
static PrimitiveLongArraySubject	assertThat(long[] target)
static <K,V,M extends Map<K,V>> MapSubject<? extends MapSubject<?,K,V,M>,K,V,M>	assertThat(Map<K,V> target)
static <K,V,M extends com.google.common.collect.Multimap<K,V>> MultimapSubject<? extends MultimapSubject<?,K,V,M>,K,V,M>	assertThat(com.google.common.collect.Multimap<K,V> target)
static <E,M extends com.google.common.collect.Multiset<E>> MultisetSubject<? extends MultisetSubject<?,E,M>,E,M>	assertThat(com.google.common.collect.Multiset<E> target)
static Subject<DefaultSubject,Object>	assertThat(Object target)
static <T> OptionalSubject<T>	assertThat(com.google.common.base.Optional<T> target)
static <K,V,M extends com.google.common.collect.SetMultimap<K,V>> SetMultimapSubject<? extends SetMultimapSubject<?,K,V,M>,K,V,M>	assertThat(com.google.common.collect.SetMultimap<K,V> target)
static StringSubject	assertThat(String target)
static <T extends Comparable<?>> ComparableSubject<?,T>	assertThat(T target)
static <T> ObjectArraySubject<T>	assertThat(T[] target)
static <R,C,V,M extends com.google.common.collect.Table<R,C,V>> TableSubject<? extends TableSubject<?,R,C,V,M>,R,C,V,M>	assertThat(com.google.common.collect.Table<R,C,V> target)
static ThrowableSubject	assertThat(Throwable target)
static TestVerb	assertWithMessage(String messageToPrepend) Returns a TestVerb that will prepend the given message to the failure message in the event of a test failure.

Methods inherited from class java.lang.Object

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

Field Detail

THROW_ASSERTION_ERROR

public static final FailureStrategy THROW_ASSERTION_ERROR

ASSERT

public static final TestVerb ASSERT

Constructor Detail

Truth

public Truth()

Method Detail

assert_

public static TestVerb assert_()

assertWithMessage

public static TestVerb assertWithMessage(String messageToPrepend)

Returns a TestVerb that will prepend the given message to the failure message in the event of a test failure.

assertAbout

public static <S extends Subject<S,T>,T,SF extends SubjectFactory<S,T>> AbstractVerb.DelegatedVerb<S,T> assertAbout(SF factory)

The recommended method of extension of Truth to new types, which is documented in com.google.common.truth.delegation.DelegationTest.

Parameters:

factory - a SubjectFactory implementation

assertThat

@CheckReturnValue
public static <T extends Comparable<?>> ComparableSubject<?,T> assertThat(T target)

assertThat

@CheckReturnValue
public static Subject<DefaultSubject,Object> assertThat(Object target)

assertThat

@CheckReturnValue
@GwtIncompatible(value="ClassSubject.java")
public static ClassSubject assertThat(Class<?> target)

assertThat

@CheckReturnValue
public static ThrowableSubject assertThat(Throwable target)

assertThat

@CheckReturnValue
public static LongSubject assertThat(Long target)

assertThat

@CheckReturnValue
public static IntegerSubject assertThat(Integer target)

assertThat

@CheckReturnValue
public static BooleanSubject assertThat(Boolean target)

assertThat

@CheckReturnValue
public static StringSubject assertThat(String target)

assertThat

@CheckReturnValue
public static <T,C extends Iterable<T>> IterableSubject<? extends IterableSubject<?,T,C>,T,C> assertThat(Iterable<T> target)

assertThat

@Deprecated
@CheckReturnValue
public static <T,C extends Collection<T>> CollectionSubject<? extends CollectionSubject<?,T,C>,T,C> assertThat(Collection<T> target)

Deprecated. Use the Iterable overload instead.

assertThat

@CheckReturnValue
public static <T,C extends List<T>> ListSubject<? extends ListSubject<?,T,C>,T,C> assertThat(List<T> target)

assertThat

@CheckReturnValue
public static <T> ObjectArraySubject<T> assertThat(T[] target)

assertThat

@CheckReturnValue
public static PrimitiveBooleanArraySubject assertThat(boolean[] target)

assertThat

@CheckReturnValue
public static PrimitiveIntArraySubject assertThat(int[] target)

assertThat

@CheckReturnValue
public static PrimitiveLongArraySubject assertThat(long[] target)

assertThat

@CheckReturnValue
public static PrimitiveByteArraySubject assertThat(byte[] target)

assertThat

@CheckReturnValue
public static PrimitiveCharArraySubject assertThat(char[] target)

assertThat

@CheckReturnValue
public static PrimitiveFloatArraySubject assertThat(float[] target)

assertThat

@CheckReturnValue
public static PrimitiveDoubleArraySubject assertThat(double[] target)

assertThat

@CheckReturnValue
public static <T> OptionalSubject<T> assertThat(com.google.common.base.Optional<T> target)

assertThat

@CheckReturnValue
public static <K,V,M extends Map<K,V>> MapSubject<? extends MapSubject<?,K,V,M>,K,V,M> assertThat(Map<K,V> target)

assertThat

@CheckReturnValue
public static <K,V,M extends com.google.common.collect.Multimap<K,V>> MultimapSubject<? extends MultimapSubject<?,K,V,M>,K,V,M> assertThat(com.google.common.collect.Multimap<K,V> target)

assertThat

@CheckReturnValue
public static <K,V,M extends com.google.common.collect.ListMultimap<K,V>> ListMultimapSubject<? extends ListMultimapSubject<?,K,V,M>,K,V,M> assertThat(com.google.common.collect.ListMultimap<K,V> target)

assertThat

@CheckReturnValue
public static <K,V,M extends com.google.common.collect.SetMultimap<K,V>> SetMultimapSubject<? extends SetMultimapSubject<?,K,V,M>,K,V,M> assertThat(com.google.common.collect.SetMultimap<K,V> target)

assertThat

@CheckReturnValue
public static <E,M extends com.google.common.collect.Multiset<E>> MultisetSubject<? extends MultisetSubject<?,E,M>,E,M> assertThat(com.google.common.collect.Multiset<E> target)

assertThat

@CheckReturnValue
public static <R,C,V,M extends com.google.common.collect.Table<R,C,V>> TableSubject<? extends TableSubject<?,R,C,V,M>,R,C,V,M> assertThat(com.google.common.collect.Table<R,C,V> target)