RxJava 3 3.1.8 · io.reactivex.rxjava3.operators.SimpleQueue

A simplified interface for offering, polling and clearing a queue.

This interface does not define most of the java.util.Collection or java.util.Queue methods as the intended usage of SimpleQueue does not require support for iteration or introspection.

Method Summary

Modifier and Type	Method and Description
public void	clear() Removes all enqueued items from this queue.
public boolean	Returns: true if the queue is empty isEmpty() Returns true if the queue is empty.
public boolean	Returns: true if successful, false if the value was not enqueued likely due to reaching the queue capacity) offer(T the value to enqueue, not null value) Atomically enqueue a single value.
public boolean	Returns: true if successful, false if the value was not enqueued likely due to reaching the queue capacity) offer(T the first value to enqueue, not null v1, T the second value to enqueue, not null v2) Atomically enqueue two values.
public T	Returns: the item or null to indicate an empty queue poll() Tries to dequeue a value (non-null) or returns null if the queue is empty.

Method Detail

clear	back to summary
public void clear() Removes all enqueued items from this queue.

isEmpty back to summary

isEmpty	back to summary
public boolean isEmpty() Returns true if the queue is empty. Note however that due to potential fused functions in `poll()` it is possible this method returns false but then poll() returns null because the fused function swallowed the available item(s). Returns:boolean true if the queue is empty

public boolean isEmpty()

Returns true if the queue is empty.

Note however that due to potential fused functions in poll() it is possible this method returns false but then poll() returns null because the fused function swallowed the available item(s).

Returns:boolean: true if the queue is empty

offer	back to summary
public boolean offer(T value) Atomically enqueue a single value. Parameters value:T the value to enqueue, not null Returns:boolean true if successful, false if the value was not enqueued likely due to reaching the queue capacity)

offer

back to summary

public boolean offer(T value)

Atomically enqueue a single value.

Parameters

value:T: the value to enqueue, not null

Returns:boolean

true if successful, false if the value was not enqueued likely due to reaching the queue capacity)

offer	back to summary
public boolean offer(T v1, T v2) Atomically enqueue two values. Parameters v1:T the first value to enqueue, not null v2:T the second value to enqueue, not null Returns:boolean true if successful, false if the value was not enqueued likely due to reaching the queue capacity)

offer

back to summary

public boolean offer(T v1, T v2)

Atomically enqueue two values.

Parameters

v1:T: the first value to enqueue, not null
v2:T: the second value to enqueue, not null

Returns:boolean

true if successful, false if the value was not enqueued likely due to reaching the queue capacity)

poll back to summary

poll	back to summary
public T poll() throws Throwable Tries to dequeue a value (non-null) or returns null if the queue is empty. If the producer uses `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. Returns:T the item or null to indicate an empty queue Annotations @Nullable Exceptions Throwable: if some pre-processing of the dequeued item (usually through fused functions) throws.

public T poll() throws Throwable

Tries to dequeue a value (non-null) or returns null if the queue is empty.

If the producer uses 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.

Returns:T

the item or null to indicate an empty queue

Annotations

@Nullable

Exceptions

Throwable:: if some pre-processing of the dequeued item (usually through fused functions) throws.

public Interface SimpleQueue<T>

Method Summary

Method Detail