io.reactivex.common

Class Disposables

java.lang.Object

io.reactivex.common.Disposables

public final class Disposables
extends java.lang.Object

Utility class to help create disposables by wrapping other types.

Since:

2.0

Method Summary

Modifier and Type	Method and Description
static Disposable	disposed() Returns a disposed Disposable instance.
static Disposable	empty() Returns a new, non-disposed Disposable instance.
static Disposable	fromAction(Action run) Construct a Disposable by wrapping a Action that is executed exactly once when the Disposable is disposed.
static Disposable	fromFuture(java.util.concurrent.Future<?> future) Construct a Disposable by wrapping a Future that is cancelled exactly once when the Disposable is disposed.
static Disposable	fromFuture(java.util.concurrent.Future<?> future, boolean allowInterrupt) Construct a Disposable by wrapping a Future that is cancelled exactly once when the Disposable is disposed.
static Disposable	fromRunnable(java.lang.Runnable run) Construct a Disposable by wrapping a Runnable that is executed exactly once when the Disposable is disposed.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

fromRunnable

@NonNull
public static Disposable fromRunnable(@NonNull
                                                java.lang.Runnable run)

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

Parameters:

run - the Runnable to wrap

Returns:

the new Disposable instance

fromAction

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

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

Parameters:

run - the Action to wrap

Returns:

the new Disposable instance

fromFuture

@NonNull
public static Disposable fromFuture(@NonNull
                                              java.util.concurrent.Future<?> future)

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

Parameters:

future - the Future to wrap

Returns:

the new Disposable instance

fromFuture

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

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

Parameters:

future - the Future to wrap

allowInterrupt - if true, the future cancel happens via Future.cancel(true)

Returns:

the new Disposable instance

empty

@NonNull
public static Disposable empty()

Returns a new, non-disposed Disposable instance.

Returns:

a new, non-disposed Disposable instance

disposed

@NonNull
public static Disposable disposed()

Returns a disposed Disposable instance.

Returns:

a disposed Disposable instance