TestSubscriber (RxJava Javadoc 3.0.0-RC4)

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

Type Parameters:

T - the value type

All Implemented Interfaces:

FlowableSubscriber<T>, Subscriber<T>, Subscription
```
public class TestSubscriber<T>
extends BaseTestConsumer<T,TestSubscriber<T>>
implements FlowableSubscriber<T>, Subscription
```
A subscriber that records events and allows making assertions about them.
You can override the onSubscribe, onNext, onError, onComplete, request and cancel methods but not the others (this is by design).
The TestSubscriber implements Disposable for convenience where dispose calls cancel.
When calling the default request method, you are requesting on behalf of the wrapped actual subscriber.

Field Summary
- Fields inherited from class io.reactivex.rxjava3.observers.BaseTestConsumer
  checkSubscriptionOnce, completions, done, errors, lastThread, tag, timeout, values

Constructor Summary

Constructors
Constructor and Description
`TestSubscriber()` Constructs a non-forwarding TestSubscriber with an initial request value of Long.MAX_VALUE.
`TestSubscriber(long initialRequest)` Constructs a non-forwarding TestSubscriber with the specified initial request value.
`TestSubscriber(Subscriber<? super T> downstream)` Constructs a forwarding TestSubscriber but leaves the requesting to the wrapped subscriber.
`TestSubscriber(Subscriber<? super T> actual, long initialRequest)` Constructs a forwarding TestSubscriber with the specified initial request value.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected TestSubscriber<T>`	`assertSubscribed()` Assert that the onSubscribe method was called exactly once.
`void`	`cancel()`
`static <T> TestSubscriber<T>`	`create()` Creates a TestSubscriber with Long.MAX_VALUE initial request.
`static <T> TestSubscriber<T>`	`create(long initialRequested)` Creates a TestSubscriber with the given initial request.
`static <T> TestSubscriber<T>`	`create(Subscriber<? super T> delegate)` Constructs a forwarding TestSubscriber.
`protected void`	`dispose()` Cancel/dispose this test consumer.
`boolean`	`hasSubscription()` Returns true if this TestSubscriber received a subscription.
`boolean`	`isCancelled()` Returns true if this TestSubscriber has been cancelled.
`protected boolean`	`isDisposed()` Returns true if this test consumer was cancelled/disposed.
`void`	`onComplete()`
`void`	`onError(Throwable t)`
`void`	`onNext(T t)`
`protected void`	`onStart()` Called after the onSubscribe is called and handled.
`void`	`onSubscribe(Subscription s)` Implementors of this method should make sure everything that needs to be visible in `Subscriber.onNext(Object)` is established before calling `Subscription.request(long)`.
`void`	`request(long n)`
`TestSubscriber<T>`	`requestMore(long n)` Calls `request(long)` and returns this.

Methods inherited from class io.reactivex.rxjava3.observers.BaseTestConsumer
assertComplete, assertEmpty, assertError, assertError, assertError, assertFailure, assertNoErrors, assertNotComplete, assertNoValues, assertResult, assertValue, assertValue, assertValueAt, assertValueAt, assertValueCount, assertValues, assertValueSequence, assertValuesOnly, await, await, awaitCount, awaitDone, fail, valueAndClass, values, withTag

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

- Constructor Detail
  - TestSubscriber
```
public TestSubscriber()
```
    Constructs a non-forwarding TestSubscriber with an initial request value of Long.MAX_VALUE.
  - TestSubscriber
```
public TestSubscriber(long initialRequest)
```
    Constructs a non-forwarding TestSubscriber with the specified initial request value.
    The TestSubscriber doesn't validate the initialRequest value so one can test sources with invalid values as well.
    
    Parameters:
    
    initialRequest - the initial request value
  - TestSubscriber
```
public TestSubscriber(Subscriber<? super T> downstream)
```
    Constructs a forwarding TestSubscriber but leaves the requesting to the wrapped subscriber.
    
    Parameters:
    
    downstream - the actual Subscriber to forward events to
  - TestSubscriber
```
public TestSubscriber(Subscriber<? super T> actual,
                      long initialRequest)
```
    Constructs a forwarding TestSubscriber with the specified initial request value.
    The TestSubscriber doesn't validate the initialRequest value so one can test sources with invalid values as well.
    
    Parameters:
    
    actual - the actual Subscriber to forward events to
    
    initialRequest - the initial request value
- Method Detail
  - create
```
public static <T> TestSubscriber<T> create()
```
    Creates a TestSubscriber with Long.MAX_VALUE initial request.
    
    Type Parameters:
    
    T - the value type
    
    Returns:
    
    the new TestSubscriber instance.
  - create
```
public static <T> TestSubscriber<T> create(long initialRequested)
```
    Creates a TestSubscriber with the given initial request.
    
    Type Parameters:
    
    T - the value type
    
    Parameters:
    
    initialRequested - the initial requested amount
    
    Returns:
    
    the new TestSubscriber instance.
  - create
```
public static <T> TestSubscriber<T> create(Subscriber<? super T> delegate)
```
    Constructs a forwarding TestSubscriber.
    
    Type Parameters:
    
    T - the value type received
    
    Parameters:
    
    delegate - the actual Subscriber to forward events to
    
    Returns:
    
    the new TestObserver instance
  - onSubscribe
```
public void onSubscribe(Subscription s)
```
    Description copied from interface: FlowableSubscriber
    
    Implementors of this method should make sure everything that needs to be visible in Subscriber.onNext(Object) is established before calling Subscription.request(long). In practice this means no initialization should happen after the request() call and additional behavior is thread safe in respect to onNext.
    
    Specified by:
    
    onSubscribe in interface FlowableSubscriber<T>
    
    Specified by:
    
    onSubscribe in interface Subscriber<T>
  - onStart
```
protected void onStart()
```
    Called after the onSubscribe is called and handled.
  - onNext
```
public void onNext(T t)
```
    Specified by:
    
    onNext in interface Subscriber<T>
  - onError
```
public void onError(Throwable t)
```
    Specified by:
    
    onError in interface Subscriber<T>
  - onComplete
```
public void onComplete()
```
    Specified by:
    
    onComplete in interface Subscriber<T>
  - request
```
public final void request(long n)
```
    Specified by:
    
    request in interface Subscription
  - cancel
```
public final void cancel()
```
    Specified by:
    
    cancel in interface Subscription
  - isCancelled
```
public final boolean isCancelled()
```
    Returns true if this TestSubscriber has been cancelled.
    
    Returns:
    
    true if this TestSubscriber has been cancelled
  - dispose
```
protected final void dispose()
```
    Description copied from class: BaseTestConsumer
    
    Cancel/dispose this test consumer.
    
    Specified by:
    
    dispose in class BaseTestConsumer<T,TestSubscriber<T>>
  - isDisposed
```
protected final boolean isDisposed()
```
    Description copied from class: BaseTestConsumer
    
    Returns true if this test consumer was cancelled/disposed.
    
    Specified by:
    
    isDisposed in class BaseTestConsumer<T,TestSubscriber<T>>
    
    Returns:
    
    true if this test consumer was cancelled/disposed.
  - hasSubscription
```
public final boolean hasSubscription()
```
    Returns true if this TestSubscriber received a subscription.
    
    Returns:
    
    true if this TestSubscriber received a subscription
  - assertSubscribed
```
protected final TestSubscriber<T> assertSubscribed()
```
    Assert that the onSubscribe method was called exactly once.
    
    Specified by:
    
    assertSubscribed in class BaseTestConsumer<T,TestSubscriber<T>>
    
    Returns:
    
    this
  - requestMore
```
public final TestSubscriber<T> requestMore(long n)
```
    Calls request(long) and returns this.
    History: 2.0.1 - experimental
    
    Parameters:
    
    n - the request amount
    
    Returns:
    
    this
    
    Since:
    
    2.1

Class TestSubscriber<T>

Field Summary

Fields inherited from class io.reactivex.rxjava3.observers.BaseTestConsumer

Constructor Summary

Method Summary

Methods inherited from class io.reactivex.rxjava3.observers.BaseTestConsumer

Methods inherited from class java.lang.Object

Constructor Detail

TestSubscriber

TestSubscriber

TestSubscriber

TestSubscriber

Method Detail

create

create

create

onSubscribe

onStart

onNext

onError

onComplete

request

cancel

isCancelled

dispose

isDisposed

hasSubscription

assertSubscribed

requestMore