Class GroupedObservable<K,T>

java.lang.Object
io.reactivex.rxjava3.core.Observable<T>
io.reactivex.rxjava3.observables.GroupedObservable<K,T>
Type Parameters:
K - the type of the key
T - the type of the items emitted by the GroupedObservable
All Implemented Interfaces:
ObservableSource<T>
Direct Known Subclasses:
ObservableGroupBy.GroupedUnicast

public abstract class GroupedObservable<K,T> extends Observable<T>
An Observable that has been grouped by key, the value of which can be obtained with getKey().

Note: A GroupedObservable will cache the items it is to emit until such time as it is subscribed to. For this reason, in order to avoid memory leaks, you should not simply ignore those GroupedObservables that do not concern you. Instead, you can signal to them that they may discard their buffers by applying an operator like take(0) to them.

See Also:
  • Field Details

    • key

      final K key
  • Constructor Details

    • GroupedObservable

      protected GroupedObservable(@Nullable K key)
      Constructs a GroupedObservable with the given key.
      Parameters:
      key - the key
  • Method Details

    • getKey

      @Nullable public K getKey()
      Returns the key that identifies the group of items emitted by this GroupedObservable.
      Returns:
      the key that the items emitted by this GroupedObservable were grouped by