RxJava 3 3.1.8 · io.reactivex.rxjava3.disposables.Disposable

Method Summary

Modifier and Type	Method and Description
public void	dispose() Dispose the resource, the operation should be idempotent.
public static @NonNull Disposable	Returns: a shared, disposed `Disposable` instance disposed() Returns a shared, disposed `Disposable` instance.
public static @NonNull Disposable	Returns: a new, non-disposed `Disposable` instance empty() Returns a new, non-disposed `Disposable` instance.
public static @NonNull Disposable	Returns: the new `Disposable` instance fromAction(@NonNull Action the `Action` to wrap action) Construct a `Disposable` by wrapping a `Action` that is executed exactly once when the `Disposable` is disposed.
public static @NonNull Disposable	Returns: the new `Disposable` instance fromAutoCloseable(@NonNull AutoCloseable the `AutoCloseable` to wrap autoCloseable) Construct a `Disposable` by wrapping an `AutoCloseable` that is closed exactly once when the `Disposable` is disposed.
public static @NonNull Disposable	Returns: the new `Disposable` instance fromFuture(@NonNull Future<?> the `Future` to wrap future) Construct a `Disposable` by wrapping a `Future` that is cancelled exactly once when the `Disposable` is disposed.
public static @NonNull Disposable	Returns: the new `Disposable` instance fromFuture(@NonNull Future<?> the `Future` to wrap future, boolean if true, the future cancel happens via `Future.cancel(true)` allowInterrupt) Construct a `Disposable` by wrapping a `Future` that is cancelled exactly once when the `Disposable` is disposed.
public static @NonNull Disposable	Returns: the new `Disposable` instance fromRunnable(@NonNull Runnable the `Runnable` to wrap run) Construct a `Disposable` by wrapping a `Runnable` that is executed exactly once when the `Disposable` is disposed.
public static @NonNull Disposable	Returns: the new `Disposable` instance fromSubscription(@NonNull Subscription the `Runnable` to wrap subscription) Construct a `Disposable` by wrapping a `Subscription` that is cancelled exactly once when the `Disposable` is disposed.
public boolean	Returns: true if this resource has been disposed isDisposed() Returns true if this resource has been disposed.
public static @NonNull AutoCloseable	Returns: the new `AutoCloseable` instance toAutoCloseable(@NonNull Disposable the `Disposable` instance disposable) Construct an `AutoCloseable` by wrapping a `Disposable` that is disposed when the returned `AutoCloseable` is closed.

Method Detail

dispose	back to summary
public void dispose() Dispose the resource, the operation should be idempotent.

disposed back to summary

disposed	back to summary
public static @NonNull Disposable disposed() Returns a shared, disposed `Disposable` instance. Returns:@NonNull Disposable a shared, disposed `Disposable` instance Annotations @NonNull Since 3.0.0

public static @NonNull Disposable disposed()

Returns a shared, disposed Disposable instance.

Returns:@NonNull Disposable

a shared, disposed Disposable instance

Annotations

@NonNull

Since

3.0.0

empty back to summary

empty	back to summary
public static @NonNull Disposable empty() Returns a new, non-disposed `Disposable` instance. Returns:@NonNull Disposable a new, non-disposed `Disposable` instance Annotations @NonNull Since 3.0.0

public static @NonNull Disposable empty()

Returns a new, non-disposed Disposable instance.

Returns:@NonNull Disposable

a new, non-disposed Disposable instance

Annotations

@NonNull

Since

3.0.0

fromAction back to summary

fromAction	back to summary
public static @NonNull Disposable fromAction(@NonNull Action action) Construct a `Disposable` by wrapping a `Action` that is executed exactly once when the `Disposable` is disposed. Parameters action:@NonNull Action the `Action` to wrap Returns:@NonNull Disposable the new `Disposable` instance Annotations @NonNull Exceptions NullPointerException: if `action` is `null` Since 3.0.0

public static @NonNull Disposable fromAction(@NonNull Action action)

Construct a Disposable by wrapping a Action that is executed exactly once when the Disposable is disposed.

Parameters

action:@NonNull Action: the Action to wrap

Returns:@NonNull Disposable

the new Disposable instance

Annotations

@NonNull

Exceptions

NullPointerException:: if action is null

Since

3.0.0

fromAutoCloseable back to summary

fromAutoCloseable	back to summary
public static @NonNull Disposable fromAutoCloseable(@NonNull AutoCloseable autoCloseable) Construct a `Disposable` by wrapping an `AutoCloseable` that is closed exactly once when the `Disposable` is disposed. Parameters autoCloseable:@NonNull AutoCloseable the `AutoCloseable` to wrap Returns:@NonNull Disposable the new `Disposable` instance Annotations @NonNull Exceptions NullPointerException: if `autoCloseable` is `null` Since 3.0.0

public static @NonNull Disposable fromAutoCloseable(@NonNull AutoCloseable autoCloseable)

Construct a Disposable by wrapping an AutoCloseable that is closed exactly once when the Disposable is disposed.

Parameters

autoCloseable:@NonNull AutoCloseable: the AutoCloseable to wrap

Returns:@NonNull Disposable

the new Disposable instance

Annotations

@NonNull

Exceptions

NullPointerException:: if autoCloseable is null

Since

3.0.0

fromFuture back to summary

fromFuture	back to summary
public static @NonNull Disposable fromFuture(@NonNull Future<?> future) Construct a `Disposable` by wrapping a `Future` that is cancelled exactly once when the `Disposable` is disposed. The `Future` is cancelled with `mayInterruptIfRunning == true`. Parameters future:@NonNull Future<?> the `Future` to wrap Returns:@NonNull Disposable the new `Disposable` instance Annotations @NonNull Exceptions NullPointerException: if `future` is `null` Since 3.0.0 See Also `fromFuture(Future, boolean)`

public static @NonNull Disposable fromFuture(@NonNull Future<?> future)

Construct a Disposable by wrapping a Future that is cancelled exactly once when the Disposable is disposed.

The Future is cancelled with mayInterruptIfRunning == true.

Parameters

future:@NonNull Future<?>: the Future to wrap

Returns:@NonNull Disposable

the new Disposable instance

Annotations

@NonNull

Exceptions

NullPointerException:: if future is null

Since

3.0.0

See Also

fromFuture(Future, boolean)

fromFuture back to summary

fromFuture	back to summary
public static @NonNull Disposable fromFuture(@NonNull Future<?> future, boolean allowInterrupt) Construct a `Disposable` by wrapping a `Future` that is cancelled exactly once when the `Disposable` is disposed. Parameters future:@NonNull Future<?> the `Future` to wrap allowInterrupt:boolean if true, the future cancel happens via `Future.cancel(true)` Returns:@NonNull Disposable the new `Disposable` instance Annotations @NonNull Exceptions NullPointerException: if `future` is `null` Since 3.0.0

public static @NonNull Disposable fromFuture(@NonNull Future<?> future, boolean allowInterrupt)

Construct a Disposable by wrapping a Future that is cancelled exactly once when the Disposable is disposed.

Parameters

future:@NonNull Future<?>: the Future to wrap
allowInterrupt:boolean: if true, the future cancel happens via Future.cancel(true)

Returns:@NonNull Disposable

the new Disposable instance

Annotations

@NonNull

Exceptions

NullPointerException:: if future is null

Since

3.0.0

fromRunnable back to summary

fromRunnable	back to summary
public static @NonNull Disposable fromRunnable(@NonNull Runnable run) Construct a `Disposable` by wrapping a `Runnable` that is executed exactly once when the `Disposable` is disposed. Parameters run:@NonNull Runnable the `Runnable` to wrap Returns:@NonNull Disposable the new `Disposable` instance Annotations @NonNull Exceptions NullPointerException: if `run` is `null` Since 3.0.0

public static @NonNull Disposable fromRunnable(@NonNull Runnable run)

Construct a Disposable by wrapping a Runnable that is executed exactly once when the Disposable is disposed.

Parameters

run:@NonNull Runnable: the Runnable to wrap

Returns:@NonNull Disposable

the new Disposable instance

Annotations

@NonNull

Exceptions

NullPointerException:: if run is null

Since

3.0.0

fromSubscription back to summary

fromSubscription	back to summary
public static @NonNull Disposable fromSubscription(@NonNull Subscription subscription) Construct a `Disposable` by wrapping a `Subscription` that is cancelled exactly once when the `Disposable` is disposed. Parameters subscription:@NonNull Subscription the `Runnable` to wrap Returns:@NonNull Disposable the new `Disposable` instance Annotations @NonNull Exceptions NullPointerException: if `subscription` is `null` Since 3.0.0

public static @NonNull Disposable fromSubscription(@NonNull Subscription subscription)

Construct a Disposable by wrapping a Subscription that is cancelled exactly once when the Disposable is disposed.

Parameters

subscription:@NonNull Subscription: the Runnable to wrap

Returns:@NonNull Disposable

the new Disposable instance

Annotations

@NonNull

Exceptions

NullPointerException:: if subscription is null

Since

3.0.0

isDisposed	back to summary
public boolean isDisposed() Returns true if this resource has been disposed. Returns:boolean true if this resource has been disposed

isDisposed

back to summary

public boolean isDisposed()

Returns true if this resource has been disposed.

Returns:boolean: true if this resource has been disposed

toAutoCloseable back to summary

toAutoCloseable	back to summary
public static @NonNull AutoCloseable toAutoCloseable(@NonNull Disposable disposable) Construct an `AutoCloseable` by wrapping a `Disposable` that is disposed when the returned `AutoCloseable` is closed. Parameters disposable:@NonNull Disposable the `Disposable` instance Returns:@NonNull AutoCloseable the new `AutoCloseable` instance Annotations @NonNull Exceptions NullPointerException: if `disposable` is `null` Since 3.0.0

public static @NonNull AutoCloseable toAutoCloseable(@NonNull Disposable disposable)

Construct an AutoCloseable by wrapping a Disposable that is disposed when the returned AutoCloseable is closed.

Parameters

disposable:@NonNull Disposable: the Disposable instance

Returns:@NonNull AutoCloseable

the new AutoCloseable instance

Annotations

@NonNull

Exceptions

NullPointerException:: if disposable is null

Since

3.0.0

public Interface Disposable

Method Summary

Method Detail