com.jakewharton.rxrelay3

Class BehaviorRelay<T>

java.lang.Object

io.reactivex.rxjava3.core.Observable<T>

com.jakewharton.rxrelay3.Relay<T>

com.jakewharton.rxrelay3.BehaviorRelay<T>

All Implemented Interfaces:

io.reactivex.rxjava3.core.ObservableSource<T>, io.reactivex.rxjava3.functions.Consumer<T>

public final class BehaviorRelay<T>
extends Relay<T>

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

Example usage:

 

  // observer will receive all events.
  BehaviorRelay<Object> subject = BehaviorRelay.createDefault("default");
  subject.subscribe(observer);
  subject.accept("one");
  subject.accept("two");
  subject.accept("three");

  // observer will receive the "one", "two" and "three" events, but not "zero"
  BehaviorRelay<Object> subject = BehaviorRelay.createDefault("default");
  subject.accept("zero");
  subject.accept("one");
  subject.subscribe(observer);
  subject.accept("two");
  subject.accept("three");
   

Method Summary

Modifier and Type	Method and Description
void	accept(T value)
static <T> @NonNull BehaviorRelay<T>	create() Creates a BehaviorRelay without a default item.
static <T> @NonNull BehaviorRelay<T>	createDefault(T defaultValue) Creates a BehaviorRelay that emits the last item it observed and all subsequent items to each Observer that subscribes to it.
T	getValue() Returns a single value the Relay currently has or null if no such value exists.
java.lang.Object[]	getValues() Deprecated. in 2.1; put the result of getValue() into an array manually, will be removed in 3.x
T[]	getValues(T[] array) Deprecated. in 2.1; put the result of getValue() into an array manually, will be removed in 3.x
boolean	hasObservers() Returns true if the subject has any Observers.
boolean	hasValue() Returns true if the subject has any value.
protected void	subscribeActual(io.reactivex.rxjava3.core.Observer<? super T> observer)

Methods inherited from class com.jakewharton.rxrelay3.Relay

toSerialized

Methods inherited from class io.reactivex.rxjava3.core.Observable

all, amb, ambArray, ambWith, any, blockingFirst, blockingFirst, blockingForEach, blockingForEach, blockingIterable, blockingIterable, blockingLast, blockingLast, blockingLatest, blockingMostRecent, blockingNext, blockingSingle, blockingSingle, blockingStream, blockingStream, blockingSubscribe, blockingSubscribe, blockingSubscribe, blockingSubscribe, blockingSubscribe, buffer, buffer, buffer, buffer, buffer, buffer, buffer, buffer, buffer, buffer, buffer, buffer, buffer, buffer, buffer, buffer, buffer, bufferSize, cache, cacheWithInitialCapacity, cast, collect, collect, collectInto, combineLatest, combineLatest, combineLatest, combineLatest, combineLatest, combineLatest, combineLatest, combineLatest, combineLatest, combineLatest, combineLatestArray, combineLatestArray, combineLatestArrayDelayError, combineLatestArrayDelayError, combineLatestDelayError, combineLatestDelayError, compose, concat, concat, concat, concat, concat, concat, concatArray, concatArrayDelayError, concatArrayEager, concatArrayEager, concatArrayEagerDelayError, concatArrayEagerDelayError, concatDelayError, concatDelayError, concatDelayError, concatEager, concatEager, concatEager, concatEager, concatEagerDelayError, concatEagerDelayError, concatEagerDelayError, concatEagerDelayError, concatMap, concatMap, concatMap, concatMapCompletable, concatMapCompletable, concatMapCompletableDelayError, concatMapCompletableDelayError, concatMapCompletableDelayError, concatMapDelayError, concatMapDelayError, concatMapDelayError, concatMapEager, concatMapEager, concatMapEagerDelayError, concatMapEagerDelayError, concatMapIterable, concatMapMaybe, concatMapMaybe, concatMapMaybeDelayError, concatMapMaybeDelayError, concatMapMaybeDelayError, concatMapSingle, concatMapSingle, concatMapSingleDelayError, concatMapSingleDelayError, concatMapSingleDelayError, concatMapStream, concatWith, concatWith, concatWith, 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, doOnComplete, doOnDispose, doOnEach, doOnEach, doOnError, doOnLifecycle, doOnNext, doOnSubscribe, doOnTerminate, elementAt, elementAt, elementAtOrError, empty, error, error, filter, first, firstElement, firstOrError, firstOrErrorStage, firstStage, flatMap, flatMap, flatMap, flatMap, flatMap, flatMap, flatMap, flatMap, flatMap, flatMap, flatMap, flatMap, flatMapCompletable, flatMapCompletable, flatMapIterable, flatMapIterable, flatMapMaybe, flatMapMaybe, flatMapSingle, flatMapSingle, flatMapStream, forEach, forEachWhile, forEachWhile, forEachWhile, fromAction, fromArray, fromCallable, fromCompletable, fromCompletionStage, fromFuture, fromFuture, fromIterable, fromMaybe, fromOptional, fromPublisher, fromRunnable, fromSingle, fromStream, fromSupplier, 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, lastOrErrorStage, lastStage, lift, map, mapOptional, materialize, merge, merge, merge, merge, merge, merge, merge, merge, mergeArray, mergeArray, mergeArrayDelayError, mergeArrayDelayError, mergeDelayError, mergeDelayError, mergeDelayError, mergeDelayError, mergeDelayError, mergeDelayError, mergeDelayError, mergeDelayError, mergeWith, mergeWith, mergeWith, mergeWith, never, observeOn, observeOn, observeOn, ofType, onErrorComplete, onErrorComplete, onErrorResumeNext, onErrorResumeWith, onErrorReturn, onErrorReturnItem, onTerminateDetach, publish, publish, range, rangeLong, reduce, reduce, reduceWith, repeat, repeat, repeatUntil, repeatWhen, replay, replay, 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, singleOrErrorStage, singleStage, skip, skip, skip, skipLast, skipLast, skipLast, skipLast, skipLast, skipLast, skipUntil, skipWhile, sorted, sorted, startWith, startWith, startWith, startWith, startWithArray, startWithItem, startWithIterable, subscribe, subscribe, subscribe, subscribe, subscribe, subscribeOn, subscribeWith, switchIfEmpty, switchMap, switchMap, switchMapCompletable, switchMapCompletableDelayError, switchMapDelayError, switchMapDelayError, switchMapMaybe, switchMapMaybeDelayError, switchMapSingle, switchMapSingleDelayError, switchOnNext, switchOnNext, switchOnNextDelayError, switchOnNextDelayError, take, take, take, takeLast, takeLast, takeLast, takeLast, takeLast, takeLast, takeLast, takeLast, takeLast, takeUntil, takeUntil, takeWhile, test, test, throttleFirst, throttleFirst, throttleLast, throttleLast, throttleLatest, throttleLatest, throttleLatest, throttleLatest, throttleWithTimeout, throttleWithTimeout, timeInterval, timeInterval, timeInterval, timeInterval, timeout, timeout, timeout, timeout, timeout, timeout, timeout, timeout, timer, timer, timestamp, timestamp, timestamp, timestamp, to, toFlowable, toFuture, toList, toList, toList, toMap, toMap, toMap, toMultimap, toMultimap, toMultimap, toMultimap, 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, withLatestFrom, withLatestFrom, withLatestFrom, withLatestFrom, withLatestFrom, withLatestFrom, wrap, zip, zip, zip, zip, zip, zip, zip, zip, zip, zip, zip, zip, zipArray, zipWith, zipWith, zipWith, zipWith

Methods inherited from class java.lang.Object

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

Method Detail

create

@CheckReturnValue
 @NonNull
public static <T> @NonNull BehaviorRelay<T> create()

Creates a BehaviorRelay without a default item.

createDefault

@CheckReturnValue
 @NonNull
public static <T> @NonNull BehaviorRelay<T> createDefault(@NonNull
                                                                                      T defaultValue)

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

Parameters:

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

subscribeActual

protected void subscribeActual(io.reactivex.rxjava3.core.Observer<? super T> observer)

Specified by:

subscribeActual in class io.reactivex.rxjava3.core.Observable<T>

accept

public void accept(@NonNull
                   T value)

Description copied from class: Relay

Specified by:

accept in interface io.reactivex.rxjava3.functions.Consumer<T>

Specified by:

accept in class Relay<T>

hasObservers

public boolean hasObservers()

Description copied from class: Relay

Returns true if the subject has any Observers.

The method is thread-safe.

Specified by:

hasObservers in class Relay<T>

getValue

@Nullable
public T getValue()

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

The method is thread-safe.

getValues

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

Deprecated. in 2.1; put the result of getValue() into an array manually, will be removed in 3.x

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

The method is thread-safe.

getValues

@Deprecated
public T[] getValues(T[] array)

Deprecated. in 2.1; put the result of getValue() into an array manually, will be removed in 3.x

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

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

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