Interface FlowableDocBasic<T>

Type Parameters:

T - the element type of the flow

All Known Implementing Classes:

AsyncProcessor, BehaviorProcessor, ConnectableFlowable, Flowable, FlowableProcessor, GroupedFlowable, MulticastProcessor, PublishProcessor, ReplayProcessor, UnicastProcessor

public sealed interface FlowableDocBasic<T>
permits Flowable<T>

Documents a set of operators so that the main Flowable source file is not cluttered.

Since:

4.0.0

Method Summary

Modifier and Type	Method	Description
@NonNull Flowable<T>	filter(@NonNull Predicate<? super T> predicate)	Filters items emitted by the current Flowable by only emitting those that satisfy a specified predicate.
<@NonNull R> @NonNull Flowable<R>	map(@NonNull Function<? super T, ? extends @NonNull R> mapper)	Returns a Flowable that applies a specified function to each item emitted by the current Flowable and emits the results of these function applications.

Method Details

map

@CheckReturnValue
@NonNull
@BackpressureSupport(PASS_THROUGH)
@SchedulerSupport("none")
<@NonNull R> @NonNull Flowable<R> map(@NonNull
 @NonNull Function<? super T, ? extends @NonNull R> mapper)

Returns a Flowable that applies a specified function to each item emitted by the current Flowable and emits the results of these function applications.

Backpressure:

The operator doesn't interfere with backpressure which is determined by the current Flowable's backpressure behavior.

Scheduler:

map does not operate by default on a particular Scheduler.

Type Parameters:

R - the output type

Parameters:

mapper - a function to apply to each item emitted by the current Flowable

Returns:

the new Flowable instance

Throws:

NullPointerException - if mapper is null

See Also:

• ReactiveX operators documentation: Map
• invalid reference

  #mapOptional(Function)

filter

@CheckReturnValue
@NonNull
@BackpressureSupport(PASS_THROUGH)
@SchedulerSupport("none")
@NonNull Flowable<T> filter(@NonNull
 @NonNull Predicate<? super T> predicate)

Filters items emitted by the current Flowable by only emitting those that satisfy a specified predicate.

Backpressure:

The operator doesn't interfere with backpressure which is determined by the current Flowable's backpressure behavior.

Scheduler:

filter does not operate by default on a particular Scheduler.

Parameters:

predicate - a function that evaluates each item emitted by the current Flowable, returning true if it passes the filter

Returns:

the new Flowable instance

Throws:

NullPointerException - if predicate is null

See Also:

• ReactiveX operators documentation: Filter