io.reactivex.processors

Class BehaviorProcessor<T>

java.lang.Object

io.reactivex.Flowable<T>

io.reactivex.processors.FlowableProcessor<T>

io.reactivex.processors.BehaviorProcessor<T>

Type Parameters:

T - the type of item expected to be observed and emitted by the Processor

All Implemented Interfaces:

org.reactivestreams.Processor<T,T>, org.reactivestreams.Publisher<T>, org.reactivestreams.Subscriber<T>

public final class BehaviorProcessor<T>
extends FlowableProcessor<T>

Processor that emits the most recent item it has observed and all subsequent observed items to each subscribed Subscriber.

Example usage:

 // observer will receive all events.
  BehaviorProcessor<Object> processor = BehaviorProcessor.create("default");
  processor.subscribe(observer);
  processor.onNext("one");
  processor.onNext("two");
  processor.onNext("three");

  // observer will receive the "one", "two" and "three" events, but not "zero"
  BehaviorProcessor<Object> processor = BehaviorProcessor.create("default");
  processor.onNext("zero");
  processor.onNext("one");
  processor.subscribe(observer);
  processor.onNext("two");
  processor.onNext("three");

  // observer will receive only onComplete
  BehaviorProcessor<Object> processor = BehaviorProcessor.create("default");
  processor.onNext("zero");
  processor.onNext("one");
  processor.onComplete();
  processor.subscribe(observer);

  // observer will receive only onError
  BehaviorProcessor<Object> processor = BehaviorProcessor.create("default");
  processor.onNext("zero");
  processor.onNext("one");
  processor.onError(new RuntimeException("error"));
  processor.subscribe(observer);
   

Method Summary

Methods

Modifier and Type	Method and Description
static <T> BehaviorProcessor<T>	create() Creates a BehaviorProcessor without a default item.
static <T> BehaviorProcessor<T>	createDefault(T defaultValue) Creates a BehaviorProcessor that emits the last item it observed and all subsequent items to each Subscriber that subscribes to it.
java.lang.Throwable	getThrowable() Returns the error that caused the Subject to terminate or null if the Subject hasn't terminated yet.
T	getValue() Returns a single value the Subject currently has or null if no such value exists.
java.lang.Object[]	getValues() Returns an Object array containing snapshot all values of the Subject.
T[]	getValues(T[] array) Returns a typed array containing a snapshot of all values of the Subject.
boolean	hasComplete() Returns true if the subject has reached a terminal state through a complete event.
boolean	hasSubscribers() Returns true if the subject has subscribers.
boolean	hasThrowable() Returns true if the subject has reached a terminal state through an error event.
boolean	hasValue() Returns true if the subject has any value.
void	onComplete()
void	onError(java.lang.Throwable t)
void	onNext(T t)
void	onSubscribe(org.reactivestreams.Subscription s)
protected void	subscribeActual(org.reactivestreams.Subscriber<? super T> s) Operator implementations (both source and intermediate) should implement this method that performs the necessary business logic.

Methods inherited from class io.reactivex.processors.FlowableProcessor

toSerialized

Methods inherited from class io.reactivex.Flowable

all, amb, ambArray, ambWith, any, blockingFirst, blockingFirst, blockingForEach, blockingIterable, blockingIterable, blockingLast, blockingLast, blockingLatest, blockingMostRecent, blockingNext, blockingSingle, blockingSingle, blockingSubscribe, blockingSubscribe, blockingSubscribe, blockingSubscribe, blockingSubscribe, buffer, buffer, buffer, buffer, buffer, buffer, buffer, buffer, buffer, buffer, buffer, buffer, buffer, buffer, buffer, buffer, buffer, buffer, buffer, bufferSize, cache, cacheWithInitialCapacity, cast, collect, collectInto, combineLatest, combineLatest, combineLatest, combineLatest, combineLatest, combineLatest, combineLatest, combineLatest, combineLatest, combineLatest, combineLatest, combineLatest, combineLatest, combineLatestDelayError, combineLatestDelayError, combineLatestDelayError, combineLatestDelayError, combineLatestDelayError, combineLatestDelayError, compose, concat, concat, concat, concat, concat, concat, concatArray, concatArrayDelayError, concatArrayEager, concatArrayEager, concatDelayError, concatDelayError, concatDelayError, concatEager, concatEager, concatEager, concatEager, concatMap, concatMap, concatMapDelayError, concatMapDelayError, concatMapEager, concatMapEager, concatMapEagerDelayError, concatMapEagerDelayError, concatMapIterable, concatMapIterable, concatWith, contains, count, create, debounce, debounce, debounce, defaultIfEmpty, defer, delay, delay, delay, delay, delay, delay, delaySubscription, delaySubscription, delaySubscription, dematerialize, distinct, distinct, distinct, distinctUntilChanged, distinctUntilChanged, distinctUntilChanged, doAfterNext, doAfterTerminate, doFinally, doOnCancel, doOnComplete, doOnEach, doOnEach, doOnError, doOnLifecycle, doOnNext, doOnRequest, doOnSubscribe, doOnTerminate, elementAt, elementAt, elementAtOrError, empty, error, error, filter, first, firstElement, firstOrError, flatMap, flatMap, flatMap, flatMap, flatMap, flatMap, flatMap, flatMap, flatMap, flatMap, flatMap, flatMap, flatMapCompletable, flatMapCompletable, flatMapIterable, flatMapIterable, flatMapIterable, flatMapIterable, flatMapMaybe, flatMapMaybe, flatMapSingle, flatMapSingle, forEach, forEachWhile, forEachWhile, forEachWhile, fromArray, fromCallable, fromFuture, fromFuture, fromFuture, fromFuture, fromIterable, fromPublisher, generate, generate, generate, generate, generate, groupBy, groupBy, groupBy, groupBy, groupBy, groupJoin, hide, ignoreElements, interval, interval, interval, interval, intervalRange, intervalRange, isEmpty, join, just, just, just, just, just, just, just, just, just, just, last, lastElement, lastOrError, lift, map, materialize, merge, merge, merge, merge, merge, merge, merge, merge, mergeArray, mergeArray, mergeArrayDelayError, mergeArrayDelayError, mergeDelayError, mergeDelayError, mergeDelayError, mergeDelayError, mergeDelayError, mergeDelayError, mergeDelayError, mergeDelayError, mergeWith, never, observeOn, observeOn, observeOn, ofType, onBackpressureBuffer, onBackpressureBuffer, onBackpressureBuffer, onBackpressureBuffer, onBackpressureBuffer, onBackpressureBuffer, onBackpressureBuffer, onBackpressureBuffer, onBackpressureDrop, onBackpressureDrop, onBackpressureLatest, onErrorResumeNext, onErrorResumeNext, onErrorReturn, onErrorReturnItem, onExceptionResumeNext, onTerminateDetach, parallel, parallel, parallel, publish, publish, publish, publish, range, rangeLong, rebatchRequests, reduce, reduce, reduceWith, repeat, repeat, repeatUntil, repeatWhen, replay, replay, replay, replay, replay, replay, replay, replay, replay, replay, replay, replay, replay, replay, replay, replay, retry, retry, retry, retry, retry, retryUntil, retryWhen, safeSubscribe, sample, sample, sample, sample, sample, sample, scan, scan, scanWith, sequenceEqual, sequenceEqual, sequenceEqual, sequenceEqual, serialize, share, single, singleElement, singleOrError, skip, skip, skip, skipLast, skipLast, skipLast, skipLast, skipLast, skipLast, skipUntil, skipWhile, sorted, sorted, startWith, startWith, startWith, startWithArray, strict, subscribe, subscribe, subscribe, subscribe, subscribe, subscribe, subscribeOn, subscribeWith, switchIfEmpty, switchMap, switchMap, switchMapDelayError, switchMapDelayError, switchOnNext, switchOnNext, switchOnNextDelayError, switchOnNextDelayError, take, take, take, takeLast, takeLast, takeLast, takeLast, takeLast, takeLast, takeLast, takeLast, takeLast, takeUntil, takeUntil, takeWhile, test, test, test, throttleFirst, throttleFirst, throttleLast, throttleLast, throttleWithTimeout, throttleWithTimeout, timeInterval, timeInterval, timeInterval, timeInterval, timeout, timeout, timeout, timeout, timeout, timeout, timeout, timeout, timer, timer, timestamp, timestamp, timestamp, timestamp, to, toFuture, toList, toList, toList, toMap, toMap, toMap, toMultimap, toMultimap, toMultimap, toMultimap, toObservable, toSortedList, toSortedList, toSortedList, toSortedList, unsafeCreate, unsubscribeOn, using, using, window, window, window, window, window, window, window, window, window, window, window, window, window, window, window, window, window, window, window, withLatestFrom, withLatestFrom, withLatestFrom, withLatestFrom, withLatestFrom, withLatestFrom, zip, zip, zip, zip, zip, zip, zip, zip, zip, zip, zip, zip, zipArray, zipIterable, zipWith, zipWith, zipWith, zipWith

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.reactivestreams.Publisher

subscribe

Method Detail

create

@CheckReturnValue
public static <T> BehaviorProcessor<T> create()

Creates a BehaviorProcessor without a default item.

Type Parameters:

T - the type of item the Subject will emit

Returns:

the constructed BehaviorProcessor

createDefault

@CheckReturnValue
public static <T> BehaviorProcessor<T> createDefault(T defaultValue)

Creates a BehaviorProcessor that emits the last item it observed and all subsequent items to each Subscriber that subscribes to it.

Type Parameters:

T - the type of item the Subject will emit

Parameters:

defaultValue - the item that will be emitted first to any Subscriber as long as the BehaviorProcessor has not yet observed any items from its source Observable

Returns:

the constructed BehaviorProcessor

subscribeActual

protected void subscribeActual(org.reactivestreams.Subscriber<? super T> s)

Description copied from class: Flowable

Operator implementations (both source and intermediate) should implement this method that performs the necessary business logic.

There is no need to call any of the plugin hooks on the current Flowable instance or the Subscriber.

Specified by:

subscribeActual in class Flowable<T>

Parameters:

s - the incoming Subscriber, never null

onSubscribe

public void onSubscribe(org.reactivestreams.Subscription s)

onNext

public void onNext(T t)

onError

public void onError(java.lang.Throwable t)

onComplete

public void onComplete()

hasSubscribers

public boolean hasSubscribers()

Description copied from class: FlowableProcessor

Returns true if the subject has subscribers.

The method is thread-safe.

Specified by:

hasSubscribers in class FlowableProcessor<T>

Returns:

true if the subject has subscribers

getThrowable

public java.lang.Throwable getThrowable()

Description copied from class: FlowableProcessor

Returns the error that caused the Subject to terminate or null if the Subject hasn't terminated yet.

The method is thread-safe.

Specified by:

getThrowable in class FlowableProcessor<T>

Returns:

the error that caused the Subject to terminate or null if the Subject hasn't terminated yet

getValue

public T getValue()

Returns a single value the Subject currently has or null if no such value exists.

The method is thread-safe.

Returns:

a single value the Subject currently has or null if no such value exists

getValues

public java.lang.Object[] getValues()

Returns an Object array containing snapshot all values of the Subject.

The method is thread-safe.

Returns:

the array containing the snapshot of all values of the Subject

getValues

public T[] getValues(T[] array)

Returns a typed array containing a snapshot of all values of the Subject.

The method follows the conventions of Collection.toArray by setting the array element after the last value to null (if the capacity permits).

The method is thread-safe.

Parameters:

array - the target array to copy values into if it fits

Returns:

the given array if the values fit into it or a new array containing all values

hasComplete

public boolean hasComplete()

Description copied from class: FlowableProcessor

Returns true if the subject has reached a terminal state through a complete event.

The method is thread-safe.

Specified by:

hasComplete in class FlowableProcessor<T>

Returns:

true if the subject has reached a terminal state through a complete event

See Also:

FlowableProcessor.hasThrowable()

hasThrowable

public boolean hasThrowable()

Description copied from class: FlowableProcessor

Returns true if the subject has reached a terminal state through an error event.

The method is thread-safe.

Specified by:

hasThrowable in class FlowableProcessor<T>

Returns:

true if the subject has reached a terminal state through an error event

See Also:

FlowableProcessor.getThrowable(), FlowableProcessor.hasComplete()

hasValue

public boolean hasValue()

Returns true if the subject has any value.

The method is thread-safe.

Returns:

true if the subject has any value