Skip to content

Alphabetical List of Observable Operators

DavidMGross edited this page Feb 22, 2014 · 54 revisions
  • aggregate( ) β€” see reduce( )
  • all(β€―) β€” determine whether all items emitted by an Observable meet some criteria
  • amb( ) β€” given two or more source Observables, emits all of the items from the first of these Observables to emit an item
  • and( ) β€” combine the emissions from two or more source Observables into a Pattern
  • asyncAction(β€―) β€” convert an Action into an Observable that executes the Action and emits its return value
  • asyncFunc(β€―) β€” convert a function into an Observable that executes the function and emits its return value
  • averageDouble(β€―) β€” calculates the average of Doubles emitted by an Observable and emits this average
  • averageFloat(β€―) β€” calculates the average of Floats emitted by an Observable and emits this average
  • averageInteger(β€―) β€” calculates the average of Integers emitted by an Observable and emits this average
  • averageLong(β€―) β€” calculates the average of Longs emitted by an Observable and emits this average
  • buffer( ) β€” periodically gather items from an Observable into bundles and emit these bundles rather than emitting the items one at a time
  • cache(β€―) β€” remember the sequence of items emitted by the Observable and emit the same sequence to future Subscribers
  • cast( ) β€” cast all items from the source Observable into a particular type before reemitting them
  • chunkify( ) β€” returns an iterable that periodically returns a list of items emitted by the source Observable since the last list
  • combineLatest( ) β€” when an item is emitted by either of two Observables, combine the latest item emitted by each Observable via a specified function and emit items based on the results of this function
  • concat( ) β€” concatenate two or more Observables sequentially
  • connect(β€―) β€” instructs a Connectable Observable to begin emitting items
  • contains(β€―) β€” determine whether an Observable emits a particular item or not
  • count(β€―) β€” counts the number of items emitted by an Observable and emits this count
  • create(β€―) β€” create an Observable from scratch by means of a function
  • debounce( ) β€” only emit an item from the source Observable after a particular timespan has passed without the Observable emitting any other items
  • defaultIfEmpty( ) β€” emit items from the source Observable, or emit a default item if the source Observable completes after emitting no items
  • defer(β€―) β€” do not create the Observable until a Subscriber subscribes; create a fresh Observable on each subscription
  • deferFuture(β€―) β€” convert a Future that returns an Observable into an Observable, but do not attempt to get the Observable that the Future returns until a Subscriber subscribes
  • deferCancellableFuture(β€―) β€” convert a Future that returns an Observable into an Observable in a way that monitors the subscription status of the Observable to determine whether to halt work on the Future, but do not attempt to get the returned Observable until a Subscriber subscribes
  • delay(β€―) β€” shift the emissions from an Observable forward in time by a specified amount
  • dematerialize(β€―) β€” convert a materialized Observable back into its non-materialized form
  • distinct( ) β€” suppress duplicate items emitted by the source Observable
  • distinctUntilChanged( ) β€” suppress duplicate consecutive items emitted by the source Observable
  • doOnCompleted(β€―) β€” register an action to take when an Observable completes successfully
  • doOnEach(β€―) β€” register an action to take whenever an Observable emits an item
  • doOnError(β€―) β€” register an action to take when an Observable completes with an error
  • doOnTerminate(β€―) β€” register an action to take when an Observable completes, either successfully or with an error
  • elementAt( ) β€” emit item n emitted by the source Observable
  • elementAtOrDefault( ) β€” emit item n emitted by the source Observable, or a default item if the source Observable emits fewer than n items
  • empty(β€―) β€” create an Observable that emits nothing and then completes
  • error(β€―) β€” create an Observable that emits nothing and then signals an error
  • exists(β€―) β€” determine whether an Observable emits any items or not
  • filter( ) β€” filter items emitted by an Observable
  • finallyDo(β€―) β€” register an action to take when an Observable completes
  • first( ) (Observable) β€” emit only the first item emitted by an Observable, or the first item that meets some condition
  • first( ) (BlockingObservable) β€” emit only the first item emitted by an Observable, or the first item that meets some condition
  • firstOrDefault( ) (Observable) β€” emit only the first item emitted by an Observable, or the first item that meets some condition, or a default value if the source Observable is empty
  • firstOrDefault( ) (BlockingObservable) β€” emit only the first item emitted by an Observable, or the first item that meets some condition, or a default value if the source Observable is empty
  • flatMap( ) β€” transform the items emitted by an Observable into Observables, then flatten this into a single Observable
  • forEach( ) β€” invoke a function on each item emitted by the Observable; block until the Observable completes
  • forEachFuture(β€―) (Async) β€” pass Subscriber methods to an Observable but also have it behave like a Future that blocks until it completes
  • forEachFuture( ) (BlockingObservable)β€” create a futureTask that will invoke a specified function on each item emitted by an Observable
  • forIterable(β€―) β€” apply a function to the elements of an Iterable to create Observables which are then concatenated
  • from(β€―) β€” convert an Iterable or a Future into an Observable
  • fromAction(β€―) β€” convert an Action into an Observable that invokes the action and emits its result when a Subscriber subscribes
  • fromCallable(β€―) β€” convert a Callable into an Observable that invokes the callable and emits its result or exception when a Subscriber subscribes
  • fromCancellableFuture(β€―) β€” convert a Future into an Observable in a way that monitors the subscription status of the Observable to determine whether to halt work on the Future, but do not attempt to get the Future's value until a Subscriber subscribes
  • fromFunc0(β€―) β€” convert a Func0 into an Observable that invokes the function and emits its result when a Subscriber subscribes
  • fromFuture(β€―) β€” convert a Future into an Observable, but do not attempt to get the Future's value until a Subscriber subscribes
  • fromRunnable(β€―) β€” convert a Runnable into an Observable that invokes the runable and emits its result when a Subscriber subscribes
  • generate(β€―) β€” create an Observable that emits a sequence of items as generated by a function of your choosing
  • generateAbsoluteTime(β€―) β€” create an Observable that emits a sequence of items as generated by a function of your choosing, with each item emitted at an item-specific time
  • getIterator( ) β€” convert the sequence emitted by the Observable into an Iterator
  • groupBy( ) β€” divide an Observable into a set of Observables that emit groups of items from the original Observable, organized by key
  • groupByUntil( ) β€” divide an Observable into a set of Observables that emit groups of items from the original Observable, organized by key, and opening a new set periodically
  • groupJoin( ) β€” combine the items emitted by two Observables whenever one item from one Observable falls within a window of duration specified by an item emitted by the other Observable
  • ignoreElements( ) β€” discard the items emitted by the source Observable and only pass through the error or completed notification
  • interval(β€―) β€” create an Observable that emits a sequence of integers spaced by a given time interval
  • isEmpty(β€―) β€” determine whether an Observable emits any items or not
  • join( ) β€” combine the items emitted by two Observables whenever one item from one Observable falls within a window of duration specified by an item emitted by the other Observable
  • just(β€―) β€” convert an object into an Observable that emits that object
  • last( ) (BlockingObservable) β€” block until the Observable completes, then return the last item emitted by the Observable
  • last( ) (Observable) β€” emit only the last item emitted by the source Observable
  • lastOrDefault( ) (BlockingObservable) β€” block until the Observable completes, then return the last item emitted by the Observable or a default item if there is no last item
  • lastOrDefault( ) (Observable) β€” emit only the last item emitted by an Observable, or a default value if the source Observable is empty
  • latest( ) β€” returns an iterable that blocks until or unless the Observable emits an item that has not been returned by the iterable, then returns the latest such item
  • longCount(β€―) β€” counts the number of items emitted by an Observable and emits this count
  • map( ) β€” transform the items emitted by an Observable by applying a function to each of them
  • mapMany( ) β€” transform the items emitted by an Observable into Observables, then flatten this into a single Observable
  • mapManyDelayError( ) β€” transform the items emitted by an Observable into Observables, then flatten this into a single Observable, waiting to report errors until all error-free observables have a chance to complete
  • materialize(β€―) β€” convert an Observable into a list of Notifications
  • max(β€―) β€” emits the maximum value emitted by a source Observable
  • maxBy(β€―) β€” emits the item emitted by the source Observable that has the maximum key value
  • merge( ) β€” combine multiple Observables into one
  • mergeDelayError( ) β€” combine multiple Observables into one, allowing error-free Observables to continue before propagating errors
  • min(β€―) β€” emits the minimum value emitted by a source Observable
  • minBy(β€―) β€” emits the item emitted by the source Observable that has the minimum key value
  • mostRecent( ) β€” returns an iterable that always returns the item most recently emitted by the Observable
  • multicast(β€―) β€” represents an Observable as a Connectable Observable
  • never(β€―) β€” create an Observable that emits nothing at all
  • next( ) β€” returns an iterable that blocks until the Observable emits another item, then returns that item
  • observeOn(β€―) β€” specify on which Scheduler a Subscriber should observe the Observable
  • ofType( ) β€” emit only those items from the source Observable that are of a particular class
  • onErrorResumeNext(β€―) β€” instructs an Observable to continue emitting items after it encounters an error
  • onErrorReturn(β€―) β€” instructs an Observable to emit a particular item when it encounters an error
  • onExceptionResumeNext(β€―) β€” instructs an Observable to continue emitting items after it encounters an exception (but not another variety of throwable)
  • parallel(β€―) β€” split the work done on the emissions from an Observable into multiple Observables each operating on its own parallel thread
  • parallelMerge( ) β€” combine multiple Observables into smaller number of Observables
  • publish(β€―) β€” represents an Observable as a Connectable Observable
  • publishLast(β€―) β€” represent an Observable as a Connectable Observable that emits only the last item emitted by the source Observable
  • range(β€―) β€” create an Observable that emits a range of sequential integers
  • reduce( ) β€” apply a function to each emitted item, sequentially, and emit only the final accumulated value
  • refCount(β€―) β€” makes a Connectable Observable behave like an ordinary Observable
  • repeat(β€―) β€” create an Observable that emits a particular item or sequence of items repeatedly
  • replay(β€―) β€” ensures that all Subscribers see the same sequence of emitted items, even if they subscribe after the Observable begins emitting the items
  • retry(β€―) β€” if a source Observable emits an error, resubscribe to it in the hopes that it will complete without error
  • sample( ) β€” emit the most recent items emitted by an Observable within periodic time intervals
  • scan( ) β€” apply a function to each item emitted by an Observable, sequentially, and emit each successive value
  • sequenceEqual(β€―) β€” test the equality of sequences emitted by two Observables
  • single( ) (BlockingObservable) β€” if the source Observable completes after emitting a single item, return that item, otherwise throw an exception
  • single( ) (Observable) β€” if the source Observable completes after emitting a single item, emit that item, otherwise notify of an exception
  • singleOrDefault( ) (BlockingObservable) β€” if the source Observable completes after emitting a single item, return that item, otherwise return a default item
  • singleOrDefault( ) (Observable) β€” if the source Observable completes after emitting a single item, emit that item, otherwise emit a default item
  • skip( ) β€” ignore the first n items emitted by an Observable
  • skipLast( ) β€” ignore the last n items emitted by an Observable
  • skipUntil( ) β€” discard items emitted by a source Observable until a second Observable emits an item, then emit the remainder of the source Observable's items
  • skipWhile( ) β€” discard items emitted by an Observable until a specified condition is false, then emit the remainder
  • skipWhileWithIndex( ) β€” discard items emitted by an Observable until a specified condition is false, then emit the remainder
  • start(β€―) β€” create an Observable that emits the return value of a function
  • startCancellableFuture(β€―) β€” convert a function that returns Future into an Observable that emits that Future's return value in a way that monitors the subscription status of the Observable to determine whether to halt work on the Future
  • startFuture(β€―) β€” convert a function that returns Future into an Observable that emits that Future's return value
  • startWith( ) β€” emit a specified sequence of items before beginning to emit the items from the Observable
  • subscribeOn(β€―) β€” specify which Scheduler an Observable should use when its subscription is invoked
  • sumDouble(β€―) β€” adds the Doubles emitted by an Observable and emits this sum
  • sumFloat(β€―) β€” adds the Floats emitted by an Observable and emits this sum
  • sumInteger(β€―) β€” adds the Integers emitted by an Observable and emits this sum
  • sumLong(β€―) β€” adds the Longs emitted by an Observable and emits this sum
  • switchCase( ) β€” emit the sequence from a particular Observable based on the results of an evaluation
  • switchOnNext( ) β€” convert an Observable that emits Observables into a single Observable that emits the items emitted by the most-recently emitted of those Observables
  • synchronize(β€―) β€” force an Observable to make synchronous calls and to be well-behaved
  • take( ) β€” emit only the first n items emitted by an Observable
  • takeFirst( ) β€” emit only the first item emitted by an Observable, or the first item that meets some condition
  • takeLast( ) β€” only emit the last n items emitted by an Observable
  • takeLastBuffer( ) β€” emit the last n items emitted by an Observable, as a single list item
  • takeUntil( ) β€” emits the items from the source Observable until a second Observable emits an item
  • takeWhile( ) β€” emit items emitted by an Observable as long as a specified condition is true, then skip the remainder
  • takeWhileWithIndex( ) β€” emit items emitted by an Observable as long as a specified condition is true, then skip the remainder
  • then( ) β€” transform a series of Pattern objects via a Plan template
  • throttleFirst( ) β€” emit the first items emitted by an Observable within periodic time intervals
  • throttleLast( ) β€” emit the most recent items emitted by an Observable within periodic time intervals
  • throttleWithTimeout( ) β€” only emit an item from the source Observable after a particular timespan has passed without the Observable emitting any other items
  • timeInterval(β€―) β€” emit the time lapsed between consecutive emissions of a source Observable
  • timeout( ) β€” emit items from a source Observable, but issue an exception if no item is emitted in a specified timespan
  • timer( ) β€” create an Observable that emits a single item after a given delay
  • timestamp(β€―) β€” attach a timestamp to every item emitted by an Observable
  • toAsync(β€―) β€” convert a function or Action into an Observable that executes the function and emits its return value
  • toBlockingObservable( ) β€” transform an Observable into a BlockingObservable
  • toFuture( ) β€” convert the Observable into a Future
  • toIterable( ) β€” convert the sequence emitted by the Observable into an Iterable
  • toIterator( ) β€” convert the sequence emitted by the Observable into an Iterator
  • toList(β€―) β€” collect all items from an Observable and emit them as a single List
  • toMap(β€―) β€” convert the sequence of items emitted by an Observable into a map keyed by a specified key function
  • toMultiMap(β€―) β€” convert the sequence of items emitted by an Observable into an ArrayList that is also a map keyed by a specified key function
  • toSortedList(β€―) β€” collect all items from an Observable and emit them as a single, sorted List
  • using(β€―) β€” create a disposable resource that has the same lifespan as an Observable
  • when( ) β€” convert a series of Plan objects into an Observable
  • where( ) β€” filter items emitted by an Observable
  • window( ) β€” periodically subdivide items from an Observable into Observable windows and emit these windows rather than emitting the items one at a time
  • zip( ) β€” combine sets of items emitted by two or more Observables together via a specified function and emit items based on the results of this function