TestPublisherSubscriber

java.lang.Object
- io.servicetalk.concurrent.api.TestPublisherSubscriber<T>

Type Parameters:

T - Type of items received by this Subscriber.

All Implemented Interfaces:

Cancellable, PublisherSource.Subscriber<T>, PublisherSource.Subscription
```
public final class TestPublisherSubscriber<T>
extends java.lang.Object
implements PublisherSource.Subscriber<T>, PublisherSource.Subscription
```
A PublisherSource.Subscriber that can be used to verify the signals delivered by a PublisherSource. By default, it asserts that items are not delivered without sufficient demand. (This can be disabled with TestPublisherSubscriber.Builder.disableDemandCheck().)
The PublisherSource.Subscription received by #onSubscribe(Subscription) is exposed through the PublisherSource.Subscription interface methods.

See Also:

TestPublisherSubscriber.Builder

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class TestPublisherSubscriber.Builder<T>
Allows for creating TestPublisherSubscribers with non-default settings.

Nested Classes
Modifier and Type	Class and Description
`static class`	`TestPublisherSubscriber.Builder<T>` Allows for creating `TestPublisherSubscriber`s with non-default settings.

Field Summary
- Fields inherited from interface io.servicetalk.concurrent.Cancellable
  IGNORE_CANCEL

Constructor Summary

Constructors
Constructor and Description

TestPublisherSubscriber()
Create a TestPublisherSubscriber with the defaults.

Constructors
Constructor and Description
`TestPublisherSubscriber()` Create a `TestPublisherSubscriber` with the defaults.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`cancel()` Cancels the `PublisherSource.Subscription` received by `#onSubscribe(Subscription)`.
`java.lang.Throwable`	`error()` Get the last `Throwable` received by `onError(Throwable)`.
`boolean`	`isCompleted()` Returns `true` if `onComplete()` was the most recently received terminal signal, `false` otherwise.
`boolean`	`isErrored()` Returns `true` if `onError(Throwable)` was the most recently received terminal signal, `false` otherwise.
`boolean`	`isTerminated()` Returns `true` if either `onComplete()` or `onError(Throwable)` have been received, `false` otherwise.
`java.util.List<T>`	`items()` Get the list of items received through `onNext(Object)`.
`void`	`onComplete()` Callback to signal completion of the `PublisherSource` for this `Subscriber`.
`void`	`onError(java.lang.Throwable t)` Callback to receive an `error` for this `Subscriber`.
`void`	`onNext(T item)` Callback to receive a `data` element for this `Subscriber`.
`void`	`onSubscribe(PublisherSource.Subscription s)` Callback to receive a `PublisherSource.Subscription` for this `Subscriber`.
`void`	`request(long n)` Requests `n` items via the `PublisherSource.Subscription` received by `#onSubscribe(Subscription)`.
`PublisherSource.Subscription`	`subscription()` Returns the `PublisherSource.Subscription` received by `#onSubscribe(Subscription)`, or `null` if no `PublisherSource.Subscription` has been received.
`boolean`	`subscriptionReceived()` Returns `true` if `#onSubscribe(Subscription)` has been called, `false` otherwise.
`java.lang.Throwable`	`takeError()` Get the last `Throwable` received by `onError(Throwable)`, and clears the internal value.
`java.util.List<T>`	`takeItems()` Get the list of items received through `onNext(Object)`, and clear the internal list.
`TerminalNotification`	`takeTerminal()` Get the last `TerminalNotification` `onError(Throwable)` or `onComplete()` received, and clears the internal value.
`TerminalNotification`	`terminal()` Get the last `TerminalNotification` `onError(Throwable)` or `onComplete()` received.

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

- Constructor Detail
  - TestPublisherSubscriber
```
public TestPublisherSubscriber()
```
    Create a TestPublisherSubscriber with the defaults.
    
    See Also:
    
    TestPublisherSubscriber.Builder
- Method Detail
  - subscriptionReceived
```
public boolean subscriptionReceived()
```
    Returns true if #onSubscribe(Subscription) has been called, false otherwise.
    
    Returns:
    
    true if #onSubscribe(Subscription) has been called, false otherwise.
  - subscription
```
public PublisherSource.Subscription subscription()
```
    Returns the PublisherSource.Subscription received by #onSubscribe(Subscription), or null if no PublisherSource.Subscription has been received.
    
    Returns:
    
    the PublisherSource.Subscription received by #onSubscribe(Subscription), or null if no PublisherSource.Subscription has been received.
  - items
```
public java.util.List<T> items()
```
    Get the list of items received through onNext(Object).
    
    Returns:
    
    the list of items.
  - takeItems
```
public java.util.List<T> takeItems()
```
    Get the list of items received through onNext(Object), and clear the internal list.
    
    Returns:
    
    the list of items.
  - terminal
```
@Nullable
public TerminalNotification terminal()
```
    Get the last TerminalNotification onError(Throwable) or onComplete() received.
    
    Returns:
    
    the TerminalNotification, or null if none have been received.
  - takeTerminal
```
@Nullable
public TerminalNotification takeTerminal()
```
    Get the last TerminalNotification onError(Throwable) or onComplete() received, and clears the internal value.
    
    Returns:
    
    the TerminalNotification, or null if none have been received.
  - error
```
@Nullable
public java.lang.Throwable error()
```
    Get the last Throwable received by onError(Throwable).
    
    Returns:
    
    The Throwable, or null if none have been received.
  - takeError
```
@Nullable
public java.lang.Throwable takeError()
```
    Get the last Throwable received by onError(Throwable), and clears the internal value.
    
    Returns:
    
    The Throwable, or null if none have been received.
  - isCompleted
```
public boolean isCompleted()
```
    Returns true if onComplete() was the most recently received terminal signal, false otherwise.
    
    Returns:
    
    true if onComplete() was the most recently received terminal signal, false otherwise.
  - isErrored
```
public boolean isErrored()
```
    Returns true if onError(Throwable) was the most recently received terminal signal, false otherwise.
    
    Returns:
    
    true if onError(Throwable) was the most recently received terminal signal, false otherwise.
  - isTerminated
```
public boolean isTerminated()
```
    Returns true if either onComplete() or onError(Throwable) have been received, false otherwise.
    
    Returns:
    
    true if either onComplete() or onError(Throwable) have been received, false otherwise.
  - request
```
public void request(long n)
```
    Requests n items via the PublisherSource.Subscription received by #onSubscribe(Subscription).
    If no PublisherSource.Subscription has been received yet, requests will be buffered and sent once one is received.
    
    Specified by:
    
    request in interface PublisherSource.Subscription
    
    Parameters:
    
    n - Number of items to request.
  - cancel
```
public void cancel()
```
    Cancels the PublisherSource.Subscription received by #onSubscribe(Subscription).
    If no PublisherSource.Subscription has been received yet, the cancellation will be buffered, and the PublisherSource.Subscription will be cancelled when it is received.
    
    Specified by:
    
    cancel in interface Cancellable
  - onSubscribe
```
public void onSubscribe(PublisherSource.Subscription s)
```
    Description copied from interface: PublisherSource.Subscriber
    
    Callback to receive a PublisherSource.Subscription for this Subscriber.
    See Reactive Streams specifications for the rules about how and when this method will be invoked.
    
    Specified by:
    
    onSubscribe in interface PublisherSource.Subscriber<T>
    
    Parameters:
    
    s - PublisherSource.Subscription for this Subscriber.
  - onNext
```
public void onNext(T item)
```
    Description copied from interface: PublisherSource.Subscriber
    
    Callback to receive a data element for this Subscriber.
    See Reactive Streams specifications for the rules about how and when this method will be invoked.
    
    Specified by:
    
    onNext in interface PublisherSource.Subscriber<T>
    
    Parameters:
    
    item - A data element.
  - onError
```
public void onError(java.lang.Throwable t)
```
    Description copied from interface: PublisherSource.Subscriber
    
    Callback to receive an error for this Subscriber.
    See Reactive Streams specifications for the rules about how and when this method will be invoked.
    
    Specified by:
    
    onError in interface PublisherSource.Subscriber<T>
    
    Parameters:
    
    t - error for this Subscriber.
  - onComplete
```
public void onComplete()
```
    Description copied from interface: PublisherSource.Subscriber
    
    Callback to signal completion of the PublisherSource for this Subscriber.
    See Reactive Streams specifications for the rules about how and when this method will be invoked.
    
    Specified by:
    
    onComplete in interface PublisherSource.Subscriber<T>

Class TestPublisherSubscriber<T>

Nested Class Summary

Field Summary

Fields inherited from interface io.servicetalk.concurrent.Cancellable

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TestPublisherSubscriber

Method Detail

subscriptionReceived

subscription

items

takeItems

terminal

takeTerminal

error

takeError

isCompleted

isErrored

isTerminated

request

cancel

onSubscribe

onNext

onError

onComplete