rx.subjects

Class UnicastSubject<T>

java.lang.Object

rx.Observable<R>

rx.subjects.Subject<T,T>

rx.subjects.UnicastSubject<T>

Type Parameters:

T - the input and output value type

All Implemented Interfaces:

Observer<T>

public final class UnicastSubject<T>
extends Subject<T,T>

A Subject variant which buffers events until a single Subscriber arrives and replays them to it and potentially switches to direct delivery once the Subscriber caught up and requested an unlimited amount. In this case, the buffered values are no longer retained. If the Subscriber requests a limited amount, queueing is involved and only those values are retained which weren't requested by the Subscriber at that time.

Since:

1.3

Nested Class Summary

Nested classes/interfaces inherited from class rx.Observable

Observable.OnSubscribe<T>, Observable.Operator<R,T>, Observable.Transformer<T,R>

Method Summary

Modifier and Type	Method and Description
static <T> UnicastSubject<T>	create() Constructs an empty UnicastSubject instance with the default capacity hint of 16 elements.
static <T> UnicastSubject<T>	create(boolean delayError) Constructs an empty UnicastSubject instance with the default capacity hint of 16 elements.
static <T> UnicastSubject<T>	create(int capacityHint) Constructs an empty UnicastSubject instance with a capacity hint.
static <T> UnicastSubject<T>	create(int capacityHint, Action0 onTerminated) Constructs an empty UnicastSubject instance with a capacity hint and an Action0 instance to call if the subject reaches its terminal state or the single Subscriber unsubscribes mid-sequence.
static <T> UnicastSubject<T>	create(int capacityHint, Action0 onTerminated, boolean delayError) Constructs an empty UnicastSubject instance with a capacity hint, delay error flag and Action0 instance to call if the subject reaches its terminal state or the single Subscriber unsubscribes mid-sequence.
boolean	hasObservers() Indicates whether the Subject has Observers subscribed to it.
void	onCompleted() Notifies the Observer that the Observable has finished sending push-based notifications.
void	onError(java.lang.Throwable e) Notifies the Observer that the Observable has experienced an error condition.
void	onNext(T t) Provides the Observer with a new item to observe.

Methods inherited from class rx.subjects.Subject

toSerialized

Methods inherited from class rx.Observable

all, amb, amb, amb, amb, amb, amb, amb, amb, amb, ambWith, asObservable, buffer, buffer, buffer, buffer, buffer, buffer, buffer, buffer, buffer, buffer, buffer, buffer, cache, cache, cacheWithInitialCapacity, cast, collect, combineLatest, combineLatest, combineLatest, combineLatest, combineLatest, combineLatest, combineLatest, combineLatest, combineLatest, combineLatest, combineLatestDelayError, compose, concat, concat, concat, concat, concat, concat, concat, concat, concat, concat, concatDelayError, concatDelayError, concatDelayError, concatDelayError, concatDelayError, concatDelayError, concatDelayError, concatDelayError, concatDelayError, concatDelayError, concatEager, concatEager, concatEager, concatEager, concatEager, concatEager, concatEager, concatEager, concatEager, concatEager, concatEager, concatEager, concatMap, concatMapDelayError, concatMapEager, concatMapEager, concatMapEager, concatMapIterable, concatWith, contains, count, countLong, create, create, create, create, debounce, debounce, debounce, defaultIfEmpty, defer, delay, delay, delay, delay, delaySubscription, delaySubscription, delaySubscription, delaySubscription, dematerialize, distinct, distinct, distinctUntilChanged, distinctUntilChanged, distinctUntilChanged, doAfterTerminate, doOnCompleted, doOnEach, doOnEach, doOnError, doOnNext, doOnRequest, doOnSubscribe, doOnTerminate, doOnUnsubscribe, elementAt, elementAtOrDefault, empty, error, exists, filter, finallyDo, first, first, firstOrDefault, firstOrDefault, flatMap, flatMap, flatMap, flatMap, flatMap, flatMap, flatMapCompletable, flatMapCompletable, flatMapCompletable, flatMapIterable, flatMapIterable, flatMapIterable, flatMapIterable, flatMapSingle, flatMapSingle, flatMapSingle, forEach, forEach, forEach, from, from, from, from, from, fromCallable, groupBy, groupBy, groupBy, groupBy, groupJoin, ignoreElements, interval, interval, interval, interval, isEmpty, join, just, just, just, just, just, just, just, just, just, just, last, last, lastOrDefault, lastOrDefault, lift, limit, map, materialize, merge, merge, merge, merge, merge, merge, merge, merge, merge, merge, merge, merge, merge, merge, mergeDelayError, mergeDelayError, mergeDelayError, mergeDelayError, mergeDelayError, mergeDelayError, mergeDelayError, mergeDelayError, mergeDelayError, mergeDelayError, mergeDelayError, mergeDelayError, mergeWith, nest, never, observeOn, observeOn, observeOn, observeOn, ofType, onBackpressureBuffer, onBackpressureBuffer, onBackpressureBuffer, onBackpressureBuffer, onBackpressureDrop, onBackpressureDrop, onBackpressureLatest, onErrorResumeNext, onErrorResumeNext, onErrorReturn, onExceptionResumeNext, onTerminateDetach, publish, publish, range, range, rebatchRequests, reduce, reduce, repeat, repeat, repeat, repeat, repeatWhen, repeatWhen, replay, replay, replay, replay, replay, replay, replay, replay, replay, replay, replay, replay, replay, replay, replay, replay, retry, retry, retry, retryWhen, retryWhen, sample, sample, sample, scan, scan, sequenceEqual, sequenceEqual, serialize, share, single, single, singleOrDefault, singleOrDefault, skip, skip, skip, skipLast, skipLast, skipLast, skipUntil, skipWhile, sorted, sorted, startWith, startWith, startWith, startWith, startWith, startWith, startWith, startWith, startWith, startWith, startWith, subscribe, subscribe, subscribe, subscribe, subscribe, subscribe, subscribeOn, subscribeOn, switchIfEmpty, switchMap, switchMapDelayError, switchOnNext, switchOnNextDelayError, take, take, take, takeFirst, takeLast, takeLast, takeLast, takeLast, takeLast, takeLastBuffer, takeLastBuffer, takeLastBuffer, takeLastBuffer, takeLastBuffer, takeUntil, takeUntil, takeWhile, test, test, throttleFirst, throttleFirst, throttleLast, throttleLast, throttleWithTimeout, throttleWithTimeout, timeInterval, timeInterval, timeout, timeout, timeout, timeout, timeout, timeout, timeout, timeout, timer, timer, timer, timer, timestamp, timestamp, to, toBlocking, toCompletable, toList, toMap, toMap, toMap, toMultimap, toMultimap, toMultimap, toMultimap, toSingle, toSortedList, toSortedList, toSortedList, toSortedList, unsafeCreate, unsafeSubscribe, unsubscribeOn, using, using, window, window, window, window, window, window, window, window, window, window, window, window, withLatestFrom, withLatestFrom, withLatestFrom, withLatestFrom, withLatestFrom, withLatestFrom, withLatestFrom, withLatestFrom, withLatestFrom, withLatestFrom, zip, zip, zip, zip, zip, zip, zip, zip, zip, zip, zip, zipWith, zipWith

Methods inherited from class java.lang.Object

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

Method Detail

create

public static <T> UnicastSubject<T> create()

Constructs an empty UnicastSubject instance with the default capacity hint of 16 elements.

Type Parameters:

T - the input and output value type

Returns:

the created UnicastSubject instance

create

public static <T> UnicastSubject<T> create(int capacityHint)

Constructs an empty UnicastSubject instance with a capacity hint.

The capacity hint determines the internal queue's island size: the larger it is the less frequent allocation will happen if there is no subscriber or the subscriber hasn't caught up.

Type Parameters:

T - the input and output value type

Parameters:

capacityHint - the capacity hint for the internal queue

Returns:

the created BufferUntilSubscriber instance

create

public static <T> UnicastSubject<T> create(boolean delayError)

Constructs an empty UnicastSubject instance with the default capacity hint of 16 elements.

Type Parameters:

T - the input and output value type

Parameters:

delayError - deliver pending next events before error.

Returns:

the created UnicastSubject instance

create

public static <T> UnicastSubject<T> create(int capacityHint,
                                           Action0 onTerminated)

Constructs an empty UnicastSubject instance with a capacity hint and an Action0 instance to call if the subject reaches its terminal state or the single Subscriber unsubscribes mid-sequence.

The capacity hint determines the internal queue's island size: the larger it is the less frequent allocation will happen if there is no subscriber or the subscriber hasn't caught up.

Type Parameters:

T - the input and output value type

Parameters:

capacityHint - the capacity hint for the internal queue

onTerminated - the optional callback to call when subject reaches its terminal state or the single Subscriber unsubscribes mid-sequence. It will be called at most once.

Returns:

the created BufferUntilSubscriber instance

create

public static <T> UnicastSubject<T> create(int capacityHint,
                                           Action0 onTerminated,
                                           boolean delayError)

Constructs an empty UnicastSubject instance with a capacity hint, delay error flag and Action0 instance to call if the subject reaches its terminal state or the single Subscriber unsubscribes mid-sequence.

The capacity hint determines the internal queue's island size: the larger it is the less frequent allocation will happen if there is no subscriber or the subscriber hasn't caught up.

Type Parameters:

T - the input and output value type

Parameters:

capacityHint - the capacity hint for the internal queue

onTerminated - the optional callback to call when subject reaches its terminal state or the single Subscriber unsubscribes mid-sequence. It will be called at most once.

delayError - flag indicating whether to deliver pending next events before error.

Returns:

the created BufferUntilSubscriber instance

onNext

public void onNext(T t)

Description copied from interface: Observer

Provides the Observer with a new item to observe.

The Observable may call this method 0 or more times.

The Observable will not call this method again after it calls either Observer.onCompleted() or Observer.onError(java.lang.Throwable).

Parameters:

t - the item emitted by the Observable

onError

public void onError(java.lang.Throwable e)

Description copied from interface: Observer

Notifies the Observer that the Observable has experienced an error condition.

If the Observable calls this method, it will not thereafter call Observer.onNext(T) or Observer.onCompleted().

Parameters:

e - the exception encountered by the Observable

onCompleted

public void onCompleted()

Description copied from interface: Observer

Notifies the Observer that the Observable has finished sending push-based notifications.

The Observable will not call this method if it calls Observer.onError(java.lang.Throwable).

hasObservers

public boolean hasObservers()

Description copied from class: Subject

Indicates whether the Subject has Observers subscribed to it.

Specified by:

hasObservers in class Subject<T,T>

Returns:

true if there is at least one Observer subscribed to this Subject, false otherwise