Interface DisposableStreamerCancellation

All Superinterfaces:

Disposable, StreamerCancellation

All Known Implementing Classes:

CompositeDisposable

public interface DisposableStreamerCancellation
extends StreamerCancellation, Disposable

Represents the full, disposable cancellation interface for Streamer operations.

It was decided to have a separate set of interfaces instead of trying to retrofit DisposableContainer.

Since:

4.0.0

Method Summary

Static Methods

Modifier and Type	Method	Description
static DisposableStreamerCancellation	never()	Returns a constant instance which does nothing, cannot be disposed and accepts any incoming Disposable without registering it or handling it in any form, because this never instance cannot be disposed to begin with.

Methods inherited from interface Disposable

asAutoCloseable, dispose, isDisposed

Modifier and Type	Method	Description
default @NonNull AutoCloseable	asAutoCloseable()	Wraps this Disposable into an AutoCloseable instance that can be used with try-with-resources constructs.
void	dispose()	Dispose the resource, the operation should be idempotent.
boolean	isDisposed()	Returns true if this resource has been disposed.

Methods inherited from interface StreamerCancellation

add, delete, derive, isDisposed, remove

Modifier and Type	Method	Description
boolean	add(@NonNull Disposable d)	Adds a disposable to this container or disposes it if the container has been disposed.
boolean	delete(@NonNull Disposable d)	Removes but does not dispose the given disposable if it is part of this container.
@NonNull DisposableStreamerCancellation	derive()	Create a derived sub-cancellation management interface that can get disposed by this cancellation management object but disposing the sub-cancellation manager does not dispose this current StreamerCancellation instance..
boolean	isDisposed()	Returns true if this resource has been disposed.
boolean	remove(@NonNull Disposable d)	Removes and disposes the given disposable if it is part of this container.

Method Details

never

static DisposableStreamerCancellation never()

Returns a constant instance which does nothing, cannot be disposed and accepts any incoming Disposable without registering it or handling it in any form, because this never instance cannot be disposed to begin with.

Returns:

the shared constant no-op instance