Enum Class EmptyDisposable
- All Implemented Interfaces:
Disposable
,QueueDisposable<Object>
,QueueFuseable<Object>
,SimpleQueue<Object>
,Serializable
,Comparable<EmptyDisposable>
,Constable
It is also async-fuseable but empty all the time.
Since EmptyDisposable implements QueueDisposable and is empty, don't use it in tests and then signal onNext with it; use Disposables.empty() instead.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum Constants -
Field Summary
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
clear()
Removes all enqueued items from this queue.static void
complete
(CompletableObserver observer) static void
complete
(MaybeObserver<?> observer) static void
void
dispose()
Dispose the resource, the operation should be idempotent.static void
error
(Throwable e, CompletableObserver observer) static void
error
(Throwable e, MaybeObserver<?> observer) static void
static void
error
(Throwable e, SingleObserver<?> observer) boolean
Returns true if this resource has been disposed.boolean
isEmpty()
Returns true if the queue is empty.boolean
Atomically enqueue a single value.boolean
Atomically enqueue two values.poll()
Tries to dequeue a value (non-null) or returns null if the queue is empty.int
requestFusion
(int mode) Request a fusion mode from the upstream.static EmptyDisposable
Returns the enum constant of this class with the specified name.static EmptyDisposable[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
INSTANCE
Since EmptyDisposable implements QueueDisposable and is empty, don't use it in tests and then signal onNext with it; use Disposables.empty() instead. -
NEVER
An empty disposable that returns false for isDisposed.
-
-
Constructor Details
-
EmptyDisposable
private EmptyDisposable()
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException
- if this enum class has no constant with the specified nameNullPointerException
- if the argument is null
-
dispose
public void dispose()Description copied from interface:Disposable
Dispose the resource, the operation should be idempotent.- Specified by:
dispose
in interfaceDisposable
-
isDisposed
public boolean isDisposed()Description copied from interface:Disposable
Returns true if this resource has been disposed.- Specified by:
isDisposed
in interfaceDisposable
- Returns:
- true if this resource has been disposed
-
complete
-
complete
-
error
-
complete
-
error
-
error
-
error
-
offer
Description copied from interface:SimpleQueue
Atomically enqueue a single value.- Specified by:
offer
in interfaceSimpleQueue<Object>
- Parameters:
value
- the value to enqueue, not null- Returns:
- true if successful, false if the value was not enqueued likely due to reaching the queue capacity)
-
offer
Description copied from interface:SimpleQueue
Atomically enqueue two values.- Specified by:
offer
in interfaceSimpleQueue<Object>
- Parameters:
v1
- the first value to enqueue, not nullv2
- the second value to enqueue, not null- Returns:
- true if successful, false if the value was not enqueued likely due to reaching the queue capacity)
-
poll
Description copied from interface:SimpleQueue
Tries to dequeue a value (non-null) or returns null if the queue is empty.If the producer uses
SimpleQueue.offer(Object, Object)
and when polling in pairs, if the first poll() returns a non-null item, the second poll() is guaranteed to return a non-null item as well.- Specified by:
poll
in interfaceSimpleQueue<Object>
- Returns:
- the item or null to indicate an empty queue
-
isEmpty
public boolean isEmpty()Description copied from interface:SimpleQueue
Returns true if the queue is empty.Note however that due to potential fused functions in
SimpleQueue.poll()
it is possible this method returns false but then poll() returns null because the fused function swallowed the available item(s).- Specified by:
isEmpty
in interfaceSimpleQueue<Object>
- Returns:
- true if the queue is empty
-
clear
public void clear()Description copied from interface:SimpleQueue
Removes all enqueued items from this queue.- Specified by:
clear
in interfaceSimpleQueue<Object>
-
requestFusion
public int requestFusion(int mode) Description copied from interface:QueueFuseable
Request a fusion mode from the upstream.This should be called before
onSubscribe
returns.Calling this method multiple times or after
onSubscribe
finished is not allowed and may result in undefined behavior.- Specified by:
requestFusion
in interfaceQueueFuseable<Object>
- Parameters:
mode
- the requested fusion mode, allowed values areQueueFuseable.SYNC
,QueueFuseable.ASYNC
,QueueFuseable.ANY
combined withQueueFuseable.BOUNDARY
(e.g.,requestFusion(SYNC | BOUNDARY)
).- Returns:
- the established fusion mode:
QueueFuseable.NONE
,QueueFuseable.SYNC
,QueueFuseable.ASYNC
.
-