RxJava 3 3.1.8 · io.reactivex.rxjava3.internal.disposables.DisposableHelper

Modifier and Type	Field and Description
public static final DisposableHelper	DISPOSED The singleton instance representing a terminal, disposed state, don't leak it.

Access	Constructor and Description
private	DisposableHelper()

Method Summary

Modifier and Type	Method and Description
public static boolean	Returns: true if the current thread managed to dispose the Disposable dispose(AtomicReference<Disposable> the target field field) Atomically disposes the Disposable in the field if not already disposed.
public void	dispose() Implements io.reactivex.rxjava3.disposables.Disposable.dispose. Dispose the resource, the operation should be idempotent.
public static boolean	Returns: true if d is `DISPOSED` isDisposed(Disposable the disposable to check d) Checks if the given Disposable is the common `DISPOSED` enum value.
public boolean	isDisposed() Implements io.reactivex.rxjava3.disposables.Disposable.isDisposed. Returns true if this resource has been disposed.
public static boolean	Returns: true if the operation succeeded, false if the target field contained the common DISPOSED instance and the given disposable (if not null) is disposed. replace(AtomicReference<Disposable> the target field to change field, Disposable the new disposable, null allowed d) Atomically replaces the Disposable in the field with the given new Disposable but does not dispose the old one.
public static void	reportDisposableSet() Reports that the disposable is already set to the RxJavaPlugins error handler.
public static boolean	Returns: true if successful, false if the field contains the `DISPOSED` instance. set(AtomicReference<Disposable> the target field field, Disposable the new Disposable to set d) Atomically sets the field and disposes the old contents.
public static boolean	Returns: true if the operation succeeded, false setOnce(AtomicReference<Disposable> the target field field, Disposable the disposable to set, not null d) Atomically sets the field to the given non-null Disposable and returns true or returns false if the field is non-null.
public static boolean	Returns: true if successful, false otherwise trySet(AtomicReference<Disposable> the target field field, Disposable the disposable to set d) Atomically tries to set the given Disposable on the field if it is null or disposes it if the field contains `DISPOSED`.
public static boolean	Returns: true if the validation succeeded validate(Disposable the current Disposable, expected to be null current, Disposable the next Disposable, expected to be non-null next) Verifies that current is null, next is not null, otherwise signals errors to the RxJavaPlugins and returns false.
public static DisposableHelper	valueOf(String name)
public static DisposableHelper[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

DISPOSED	back to summary
public static final DisposableHelper DISPOSED The singleton instance representing a terminal, disposed state, don't leak it.

DisposableHelper	back to summary
private DisposableHelper()

Method Detail

dispose	back to summary
public static boolean dispose(AtomicReference<Disposable> field) Atomically disposes the Disposable in the field if not already disposed. Parameters field:AtomicReference<Disposable> the target field Returns:boolean true if the current thread managed to dispose the Disposable

dispose

back to summary

public static boolean dispose(AtomicReference<Disposable> field)

Atomically disposes the Disposable in the field if not already disposed.

Parameters

field:AtomicReference<Disposable>: the target field

Returns:boolean

true if the current thread managed to dispose the Disposable

dispose	back to summary
public void dispose() Implements io.reactivex.rxjava3.disposables.Disposable.dispose. Doc from io.reactivex.rxjava3.disposables.Disposable.dispose. Dispose the resource, the operation should be idempotent. Annotations @Override

dispose

back to summary

public void dispose()

Implements io.reactivex.rxjava3.disposables.Disposable.dispose.

Doc from io.reactivex.rxjava3.disposables.Disposable.dispose.

Dispose the resource, the operation should be idempotent.

Annotations

@Override

isDisposed back to summary

isDisposed	back to summary
public static boolean isDisposed(Disposable d) Checks if the given Disposable is the common `DISPOSED` enum value. Parameters d:Disposable the disposable to check Returns:boolean true if d is `DISPOSED`

public static boolean isDisposed(Disposable d)

Checks if the given Disposable is the common DISPOSED enum value.

Parameters

d:Disposable: the disposable to check

Returns:boolean

true if d is DISPOSED

isDisposed	back to summary
public boolean isDisposed() Implements io.reactivex.rxjava3.disposables.Disposable.isDisposed. Doc from io.reactivex.rxjava3.disposables.Disposable.isDisposed. Returns true if this resource has been disposed. Returns:boolean true if this resource has been disposed Annotations @Override

isDisposed

back to summary

public boolean isDisposed()

Implements io.reactivex.rxjava3.disposables.Disposable.isDisposed.

Doc from io.reactivex.rxjava3.disposables.Disposable.isDisposed.

Returns true if this resource has been disposed.

Returns:boolean

true if this resource has been disposed

Annotations

@Override

replace	back to summary
public static boolean replace(AtomicReference<Disposable> field, Disposable d) Atomically replaces the Disposable in the field with the given new Disposable but does not dispose the old one. Parameters field:AtomicReference<Disposable> the target field to change d:Disposable the new disposable, null allowed Returns:boolean true if the operation succeeded, false if the target field contained the common DISPOSED instance and the given disposable (if not null) is disposed.

replace

back to summary

public static boolean replace(AtomicReference<Disposable> field, Disposable d)

Atomically replaces the Disposable in the field with the given new Disposable but does not dispose the old one.

Parameters

field:AtomicReference<Disposable>: the target field to change
d:Disposable: the new disposable, null allowed

Returns:boolean

true if the operation succeeded, false if the target field contained the common DISPOSED instance and the given disposable (if not null) is disposed.

reportDisposableSet	back to summary
public static void reportDisposableSet() Reports that the disposable is already set to the RxJavaPlugins error handler.

set back to summary

set	back to summary
public static boolean set(AtomicReference<Disposable> field, Disposable d) Atomically sets the field and disposes the old contents. Parameters field:AtomicReference<Disposable> the target field d:Disposable the new Disposable to set Returns:boolean true if successful, false if the field contains the `DISPOSED` instance.

public static boolean set(AtomicReference<Disposable> field, Disposable d)

Atomically sets the field and disposes the old contents.

Parameters

field:AtomicReference<Disposable>: the target field
d:Disposable: the new Disposable to set

Returns:boolean

true if successful, false if the field contains the DISPOSED instance.

setOnce	back to summary
public static boolean setOnce(AtomicReference<Disposable> field, Disposable d) Atomically sets the field to the given non-null Disposable and returns true or returns false if the field is non-null. If the target field contains the common DISPOSED instance, the supplied disposable is disposed. If the field contains other non-null Disposable, an IllegalStateException is signalled to the RxJavaPlugins.onError hook. Parameters field:AtomicReference<Disposable> the target field d:Disposable the disposable to set, not null Returns:boolean true if the operation succeeded, false

setOnce

back to summary

public static boolean setOnce(AtomicReference<Disposable> field, Disposable d)

Atomically sets the field to the given non-null Disposable and returns true or returns false if the field is non-null. If the target field contains the common DISPOSED instance, the supplied disposable is disposed. If the field contains other non-null Disposable, an IllegalStateException is signalled to the RxJavaPlugins.onError hook.

Parameters

field:AtomicReference<Disposable>: the target field
d:Disposable: the disposable to set, not null

Returns:boolean

true if the operation succeeded, false

trySet back to summary

trySet	back to summary
public static boolean trySet(AtomicReference<Disposable> field, Disposable d) Atomically tries to set the given Disposable on the field if it is null or disposes it if the field contains `DISPOSED`. Parameters field:AtomicReference<Disposable> the target field d:Disposable the disposable to set Returns:boolean true if successful, false otherwise

public static boolean trySet(AtomicReference<Disposable> field, Disposable d)

Atomically tries to set the given Disposable on the field if it is null or disposes it if the field contains DISPOSED.

Parameters

field:AtomicReference<Disposable>: the target field
d:Disposable: the disposable to set

Returns:boolean

true if successful, false otherwise

validate	back to summary
public static boolean validate(Disposable current, Disposable next) Verifies that current is null, next is not null, otherwise signals errors to the RxJavaPlugins and returns false. Parameters current:Disposable the current Disposable, expected to be null next:Disposable the next Disposable, expected to be non-null Returns:boolean true if the validation succeeded

validate

back to summary

public static boolean validate(Disposable current, Disposable next)

Verifies that current is null, next is not null, otherwise signals errors to the RxJavaPlugins and returns false.

Parameters

current:Disposable: the current Disposable, expected to be null
next:Disposable: the next Disposable, expected to be non-null

Returns:boolean

true if the validation succeeded

valueOf	back to summary
public static DisposableHelper valueOf(String name)

values	back to summary
public static DisposableHelper[] values()

public final Enum DisposableHelper

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail