com.google.common.truth

Class IterableSubject

java.lang.Object

com.google.common.truth.Subject<IterableSubject,Iterable<?>>

com.google.common.truth.IterableSubject

Direct Known Subclasses:

MultisetSubject, SortedSetSubject

public class IterableSubject
extends Subject<IterableSubject,Iterable<?>>

Propositions for Iterable subjects.

Note:

• Assertions may iterate through the given Iterable more than once. If you have an unusual implementation of Iterable which does not support multiple iterations (sometimes known as a "one-shot iterable"), you must copy your iterable into a collection which does (e.g. ImmutableList.copyOf(iterable) or, if your iterable may contain null, newArrayList(iterable)). If you don't, you may see surprising failures.
• Assertions may also require that the elements in the given Iterable implement Object.hashCode() correctly.

Author:

Kurt Alfred Kluever, Pete Gillin

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	IterableSubject.UsingCorrespondence<A,E> A partially specified proposition in which the actual elements (normally the elements of the Iterable under test) are compared to expected elements using a Correspondence.

Nested classes/interfaces inherited from class com.google.common.truth.Subject

Subject.Factory<SubjectT extends Subject<SubjectT,ActualT>,ActualT>

Field Summary

Fields inherited from class com.google.common.truth.Subject

failureStrategy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	IterableSubject(FailureMetadata metadata, Iterable<?> list)
protected	IterableSubject(FailureStrategy failureStrategy, Iterable<?> list) Deprecated. Switch your Subject from accepting FailureStrategy (and exposing a SubjectFactory) to accepting a FailureMetadata (and exposing a Subject.Factory), at which point you'll call the FailureMetadata overload of this constructor instead.

Method Summary

Modifier and Type	Method and Description
<A,E> IterableSubject.UsingCorrespondence<A,E>	comparingElementsUsing(Correspondence<A,E> correspondence) Starts a method chain for a test proposition in which the actual elements (i.e.
void	contains(Object element) Attests (with a side-effect failure) that the subject contains the supplied item.
Ordered	containsAllIn(Iterable<?> expected) Attests that the actual iterable contains at least all of the expected elements or fails.
Ordered	containsAllOf(Object firstExpected, Object secondExpected, Object... restOfExpected) Attests that the actual iterable contains at least all of the expected elements or fails.
void	containsAnyIn(Iterable<?> expected) Attests that the subject contains at least one of the objects contained in the provided collection or fails.
void	containsAnyOf(Object first, Object second, Object... rest) Attests that the subject contains at least one of the provided objects or fails.
Ordered	containsExactly(Object... varargs) Attests that a subject contains exactly the provided objects or fails.
Ordered	containsExactlyElementsIn(Iterable<?> expected) Attests that a subject contains exactly the provided objects or fails.
void	containsNoDuplicates() Attests that the subject does not contain duplicate elements.
void	containsNoneIn(Iterable<?> excluded) Attests that a actual iterable contains none of the elements contained in the excluded iterable or fails.
void	containsNoneOf(Object firstExcluded, Object secondExcluded, Object... restOfExcluded) Attests that a actual iterable contains none of the excluded objects or fails.
void	doesNotContain(Object element) Attests (with a side-effect failure) that the subject does not contain the supplied item.
protected void	failWithBadResultsAndSuffix(String verb, Object expected, String failVerb, Object actual, String suffix) Fails with the bad results and a suffix.
void	hasSize(int expectedSize) Fails if the subject does not have the given size.
void	isEmpty() Fails if the subject is not empty.
void	isNotEmpty() Fails if the subject is empty.
void	isOrdered() Fails if the iterable is not ordered, according to the natural ordering of its elements.
void	isOrdered(Comparator<?> comparator) Fails if the iterable is not ordered, according to the given comparator.
void	isPartiallyOrdered() Deprecated. Use isOrdered() instead.
void	isPartiallyOrdered(Comparator<?> comparator) Deprecated. Use isOrdered(Comparator) instead.
void	isStrictlyOrdered() Fails if the iterable is not strictly ordered, according to the natural ordering of its elements.
void	isStrictlyOrdered(Comparator<?> comparator) Fails if the iterable is not strictly ordered, according to the given comparator.

Methods inherited from class com.google.common.truth.Subject

actual, actualAsString, actualCustomStringRepresentation, check, equals, fail, fail, fail, failComparing, failComparing, failWithBadResults, failWithCustomSubject, failWithoutActual, failWithoutSubject, failWithRawMessage, failWithRawMessageAndCause, getDisplaySubject, getSubject, hashCode, ignoreCheck, internalCustomName, isAnyOf, isEqualTo, isIn, isInstanceOf, isNoneOf, isNotEqualTo, isNotIn, isNotInstanceOf, isNotNull, isNotSameAs, isNull, isSameAs, named

Methods inherited from class java.lang.Object

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

Constructor Detail

IterableSubject

@Deprecated
protected IterableSubject(FailureStrategy failureStrategy,
                                      @Nullable
                                      Iterable<?> list)

Deprecated. Switch your Subject from accepting FailureStrategy (and exposing a SubjectFactory) to accepting a FailureMetadata (and exposing a Subject.Factory), at which point you'll call the FailureMetadata overload of this constructor instead.

IterableSubject

protected IterableSubject(FailureMetadata metadata,
                          @Nullable
                          Iterable<?> list)

Method Detail

isEmpty

public final void isEmpty()

Fails if the subject is not empty.

isNotEmpty

public final void isNotEmpty()

Fails if the subject is empty.

hasSize

public final void hasSize(int expectedSize)

Fails if the subject does not have the given size.

contains

public final void contains(@Nullable
                           Object element)

Attests (with a side-effect failure) that the subject contains the supplied item.

doesNotContain

public final void doesNotContain(@Nullable
                                 Object element)

Attests (with a side-effect failure) that the subject does not contain the supplied item.

containsNoDuplicates

public final void containsNoDuplicates()

Attests that the subject does not contain duplicate elements.

containsAnyOf

public final void containsAnyOf(@Nullable
                                Object first,
                                @Nullable
                                Object second,
                                @Nullable
                                Object... rest)

Attests that the subject contains at least one of the provided objects or fails.

containsAnyIn

public final void containsAnyIn(Iterable<?> expected)

Attests that the subject contains at least one of the objects contained in the provided collection or fails.

containsAllOf

public final Ordered containsAllOf(@Nullable
                                   Object firstExpected,
                                   @Nullable
                                   Object secondExpected,
                                   @Nullable
                                   Object... restOfExpected)

Attests that the actual iterable contains at least all of the expected elements or fails. If an element appears more than once in the expected elements to this call then it must appear at least that number of times in the actual elements.

To also test that the contents appear in the given order, make a call to inOrder() on the object returned by this method. The expected elements must appear in the given order within the actual elements, but they are not required to be consecutive.

containsAllIn

public final Ordered containsAllIn(Iterable<?> expected)

Attests that the actual iterable contains at least all of the expected elements or fails. If an element appears more than once in the expected elements then it must appear at least that number of times in the actual elements.

To also test that the contents appear in the given order, make a call to inOrder() on the object returned by this method. The expected elements must appear in the given order within the actual elements, but they are not required to be consecutive.

containsExactly

public final Ordered containsExactly(@Nullable
                                     Object... varargs)

Attests that a subject contains exactly the provided objects or fails.

Multiplicity is respected. For example, an object duplicated exactly 3 times in the parameters asserts that the object must likewise be duplicated exactly 3 times in the subject.

To also test that the contents appear in the given order, make a call to inOrder() on the object returned by this method.

containsExactlyElementsIn

public final Ordered containsExactlyElementsIn(Iterable<?> expected)

Attests that a subject contains exactly the provided objects or fails.

Multiplicity is respected. For example, an object duplicated exactly 3 times in the Iterable parameter asserts that the object must likewise be duplicated exactly 3 times in the subject.

To also test that the contents appear in the given order, make a call to inOrder() on the object returned by this method.

failWithBadResultsAndSuffix

protected final void failWithBadResultsAndSuffix(String verb,
                                                 Object expected,
                                                 String failVerb,
                                                 Object actual,
                                                 String suffix)

Fails with the bad results and a suffix.

Parameters:

verb - the proposition being asserted

expected - the expectations against which the subject is compared

failVerb - the failure of the proposition being asserted

actual - the actual value the subject was compared against

suffix - a suffix to append to the failure message

containsNoneOf

public final void containsNoneOf(@Nullable
                                 Object firstExcluded,
                                 @Nullable
                                 Object secondExcluded,
                                 @Nullable
                                 Object... restOfExcluded)

Attests that a actual iterable contains none of the excluded objects or fails. (Duplicates are irrelevant to this test, which fails if any of the actual elements equal any of the excluded.)

containsNoneIn

public final void containsNoneIn(Iterable<?> excluded)

Attests that a actual iterable contains none of the elements contained in the excluded iterable or fails. (Duplicates are irrelevant to this test, which fails if any of the actual elements equal any of the excluded.)

isStrictlyOrdered

public final void isStrictlyOrdered()

Fails if the iterable is not strictly ordered, according to the natural ordering of its elements. Strictly ordered means that each element in the iterable is strictly greater than the element that preceded it.

Throws:

ClassCastException - if any pair of elements is not mutually Comparable

NullPointerException - if any element is null

isStrictlyOrdered

public final void isStrictlyOrdered(Comparator<?> comparator)

Fails if the iterable is not strictly ordered, according to the given comparator. Strictly ordered means that each element in the iterable is strictly greater than the element that preceded it.

Throws:

ClassCastException - if any pair of elements is not mutually Comparable

isOrdered

public final void isOrdered()

Fails if the iterable is not ordered, according to the natural ordering of its elements. Ordered means that each element in the iterable is greater than or equal to the element that preceded it.

Throws:

ClassCastException - if any pair of elements is not mutually Comparable

NullPointerException - if any element is null

isPartiallyOrdered

@Deprecated
public final void isPartiallyOrdered()

Deprecated. Use isOrdered() instead.

isOrdered

public final void isOrdered(Comparator<?> comparator)

Fails if the iterable is not ordered, according to the given comparator. Ordered means that each element in the iterable is greater than or equal to the element that preceded it.

Throws:

ClassCastException - if any pair of elements is not mutually Comparable

isPartiallyOrdered

@Deprecated
public final void isPartiallyOrdered(Comparator<?> comparator)

Deprecated. Use isOrdered(Comparator) instead.

comparingElementsUsing

public <A,E> IterableSubject.UsingCorrespondence<A,E> comparingElementsUsing(Correspondence<A,E> correspondence)

Starts a method chain for a test proposition in which the actual elements (i.e. the elements of the Iterable under test) are compared to expected elements using the given Correspondence. The actual elements must be of type A, the expected elements must be of type E. The proposition is actually executed by continuing the method chain. For example:

 assertThat(actualIterable).comparingElementsUsing(correspondence).contains(expected);
 

where actualIterable is an Iterable<A> (or, more generally, an Iterable<? extends A>), correspondence is a Correspondence<A, E>, and expected is an E.

Any of the methods on the returned object may throw ClassCastException if they encounter an actual element that is not of type A.