BaseTestConsumer (RxJava Javadoc 3.0.0-RC4)

java.lang.Object
- io.reactivex.rxjava3.observers.BaseTestConsumer<T,U>

Type Parameters:

T - the value type consumed

U - the subclass of this BaseTestConsumer

Direct Known Subclasses:

TestObserver, TestSubscriber
```
public abstract class BaseTestConsumer<T,U extends BaseTestConsumer<T,U>>
extends Object
```
Base class with shared infrastructure to support TestSubscriber and TestObserver.

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`checkSubscriptionOnce`
`protected long`	`completions` The number of completions.
`protected CountDownLatch`	`done` The latch that indicates an onError or onComplete has been called.
`protected List<Throwable>`	`errors` The list of errors received.
`protected Thread`	`lastThread` The last thread seen by the observer.
`protected CharSequence`	`tag` The optional tag associated with this test consumer.
`protected boolean`	`timeout` Indicates that one of the awaitX method has timed out.
`protected List<T>`	`values` The list of values received.

Constructor Summary

Constructors
Constructor and Description

BaseTestConsumer()

Constructors
Constructor and Description
`BaseTestConsumer()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`U`	`assertComplete()` Assert that this TestObserver/TestSubscriber received exactly one onComplete event.
`U`	`assertEmpty()` Assert that the TestObserver/TestSubscriber has received a Disposable but no other events.
`U`	`assertError(Class<? extends Throwable> errorClass)` Asserts that this TestObserver/TestSubscriber received exactly one onError event which is an instance of the specified errorClass class.
`U`	`assertError(Predicate<Throwable> errorPredicate)` Asserts that this TestObserver/TestSubscriber received exactly one onError event for which the provided predicate returns true.
`U`	`assertError(Throwable error)` Assert that this TestObserver/TestSubscriber received exactly the specified onError event value.
`U`	`assertFailure(Class<? extends Throwable> error, T... values)` Assert that the upstream signalled the specified values in order and then failed with a specific class or subclass of Throwable.
`U`	`assertNoErrors()` Assert that this TestObserver/TestSubscriber has not received any onError event.
`U`	`assertNotComplete()` Assert that this TestObserver/TestSubscriber has not received any onComplete event.
`U`	`assertNoValues()` Assert that this TestObserver/TestSubscriber has not received any onNext events.
`U`	`assertResult(T... values)` Assert that the upstream signalled the specified values in order and completed normally.
`protected abstract U`	`assertSubscribed()` Assert that the onSubscribe method was called exactly once.
`U`	`assertValue(Predicate<T> valuePredicate)` Asserts that this TestObserver/TestSubscriber received exactly one onNext value for which the provided predicate returns true.
`U`	`assertValue(T value)` Assert that this TestObserver/TestSubscriber received exactly one onNext value which is equal to the given value with respect to Objects.equals.
`U`	`assertValueAt(int index, Predicate<T> valuePredicate)` Asserts that this TestObserver/TestSubscriber received an onNext value at the given index for the provided predicate returns true.
`U`	`assertValueAt(int index, T value)` Asserts that this TestObserver/TestSubscriber received an onNext value at the given index which is equal to the given value with respect to null-safe Object.equals.
`U`	`assertValueCount(int count)` Assert that this TestObserver/TestSubscriber received the specified number onNext events.
`U`	`assertValues(T... values)` Assert that the TestObserver/TestSubscriber received only the specified values in the specified order.
`U`	`assertValueSequence(Iterable<? extends T> sequence)` Assert that the TestObserver/TestSubscriber received only the specified sequence of values in the same order.
`U`	`assertValuesOnly(T... values)` Assert that the TestObserver/TestSubscriber received only the specified values in the specified order without terminating.
`U`	`await()` Awaits until this TestObserver/TestSubscriber receives an onError or onComplete events.
`boolean`	`await(long time, TimeUnit unit)` Awaits the specified amount of time or until this TestObserver/TestSubscriber receives an onError or onComplete events, whichever happens first.
`U`	`awaitCount(int atLeast)` Await until the TestObserver/TestSubscriber receives the given number of items or terminates by sleeping 10 milliseconds at a time up to 5000 milliseconds of timeout.
`U`	`awaitDone(long time, TimeUnit unit)` Awaits until the internal latch is counted down.
`protected abstract void`	`dispose()` Cancel/dispose this test consumer.
`protected AssertionError`	`fail(String message)` Fail with the given message and add the sequence of errors as suppressed ones.
`protected abstract boolean`	`isDisposed()` Returns true if this test consumer was cancelled/disposed.
`static String`	`valueAndClass(Object o)` Appends the class name to a non-null value.
`List<T>`	`values()` Returns a shared list of received onNext values.
`U`	`withTag(CharSequence tag)` Set the tag displayed along with an assertion failure's other state information.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - done
```
protected final CountDownLatch done
```
    The latch that indicates an onError or onComplete has been called.
  - values
```
protected final List<T> values
```
    The list of values received.
  - errors
```
protected final List<Throwable> errors
```
    The list of errors received.
  - completions
```
protected long completions
```
    The number of completions.
  - lastThread
```
protected Thread lastThread
```
    The last thread seen by the observer.
  - checkSubscriptionOnce
```
protected boolean checkSubscriptionOnce
```
  - tag
```
protected CharSequence tag
```
    The optional tag associated with this test consumer.
    
    Since:
    
    2.0.7
  - timeout
```
protected boolean timeout
```
    Indicates that one of the awaitX method has timed out.
    
    Since:
    
    2.0.7
- Constructor Detail
  - BaseTestConsumer
```
public BaseTestConsumer()
```
- Method Detail
  - values
```
public final List<T> values()
```
    Returns a shared list of received onNext values.
    Note that accessing the items via certain methods of the List interface while the upstream is still actively emitting more items may result in a ConcurrentModificationException.
    The List.size() method will return the number of items already received by this TestObserver/TestSubscriber in a thread-safe manner that can be read via List.get(int)) method (index range of 0 to List.size() - 1).
    A view of the returned List can be created via List.subList(int, int) by using the bounds 0 (inclusive) to List.size() (exclusive) which, when accessed in a read-only fashion, should be also thread-safe and not throw any ConcurrentModificationException.
    
    Returns:
    
    a list of received onNext values
  - fail
```
protected final AssertionError fail(String message)
```
    Fail with the given message and add the sequence of errors as suppressed ones.
    Note this is deliberately the only fail method. Most of the times an assertion would fail but it is possible it was due to an exception somewhere. This construct will capture those potential errors and report it along with the original failure.
    
    Parameters:
    
    message - the message to use
    
    Returns:
    
    AssertionError the prepared AssertionError instance
  - await
```
public final U await()
              throws InterruptedException
```
    Awaits until this TestObserver/TestSubscriber receives an onError or onComplete events.
    
    Returns:
    
    this
    
    Throws:
    
    InterruptedException - if the current thread is interrupted while waiting
  - await
```
public final boolean await(long time,
                           TimeUnit unit)
                    throws InterruptedException
```
    Awaits the specified amount of time or until this TestObserver/TestSubscriber receives an onError or onComplete events, whichever happens first.
    
    Parameters:
    
    time - the waiting time
    
    unit - the time unit of the waiting time
    
    Returns:
    
    true if the TestObserver/TestSubscriber terminated, false if timeout happened
    
    Throws:
    
    InterruptedException - if the current thread is interrupted while waiting
  - assertComplete
```
public final U assertComplete()
```
    Assert that this TestObserver/TestSubscriber received exactly one onComplete event.
    
    Returns:
    
    this
  - assertNotComplete
```
public final U assertNotComplete()
```
    Assert that this TestObserver/TestSubscriber has not received any onComplete event.
    
    Returns:
    
    this
  - assertNoErrors
```
public final U assertNoErrors()
```
    Assert that this TestObserver/TestSubscriber has not received any onError event.
    
    Returns:
    
    this
  - assertError
```
public final U assertError(Throwable error)
```
    Assert that this TestObserver/TestSubscriber received exactly the specified onError event value.
    The comparison is performed via Objects.equals(); since most exceptions don't implement equals(), this assertion may fail. Use the assertError(Class) overload to test against the class of an error instead of an instance of an error or assertError(Predicate) to test with different condition.
    
    Parameters:
    
    error - the error to check
    
    Returns:
    
    this
    
    See Also:
    
    assertError(Class), assertError(Predicate)
  - assertError
```
public final U assertError(Class<? extends Throwable> errorClass)
```
    Asserts that this TestObserver/TestSubscriber received exactly one onError event which is an instance of the specified errorClass class.
    
    Parameters:
    
    errorClass - the error class to expect
    
    Returns:
    
    this
  - assertError
```
public final U assertError(Predicate<Throwable> errorPredicate)
```
    Asserts that this TestObserver/TestSubscriber received exactly one onError event for which the provided predicate returns true.
    
    Parameters:
    
    errorPredicate - the predicate that receives the error Throwable and should return true for expected errors.
    
    Returns:
    
    this
  - assertValue
```
public final U assertValue(T value)
```
    Assert that this TestObserver/TestSubscriber received exactly one onNext value which is equal to the given value with respect to Objects.equals.
    
    Parameters:
    
    value - the value to expect
    
    Returns:
    
    this
  - assertValue
```
public final U assertValue(Predicate<T> valuePredicate)
```
    Asserts that this TestObserver/TestSubscriber received exactly one onNext value for which the provided predicate returns true.
    
    Parameters:
    
    valuePredicate - the predicate that receives the onNext value and should return true for the expected value.
    
    Returns:
    
    this
  - assertValueAt
```
public final U assertValueAt(int index,
                             T value)
```
    Asserts that this TestObserver/TestSubscriber received an onNext value at the given index which is equal to the given value with respect to null-safe Object.equals.
    History: 2.1.3 - experimental
    
    Parameters:
    
    index - the position to assert on
    
    value - the value to expect
    
    Returns:
    
    this
    
    Since:
    
    2.2
  - assertValueAt
```
public final U assertValueAt(int index,
                             Predicate<T> valuePredicate)
```
    Asserts that this TestObserver/TestSubscriber received an onNext value at the given index for the provided predicate returns true.
    
    Parameters:
    
    index - the position to assert on
    
    valuePredicate - the predicate that receives the onNext value and should return true for the expected value.
    
    Returns:
    
    this
  - valueAndClass
```
public static String valueAndClass(Object o)
```
    Appends the class name to a non-null value.
    
    Parameters:
    
    o - the object
    
    Returns:
    
    the string representation
  - assertValueCount
```
public final U assertValueCount(int count)
```
    Assert that this TestObserver/TestSubscriber received the specified number onNext events.
    
    Parameters:
    
    count - the expected number of onNext events
    
    Returns:
    
    this
  - assertNoValues
```
public final U assertNoValues()
```
    Assert that this TestObserver/TestSubscriber has not received any onNext events.
    
    Returns:
    
    this
  - assertValues
```
public final U assertValues(T... values)
```
    Assert that the TestObserver/TestSubscriber received only the specified values in the specified order.
    
    Parameters:
    
    values - the values expected
    
    Returns:
    
    this
  - assertValuesOnly
```
public final U assertValuesOnly(T... values)
```
    Assert that the TestObserver/TestSubscriber received only the specified values in the specified order without terminating.
    History: 2.1.4 - experimental
    
    Parameters:
    
    values - the values expected
    
    Returns:
    
    this
    
    Since:
    
    2.2
  - assertValueSequence
```
public final U assertValueSequence(Iterable<? extends T> sequence)
```
    Assert that the TestObserver/TestSubscriber received only the specified sequence of values in the same order.
    
    Parameters:
    
    sequence - the sequence of expected values in order
    
    Returns:
    
    this
  - assertSubscribed
```
protected abstract U assertSubscribed()
```
    Assert that the onSubscribe method was called exactly once.
    
    Returns:
    
    this
  - assertResult
```
public final U assertResult(T... values)
```
    Assert that the upstream signalled the specified values in order and completed normally.
    
    Parameters:
    
    values - the expected values, asserted in order
    
    Returns:
    
    this
    
    See Also:
    
    assertFailure(Class, Object...)
  - assertFailure
```
public final U assertFailure(Class<? extends Throwable> error,
                             T... values)
```
    Assert that the upstream signalled the specified values in order and then failed with a specific class or subclass of Throwable.
    
    Parameters:
    
    error - the expected exception (parent) class
    
    values - the expected values, asserted in order
    
    Returns:
    
    this
  - awaitDone
```
public final U awaitDone(long time,
                         TimeUnit unit)
```
    Awaits until the internal latch is counted down.
    If the wait times out or gets interrupted, the TestObserver/TestSubscriber is cancelled.
    
    Parameters:
    
    time - the waiting time
    
    unit - the time unit of the waiting time
    
    Returns:
    
    this
    
    Throws:
    
    RuntimeException - wrapping an InterruptedException if the wait is interrupted
  - assertEmpty
```
public final U assertEmpty()
```
    Assert that the TestObserver/TestSubscriber has received a Disposable but no other events.
    
    Returns:
    
    this
  - withTag
```
public final U withTag(CharSequence tag)
```
    Set the tag displayed along with an assertion failure's other state information.
    History: 2.0.7 - experimental
    
    Parameters:
    
    tag - the string to display (null won't print any tag)
    
    Returns:
    
    this
    
    Since:
    
    2.1
  - awaitCount
```
public final U awaitCount(int atLeast)
```
    Await until the TestObserver/TestSubscriber receives the given number of items or terminates by sleeping 10 milliseconds at a time up to 5000 milliseconds of timeout.
    History: 2.0.7 - experimental
    
    Parameters:
    
    atLeast - the number of items expected at least
    
    Returns:
    
    this
    
    Since:
    
    2.1
  - isDisposed
```
protected abstract boolean isDisposed()
```
    Returns true if this test consumer was cancelled/disposed.
    
    Returns:
    
    true if this test consumer was cancelled/disposed.
  - dispose
```
protected abstract void dispose()
```
    Cancel/dispose this test consumer.

Class BaseTestConsumer<T,U extends BaseTestConsumer<T,U>>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

done

values

errors

completions

lastThread

checkSubscriptionOnce

tag

timeout

Constructor Detail

BaseTestConsumer

Method Detail

values

fail

await

await

assertComplete

assertNotComplete

assertNoErrors

assertError

assertError

assertError

assertValue

assertValue

assertValueAt

assertValueAt

valueAndClass

assertValueCount

assertNoValues

assertValues

assertValuesOnly

assertValueSequence

assertSubscribed

assertResult

assertFailure

awaitDone

assertEmpty

withTag

awaitCount

isDisposed

dispose