Top Description Fields Constructors Methods
rx.internal.producers

public final Class SingleProducer<T>

extends AtomicBoolean
implements Producer
Class Inheritance
All Implemented Interfaces
rx.Producer
Type Parameters
<T>
the value type
Imports
java.util.concurrent.atomic.AtomicBoolean, rx.*, rx.exceptions.*
A producer which emits a single value and completes the child on the first positive request.

Field Summary

Modifier and TypeField and Description
pack-priv final Subscriber<? super T>
child

The child subscriber.

private static final long
serialVersionUID

Hides java.util.concurrent.atomic.AtomicBoolean.serialVersionUID.

pack-priv final T
value

Hides java.util.concurrent.atomic.AtomicBoolean.value.

The value to be emitted.

Constructor Summary

AccessConstructor and Description
public
SingleProducer(Subscriber<? super T>
the child subscriber, non-null
child, T
the value to be emitted, may be null
value)

Constructs the producer with the given target child and value to be emitted.

Method Summary

Modifier and TypeMethod and Description
public void
request(long
the maximum number of items you want this Producer to produce, or Long.MAX_VALUE if you want the Producer to produce items at its own pace
n)

Implements rx.Producer.request.

Request a certain maximum number of items from this Producer.
Inherited from java.util.concurrent.atomic.AtomicBoolean:
compareAndExchangecompareAndExchangeAcquirecompareAndExchangeReleasecompareAndSetgetgetAcquiregetAndSetgetOpaquegetPlainlazySetsetsetOpaquesetPlainsetReleasetoStringweakCompareAndSetweakCompareAndSetAcquireweakCompareAndSetPlainweakCompareAndSetReleaseweakCompareAndSetVolatile

Field Detail

childback to summary
pack-priv final Subscriber<? super T> child

The child subscriber.

serialVersionUIDback to summary
private static final long serialVersionUID

Hides java.util.concurrent.atomic.AtomicBoolean.serialVersionUID.

valueback to summary
pack-priv final T value

Hides java.util.concurrent.atomic.AtomicBoolean.value.

The value to be emitted.

Constructor Detail

SingleProducerback to summary
public SingleProducer(Subscriber<? super T> child, T value)

Constructs the producer with the given target child and value to be emitted.

Parameters
child:Subscriber<? super T>

the child subscriber, non-null

value:T

the value to be emitted, may be null

Method Detail

requestback to summary
public void request(long n)

Implements rx.Producer.request.

Doc from rx.Producer.request.

Request a certain maximum number of items from this Producer. This is a way of requesting backpressure. To disable backpressure, pass Long.MAX_VALUE to this method.

Requests are additive but if a sequence of requests totals more than Long.MAX_VALUE then Long.MAX_VALUE requests will be actioned and the extras may be ignored. Arriving at Long.MAX_VALUE by addition of requests cannot be assumed to disable backpressure. For example, the code below may result in Long.MAX_VALUE requests being actioned only. 

request(100);
request(Long.MAX_VALUE-1);
Parameters
n:long

the maximum number of items you want this Producer to produce, or Long.MAX_VALUE if you want the Producer to produce items at its own pace

Annotations
@Override