rx.subjects

Class SerializedSubject<T,R>

java.lang.Object

rx.Observable<R>

rx.subjects.Subject<T,R>

rx.subjects.SerializedSubject<T,R>

All Implemented Interfaces:

Observer<T>

public class SerializedSubject<T,R>
extends Subject<T,R>

Wraps a Subject so that it is safe to call its various on methods from different threads.

When you use an ordinary Subject as a Subscriber, you must take care not to call its Observer.onNext(T) method (or its other on methods) from multiple threads, as this could lead to non-serialized calls, which violates the Observable contract and creates an ambiguity in the resulting Subject.

To protect a Subject from this danger, you can convert it into a SerializedSubject with code like the following:

mySafeSubject = new SerializedSubject( myUnsafeSubject );
 

Nested Class Summary

Nested classes/interfaces inherited from class rx.Observable

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

Constructor Summary

Constructors

Constructor and Description
SerializedSubject(Subject<T,R> actual)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Throwable	getThrowable() Deprecated. this method is scheduled to be removed in the next release
T	getValue() Deprecated. this method is scheduled to be removed in the next release
java.lang.Object[]	getValues() Deprecated. this method is scheduled to be removed in the next release
T[]	getValues(T[] a) Deprecated. this method is scheduled to be removed in the next release
boolean	hasCompleted() Deprecated. this method is scheduled to be removed in the next release
boolean	hasObservers() Indicates whether the Subject has Observers subscribed to it.
boolean	hasThrowable() Deprecated. this method is scheduled to be removed in the next release
boolean	hasValue() Deprecated. this method is scheduled to be removed in the next release
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, cast, collect, combineLatest, combineLatest, combineLatest, combineLatest, combineLatest, combineLatest, combineLatest, combineLatest, combineLatest, compose, concat, concat, concat, concat, concat, concat, concat, concat, concat, concatEager, concatEager, concatEager, concatEager, concatEager, concatEager, concatEager, concatEager, concatEager, concatEager, concatEager, concatEager, concatMap, concatMapEager, concatMapEager, concatWith, contains, count, countLong, create, debounce, debounce, debounce, defaultIfEmpty, defer, delay, delay, delay, delay, delaySubscription, delaySubscription, delaySubscription, dematerialize, distinct, distinct, distinctUntilChanged, distinctUntilChanged, doOnCompleted, doOnEach, doOnEach, doOnError, doOnNext, doOnRequest, doOnSubscribe, doOnTerminate, doOnUnsubscribe, elementAt, elementAtOrDefault, empty, error, exists, extend, filter, finallyDo, first, first, firstOrDefault, firstOrDefault, flatMap, flatMap, flatMap, flatMap, flatMap, flatMap, flatMapIterable, flatMapIterable, forEach, forEach, forEach, from, from, from, from, from, fromCallable, 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, mergeWith, nest, never, observeOn, ofType, onBackpressureBlock, onBackpressureBlock, onBackpressureBuffer, onBackpressureBuffer, onBackpressureBuffer, onBackpressureDrop, onBackpressureDrop, onBackpressureLatest, onErrorResumeNext, onErrorResumeNext, onErrorReturn, onExceptionResumeNext, publish, publish, range, range, 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, startWith, startWith, startWith, startWith, startWith, startWith, startWith, startWith, startWith, startWith, startWith, subscribe, subscribe, subscribe, subscribe, subscribe, subscribe, subscribeOn, switchIfEmpty, switchMap, switchOnNext, take, take, take, takeFirst, takeLast, takeLast, takeLast, takeLast, takeLast, takeLastBuffer, takeLastBuffer, takeLastBuffer, takeLastBuffer, takeLastBuffer, takeUntil, takeUntil, takeWhile, throttleFirst, throttleFirst, throttleLast, throttleLast, throttleWithTimeout, throttleWithTimeout, timeInterval, timeInterval, timeout, timeout, timeout, timeout, timeout, timeout, timeout, timeout, timer, timer, timer, timer, timestamp, timestamp, toBlocking, toList, toMap, toMap, toMap, toMultimap, toMultimap, toMultimap, toMultimap, toSingle, toSortedList, toSortedList, toSortedList, toSortedList, unsafeSubscribe, unsubscribeOn, using, using, window, window, window, window, window, window, window, window, window, window, window, window, withLatestFrom, 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

Constructor Detail

SerializedSubject

public SerializedSubject(Subject<T,R> actual)

Method Detail

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).

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

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

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,R>

Returns:

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

hasCompleted

@Experimental
@Deprecated
public boolean hasCompleted()

Deprecated. this method is scheduled to be removed in the next release

Check if the Subject has terminated normally.

The operation is threadsafe.

Overrides:

hasCompleted in class Subject<T,R>

Returns:

true if the subject completed normally via onCompleted

hasThrowable

@Experimental
@Deprecated
public boolean hasThrowable()

Deprecated. this method is scheduled to be removed in the next release

Check if the Subject has terminated with an exception.

The operation is threadsafe.

Overrides:

hasThrowable in class Subject<T,R>

Returns:

true if the subject has received a throwable through onError.

hasValue

@Experimental
@Deprecated
public boolean hasValue()

Deprecated. this method is scheduled to be removed in the next release

Check if the Subject has any value.

Use the Subject.getValue() method to retrieve such a value.

Note that unless Subject.hasCompleted() or Subject.hasThrowable() returns true, the value retrieved by getValue() may get outdated.

The operation is threadsafe.

Overrides:

hasValue in class Subject<T,R>

Returns:

true if and only if the subject has some value but not an error

getThrowable

@Experimental
@Deprecated
public java.lang.Throwable getThrowable()

Deprecated. this method is scheduled to be removed in the next release

Returns the Throwable that terminated the Subject.

The operation is threadsafe.

Overrides:

getThrowable in class Subject<T,R>

Returns:

the Throwable that terminated the Subject or null if the subject hasn't terminated yet or if it terminated normally.

getValue

@Experimental
@Deprecated
public T getValue()

Deprecated. this method is scheduled to be removed in the next release

Returns the current or latest value of the Subject if there is such a value and the subject hasn't terminated with an exception.

The method can return null for various reasons. Use Subject.hasValue(), Subject.hasThrowable() and Subject.hasCompleted() to determine if such null is a valid value, there was an exception or the Subject terminated without receiving any value.

The operation is threadsafe.

Overrides:

getValue in class Subject<T,R>

Returns:

the current value or null if the Subject doesn't have a value, has terminated with an exception or has an actual null as a value.

getValues

@Experimental
@Deprecated
public java.lang.Object[] getValues()

Deprecated. this method is scheduled to be removed in the next release

Returns a snapshot of the currently buffered non-terminal events.

The operation is threadsafe.

Overrides:

getValues in class Subject<T,R>

Returns:

a snapshot of the currently buffered non-terminal events.

getValues

@Experimental
@Deprecated
public T[] getValues(T[] a)

Deprecated. this method is scheduled to be removed in the next release

Returns a snapshot of the currently buffered non-terminal events into the provided a array or creates a new array if it has not enough capacity.

If the subject's values fit in the specified array with room to spare (i.e., the array has more elements than the list), the element in the array immediately following the end of the subject's values is set to null.

The operation is threadsafe.

Overrides:

getValues in class Subject<T,R>

Parameters:

a - the array to fill in

Returns:

the array a if it had enough capacity or a new array containing the available values