com.diffplug.common.rx

Interface RxGetter<T>

All Superinterfaces:

IObservable<T>, Supplier<T>

All Known Subinterfaces:

RxBox<T>

All Known Implementing Classes:

RxBiMap, RxBox.Default, RxList, RxMap, RxOptional, RxOrderedSet, RxSet, RxSortedMap, RxSortedSet

public interface RxGetter<T>
extends IObservable<T>, Supplier<T>

Represents a value which can be accessed through a traditional get() method or by listening to its Observable.

RxGetter's Observable has the semantics of a BehaviorSubject, meaning that as soon as a listener subscribes to the Observable, it will emit the current value.

Any time the value changes, RxGetter's Observable will notify of the change. If the value did not change (e.g. a field is set to its current value, which produces no change) then the Observable will not fire.

Method Summary

Modifier and Type	Method and Description
static <T1,T2,R> RxGetter<R>	combineLatest(RxGetter<? extends T1> t, RxGetter<? extends T2> u, BiFunction<? super T1,? super T2,? extends R> combine) Creates an RxGetter which combines two RxGetters using the BiFunction combine.
static <T> RxGetter<T>	from(Observable<T> observableUnfiltered, T initialValue) Creates an RxGetter from the given Observable and initialValue.
default <R> RxGetter<R>	map(Function<? super T,? extends R> mapper) Maps an RxGetter to a new RxGetter by applying the mapper function to all of its values.

Methods inherited from interface com.diffplug.common.rx.IObservable

asObservable

Methods inherited from interface java.util.function.Supplier

get

Method Detail

map

default <R> RxGetter<R> map(Function<? super T,? extends R> mapper)

Maps an RxGetter to a new RxGetter by applying the mapper function to all of its values.

If the Observable of the source RxGetter changes, but the Function<T, R> mapper collapses these values to produce no change, then the mapped Observable shall not emit a new value.

• Incorrect: ("A", "B", "C") -> map(String::length) = (1, 1, 1)
• Correct: ("A", "B", "C") -> map(String::length) = (1)

from

static <T> RxGetter<T> from(Observable<T> observableUnfiltered,
                            T initialValue)

Creates an RxGetter from the given Observable and initialValue.

combineLatest

static <T1,T2,R> RxGetter<R> combineLatest(RxGetter<? extends T1> t,
                                           RxGetter<? extends T2> u,
                                           BiFunction<? super T1,? super T2,? extends R> combine)

Creates an RxGetter which combines two RxGetters using the BiFunction combine. As with map(java.util.function.Function<? super T, ? extends R>), the observable only emits a new value if its value has changed.