TestCompletableSubscriber

java.lang.Object
- io.servicetalk.concurrent.api.TestCompletableSubscriber

All Implemented Interfaces:

Cancellable, CompletableSource.Subscriber
```
public final class TestCompletableSubscriber
extends java.lang.Object
implements CompletableSource.Subscriber, Cancellable
```
A CompletableSource.Subscriber that can be used to verify the signals delivered by a CompletableSource.
The Cancellable received by onSubscribe(Cancellable) is exposed through the Cancellable interface methods.

See Also:

TestCompletableSubscriber.Builder

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class TestCompletableSubscriber.Builder
Allows for creating TestCompletableSubscribers with non-default settings.

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

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

Constructor Summary

Constructors
Constructor and Description

TestCompletableSubscriber()
Create a TestCompletableSubscriber with the defaults.

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`cancel()` Cancels the `Cancellable` received by `onSubscribe(Cancellable)`.
`Cancellable`	`cancellable()` Returns the `Cancellable` received by `onSubscribe(Cancellable)`, or `null` if no `Cancellable` has been received.
`boolean`	`cancellableReceived()` Returns `true` if `onSubscribe(Cancellable)` has been called, `false` otherwise.
`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.
`void`	`onComplete()` Success terminal state.
`void`	`onError(java.lang.Throwable t)` Failed terminal state.
`void`	`onSubscribe(Cancellable s)` Called when the associated `CompletableSource` is subscribed via `CompletableSource.subscribe(Subscriber)`.
`java.lang.Throwable`	`takeError()` Get the last `Throwable` received by `onError(Throwable)`, and clears the internal value.
`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
  - TestCompletableSubscriber
```
public TestCompletableSubscriber()
```
    Create a TestCompletableSubscriber with the defaults.
    
    See Also:
    
    TestCompletableSubscriber.Builder
- Method Detail
  - cancellableReceived
```
public boolean cancellableReceived()
```
    Returns true if onSubscribe(Cancellable) has been called, false otherwise.
    
    Returns:
    
    true if onSubscribe(Cancellable) has been called, false otherwise.
  - cancellable
```
public Cancellable cancellable()
```
    Returns the Cancellable received by onSubscribe(Cancellable), or null if no Cancellable has been received.
    
    Returns:
    
    the Cancellable received by onSubscribe(Cancellable), or null if no Cancellable has been received.
  - 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.
  - cancel
```
public void cancel()
```
    Cancels the Cancellable received by onSubscribe(Cancellable).
    If no Cancellable has been received yet, the cancellation will be buffered, and the Cancellable will be cancelled when it is received.
    
    Specified by:
    
    cancel in interface Cancellable
  - onSubscribe
```
public void onSubscribe(Cancellable s)
```
    Description copied from interface: CompletableSource.Subscriber
    
    Called when the associated CompletableSource is subscribed via CompletableSource.subscribe(Subscriber).
    
    Specified by:
    
    onSubscribe in interface CompletableSource.Subscriber
    
    Parameters:
    
    s - A Cancellable that can be used to cancel the asynchronous computation for this subscriber.
  - onComplete
```
public void onComplete()
```
    Description copied from interface: CompletableSource.Subscriber
    
    Success terminal state.
    No further events will be sent.
    
    Specified by:
    
    onComplete in interface CompletableSource.Subscriber
  - onError
```
public void onError(java.lang.Throwable t)
```
    Description copied from interface: CompletableSource.Subscriber
    
    Failed terminal state.
    No further events will be sent.
    
    Specified by:
    
    onError in interface CompletableSource.Subscriber
    
    Parameters:
    
    t - the throwable signaled

Class TestCompletableSubscriber

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

TestCompletableSubscriber

Method Detail

cancellableReceived

cancellable

terminal

takeTerminal

error

takeError

isCompleted

isErrored

isTerminated

cancel

onSubscribe

onComplete

onError