public final Class BlockingObservable&lt;T&gt;

first back to summary

first	back to summary
public T first(Func1<? super T, Boolean> predicate) Returns the first item emitted by this `BlockingObservable` that matches a predicate, or throws `NoSuchElementException` if it emits no such item. Parameters predicate:Func1<? super T, Boolean> a predicate function to evaluate items emitted by this `BlockingObservable` Returns:T the first item emitted by this `BlockingObservable` that matches the predicate Exceptions NoSuchElementException: if this `BlockingObservable` emits no such items See Also ReactiveX documentation: First

public T first(Func1<? super T, Boolean> predicate)

Returns the first item emitted by this BlockingObservable that matches a predicate, or throws NoSuchElementException if it emits no such item.

Parameters

predicate:Func1<? super T, Boolean>: a predicate function to evaluate items emitted by this BlockingObservable

Returns:T

the first item emitted by this BlockingObservable that matches the predicate

Exceptions

NoSuchElementException:: if this BlockingObservable emits no such items

See Also

firstOrDefault back to summary

firstOrDefault	back to summary
public T firstOrDefault(T defaultValue) Returns the first item emitted by this `BlockingObservable`, or a default value if it emits no items. Parameters defaultValue:T a default value to return if this `BlockingObservable` emits no items Returns:T the first item emitted by this `BlockingObservable`, or the default value if it emits no items See Also ReactiveX documentation: First

public T firstOrDefault(T defaultValue)

Returns the first item emitted by this BlockingObservable, or a default value if it emits no items.

Parameters

defaultValue:T: a default value to return if this BlockingObservable emits no items

Returns:T

the first item emitted by this BlockingObservable, or the default value if it emits no items

See Also

firstOrDefault back to summary

firstOrDefault	back to summary
public T firstOrDefault(T defaultValue, Func1<? super T, Boolean> predicate) Returns the first item emitted by this `BlockingObservable` that matches a predicate, or a default value if it emits no such items. Parameters defaultValue:T a default value to return if this `BlockingObservable` emits no matching items predicate:Func1<? super T, Boolean> a predicate function to evaluate items emitted by this `BlockingObservable` Returns:T the first item emitted by this `BlockingObservable` that matches the predicate, or the default value if this `BlockingObservable` emits no matching items See Also ReactiveX documentation: First

public T firstOrDefault(T defaultValue, Func1<? super T, Boolean> predicate)

Returns the first item emitted by this BlockingObservable that matches a predicate, or a default value if it emits no such items.

Parameters

defaultValue:T: a default value to return if this BlockingObservable emits no matching items
predicate:Func1<? super T, Boolean>: a predicate function to evaluate items emitted by this BlockingObservable

Returns:T

the first item emitted by this BlockingObservable that matches the predicate, or the default value if this BlockingObservable emits no matching items

See Also

ReactiveX documentation: To

forEach back to summary

forEach	back to summary
public void forEach(final Action1<? super T> onNext) Invokes a method on each item emitted by this `BlockingObservable` and blocks until the Observable completes. Note This will block even if the underlying Observable is asynchronous. This is similar to `Observable#subscribe(Subscriber)`, but it blocks. Because it blocks it does not need the `Subscriber#onCompleted()` or `Subscriber#onError(Throwable)` methods. If the underlying Observable terminates with an error, rather than calling `onError`, this method will throw an exception. The difference between this method and `subscribe(Action1)` is that the `onNext` action is executed on the emission thread instead of the current thread. Parameters onNext:Action1<? super T> the `Action1` to invoke for each item emitted by the `BlockingObservable` Exceptions RuntimeException: if an error occurs See Also ReactiveX documentation: Subscribe, `subscribe(Action1)`

public void forEach(final Action1<? super T> onNext)

Invokes a method on each item emitted by this BlockingObservable and blocks until the Observable completes.

Note

This will block even if the underlying Observable is asynchronous.

This is similar to Observable#subscribe(Subscriber), but it blocks. Because it blocks it does not need the Subscriber#onCompleted() or Subscriber#onError(Throwable) methods. If the underlying Observable terminates with an error, rather than calling onError, this method will throw an exception.

The difference between this method and subscribe(Action1) is that the onNext action is executed on the emission thread instead of the current thread.

Parameters

onNext:Action1<? super T>: the Action1 to invoke for each item emitted by the BlockingObservable

Exceptions

RuntimeException:: if an error occurs

from back to summary

from	back to summary
public static <T> BlockingObservable<T> from(final Observable<? extends T> o) Converts an `Observable` into a `BlockingObservable`. Parameters <T> the observed value type o:Observable<? extends T> the `Observable` you want to convert Returns:BlockingObservable<T> a `BlockingObservable` version of `o`

public static <T> BlockingObservable<T> from(final Observable<? extends T> o)

Converts an Observable into a BlockingObservable.

Parameters

<T>: the observed value type
o:Observable<? extends T>: the Observable you want to convert

Returns:BlockingObservable<T>

a BlockingObservable version of o

getIterator back to summary

getIterator	back to summary
public Iterator<T> getIterator() Returns an `Iterator` that iterates over all items emitted by this `BlockingObservable`. Returns:Iterator<T> an `Iterator` that can iterate over the items emitted by this `BlockingObservable` Annotations @SuppressWarnings:unchecked, cast See Also ReactiveX documentation: To

public Iterator<T> getIterator()

Returns an Iterator that iterates over all items emitted by this BlockingObservable.

Returns:Iterator<T>

an Iterator that can iterate over the items emitted by this BlockingObservable

Annotations

@SuppressWarnings:unchecked, cast

See Also

last back to summary

last	back to summary
public T last() Returns the last item emitted by this `BlockingObservable`, or throws `NoSuchElementException` if this `BlockingObservable` emits no items. Returns:T the last item emitted by this `BlockingObservable` Exceptions NoSuchElementException: if this `BlockingObservable` emits no items See Also ReactiveX documentation: Last

public T last()

Returns the last item emitted by this BlockingObservable, or throws NoSuchElementException if this BlockingObservable emits no items.

Returns:T

the last item emitted by this BlockingObservable

Exceptions

NoSuchElementException:: if this BlockingObservable emits no items

See Also

last back to summary

last	back to summary
public T last(final Func1<? super T, Boolean> predicate) Returns the last item emitted by this `BlockingObservable` that matches a predicate, or throws `NoSuchElementException` if it emits no such items. Parameters predicate:Func1<? super T, Boolean> a predicate function to evaluate items emitted by the `BlockingObservable` Returns:T the last item emitted by the `BlockingObservable` that matches the predicate Exceptions NoSuchElementException: if this `BlockingObservable` emits no items See Also ReactiveX documentation: Last

public T last(final Func1<? super T, Boolean> predicate)

Returns the last item emitted by this BlockingObservable that matches a predicate, or throws NoSuchElementException if it emits no such items.

Parameters

predicate:Func1<? super T, Boolean>: a predicate function to evaluate items emitted by the BlockingObservable

Returns:T

the last item emitted by the BlockingObservable that matches the predicate

Exceptions

NoSuchElementException:: if this BlockingObservable emits no items

See Also

lastOrDefault back to summary

lastOrDefault	back to summary
public T lastOrDefault(T defaultValue) Returns the last item emitted by this `BlockingObservable`, or a default value if it emits no items. Parameters defaultValue:T a default value to return if this `BlockingObservable` emits no items Returns:T the last item emitted by the `BlockingObservable`, or the default value if it emits no items See Also ReactiveX documentation: Last

public T lastOrDefault(T defaultValue)

Returns the last item emitted by this BlockingObservable, or a default value if it emits no items.

Parameters

defaultValue:T: a default value to return if this BlockingObservable emits no items

Returns:T

the last item emitted by the BlockingObservable, or the default value if it emits no items

See Also

lastOrDefault back to summary

lastOrDefault	back to summary
public T lastOrDefault(T defaultValue, Func1<? super T, Boolean> predicate) Returns the last item emitted by this `BlockingObservable` that matches a predicate, or a default value if it emits no such items. Parameters defaultValue:T a default value to return if this `BlockingObservable` emits no matching items predicate:Func1<? super T, Boolean> a predicate function to evaluate items emitted by this `BlockingObservable` Returns:T the last item emitted by this `BlockingObservable` that matches the predicate, or the default value if it emits no matching items See Also ReactiveX documentation: Last

public T lastOrDefault(T defaultValue, Func1<? super T, Boolean> predicate)

Returns the last item emitted by this BlockingObservable that matches a predicate, or a default value if it emits no such items.

Parameters

defaultValue:T: a default value to return if this BlockingObservable emits no matching items
predicate:Func1<? super T, Boolean>: a predicate function to evaluate items emitted by this BlockingObservable

Returns:T

the last item emitted by this BlockingObservable that matches the predicate, or the default value if it emits no matching items

See Also

latest back to summary

latest	back to summary
public Iterable<T> latest() Returns an `Iterable` that returns the latest item emitted by this `BlockingObservable`, waiting if necessary for one to become available. If this `BlockingObservable` produces items faster than `Iterator.next` takes them, `onNext` events might be skipped, but `onError` or `onCompleted` events are not. Note also that an `onNext` directly followed by `onCompleted` might hide the `onNext` event. Returns:Iterable<T> an Iterable that always returns the latest item emitted by this `BlockingObservable` Annotations @SuppressWarnings:cast, unchecked See Also ReactiveX documentation: First

public Iterable<T> latest()

Returns an Iterable that returns the latest item emitted by this BlockingObservable, waiting if necessary for one to become available.

If this BlockingObservable produces items faster than Iterator.next takes them, onNext events might be skipped, but onError or onCompleted events are not.

Note also that an onNext directly followed by onCompleted might hide the onNext event.

Returns:Iterable<T>

an Iterable that always returns the latest item emitted by this BlockingObservable

Annotations

@SuppressWarnings:cast, unchecked

See Also

mostRecent back to summary

mostRecent	back to summary
public Iterable<T> mostRecent(T initialValue) Returns an `Iterable` that always returns the item most recently emitted by this `BlockingObservable`. Parameters initialValue:T the initial value that the `Iterable` sequence will yield if this `BlockingObservable` has not yet emitted an item Returns:Iterable<T> an `Iterable` that on each iteration returns the item that this `BlockingObservable` has most recently emitted See Also ReactiveX documentation: First

public Iterable<T> mostRecent(T initialValue)

Returns an Iterable that always returns the item most recently emitted by this BlockingObservable.

Parameters

initialValue:T: the initial value that the Iterable sequence will yield if this BlockingObservable has not yet emitted an item

Returns:Iterable<T>

an Iterable that on each iteration returns the item that this BlockingObservable has most recently emitted

See Also

ReactiveX documentation: TakeLast

next back to summary

next	back to summary
public Iterable<T> next() Returns an `Iterable` that blocks until this `BlockingObservable` emits another item, then returns that item. Returns:Iterable<T> an `Iterable` that blocks upon each iteration until this `BlockingObservable` emits a new item, whereupon the Iterable returns that item Annotations @SuppressWarnings:cast, unchecked See Also ReactiveX documentation: TakeLast

public Iterable<T> next()

Returns an Iterable that blocks until this BlockingObservable emits another item, then returns that item.

Returns:Iterable<T>

an Iterable that blocks upon each iteration until this BlockingObservable emits a new item, whereupon the Iterable returns that item

Annotations

@SuppressWarnings:cast, unchecked

See Also

single back to summary

single	back to summary
public T single() If this `BlockingObservable` completes after emitting a single item, return that item, otherwise throw a `NoSuchElementException`. Returns:T the single item emitted by this `BlockingObservable` See Also ReactiveX documentation: First

public T single()

If this BlockingObservable completes after emitting a single item, return that item, otherwise throw a NoSuchElementException.

Returns:T: the single item emitted by this BlockingObservable
See Also: ReactiveX documentation: First

single back to summary

single	back to summary
public T single(Func1<? super T, Boolean> predicate) If this `BlockingObservable` completes after emitting a single item that matches a given predicate, return that item, otherwise throw a `NoSuchElementException`. Parameters predicate:Func1<? super T, Boolean> a predicate function to evaluate items emitted by this `BlockingObservable` Returns:T the single item emitted by this `BlockingObservable` that matches the predicate See Also ReactiveX documentation: First

public T single(Func1<? super T, Boolean> predicate)

If this BlockingObservable completes after emitting a single item that matches a given predicate, return that item, otherwise throw a NoSuchElementException.

Parameters

predicate:Func1<? super T, Boolean>: a predicate function to evaluate items emitted by this BlockingObservable

Returns:T

the single item emitted by this BlockingObservable that matches the predicate

See Also

singleOrDefault back to summary

singleOrDefault	back to summary
public T singleOrDefault(T defaultValue) If this `BlockingObservable` completes after emitting a single item, return that item; if it emits more than one item, throw an `IllegalArgumentException`; if it emits no items, return a default value. Parameters defaultValue:T a default value to return if this `BlockingObservable` emits no items Returns:T the single item emitted by this `BlockingObservable`, or the default value if it emits no items See Also ReactiveX documentation: First

public T singleOrDefault(T defaultValue)

If this BlockingObservable completes after emitting a single item, return that item; if it emits more than one item, throw an IllegalArgumentException; if it emits no items, return a default value.

Parameters

defaultValue:T: a default value to return if this BlockingObservable emits no items

Returns:T

the single item emitted by this BlockingObservable, or the default value if it emits no items

See Also

singleOrDefault back to summary

singleOrDefault	back to summary
public T singleOrDefault(T defaultValue, Func1<? super T, Boolean> predicate) If this `BlockingObservable` completes after emitting a single item that matches a predicate, return that item; if it emits more than one such item, throw an `IllegalArgumentException`; if it emits no items, return a default value. Parameters defaultValue:T a default value to return if this `BlockingObservable` emits no matching items predicate:Func1<? super T, Boolean> a predicate function to evaluate items emitted by this `BlockingObservable` Returns:T the single item emitted by the `BlockingObservable` that matches the predicate, or the default value if no such items are emitted See Also ReactiveX documentation: First

public T singleOrDefault(T defaultValue, Func1<? super T, Boolean> predicate)

If this BlockingObservable completes after emitting a single item that matches a predicate, return that item; if it emits more than one such item, throw an IllegalArgumentException; if it emits no items, return a default value.

Parameters

defaultValue:T: a default value to return if this BlockingObservable emits no matching items
predicate:Func1<? super T, Boolean>: a predicate function to evaluate items emitted by this BlockingObservable

Returns:T

the single item emitted by the BlockingObservable that matches the predicate, or the default value if no such items are emitted

See Also

subscribe	back to summary
public void subscribe() Runs the source observable to a terminal event, ignoring any values and rethrowing any exception. Since 1.3

subscribe	back to summary
public void subscribe(Observer<? super T> observer) Subscribes to the source and calls back the Observer methods on the current thread. Parameters observer:Observer<? super T> the observer to call event methods on Since 1.3

public void subscribe(Observer<? super T> observer)

Subscribes to the source and calls back the Observer methods on the current thread.

Parameters

observer:Observer<? super T>: the observer to call event methods on

Since

1.3

subscribe	back to summary
public void subscribe(Subscriber<? super T> subscriber) Subscribes to the source and calls the Subscriber methods on the current thread. The unsubscription and backpressure is composed through. Parameters subscriber:Subscriber<? super T> the subscriber to forward events and calls to in the current thread Annotations @SuppressWarnings:unchecked Since 1.3

public void subscribe(Subscriber<? super T> subscriber)

Subscribes to the source and calls the Subscriber methods on the current thread.

The unsubscription and backpressure is composed through.

Parameters

subscriber:Subscriber<? super T>: the subscriber to forward events and calls to in the current thread

Annotations

@SuppressWarnings:unchecked

Since

1.3

subscribe back to summary

subscribe	back to summary
public void subscribe(final Action1<? super T> onNext) Subscribes to the source and calls the given action on the current thread and rethrows any exception wrapped into OnErrorNotImplementedException. The difference between this method and `forEach(Action1)` is that the action is always executed on the current thread. Parameters onNext:Action1<? super T> the callback action for each source value Since 1.3 See Also `forEach(Action1)`

public void subscribe(final Action1<? super T> onNext)

Subscribes to the source and calls the given action on the current thread and rethrows any exception wrapped into OnErrorNotImplementedException.

The difference between this method and forEach(Action1) is that the action is always executed on the current thread.

Parameters

onNext:Action1<? super T>: the callback action for each source value

Since

1.3

See Also

forEach(Action1)

subscribe	back to summary
public void subscribe(final Action1<? super T> onNext, final Action1<? super Throwable> onError) Subscribes to the source and calls the given actions on the current thread. Parameters onNext:Action1<? super T> the callback action for each source value onError:Action1<? super Throwable> the callback action for an error event Since 1.3

public void subscribe(final Action1<? super T> onNext, final Action1<? super Throwable> onError)

Subscribes to the source and calls the given actions on the current thread.

Parameters

onNext:Action1<? super T>: the callback action for each source value
onError:Action1<? super Throwable>: the callback action for an error event

Since

1.3

subscribe	back to summary
public void subscribe(final Action1<? super T> onNext, final Action1<? super Throwable> onError, final Action0 onCompleted) Subscribes to the source and calls the given actions on the current thread. Parameters onNext:Action1<? super T> the callback action for each source value onError:Action1<? super Throwable> the callback action for an error event onCompleted:Action0 the callback action for the completion event. Since 1.3