Package rx.observables
Class SyncOnSubscribe.SyncOnSubscribeImpl<S,T>
- java.lang.Object
-
- rx.observables.SyncOnSubscribe<S,T>
-
- rx.observables.SyncOnSubscribe.SyncOnSubscribeImpl<S,T>
-
- Type Parameters:
S
- the type of the user-defined stateT
- the type of compatible Subscribers
- All Implemented Interfaces:
Action
,Action1<Subscriber<? super T>>
,Function
,Observable.OnSubscribe<T>
- Enclosing class:
- SyncOnSubscribe<S,T>
static final class SyncOnSubscribe.SyncOnSubscribeImpl<S,T> extends SyncOnSubscribe<S,T>
An implementation of SyncOnSubscribe that delegatesSyncOnSubscribe#next(Object, Subscriber)
,SyncOnSubscribe.generateState()
, andSyncOnSubscribe.onUnsubscribe(Object)
to provided functions/closures.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class rx.observables.SyncOnSubscribe
SyncOnSubscribe.SubscriptionProducer<S,T>, SyncOnSubscribe.SyncOnSubscribeImpl<S,T>
-
-
Constructor Summary
Constructors Constructor Description SyncOnSubscribeImpl(Func0<? extends S> generator, Func2<? super S,? super Observer<? super T>,? extends S> next)
SyncOnSubscribeImpl(Func0<? extends S> generator, Func2<? super S,? super Observer<? super T>,? extends S> next, Action1<? super S> onUnsubscribe)
SyncOnSubscribeImpl(Func2<S,Observer<? super T>,S> nextFunc)
SyncOnSubscribeImpl(Func2<S,Observer<? super T>,S> next, Action1<? super S> onUnsubscribe)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected S
generateState()
Executed once when subscribed to by a subscriber (viaSyncOnSubscribe.call(Subscriber)
) to produce a state value.protected S
next(S state, Observer<? super T> observer)
Called to produce data to the downstream subscribers.protected void
onUnsubscribe(S state)
Clean up behavior that is executed after the downstream subscriber's subscription is unsubscribed.-
Methods inherited from class rx.observables.SyncOnSubscribe
call, createSingleState, createSingleState, createStateful, createStateful, createStateless, createStateless
-
-
-
-
Constructor Detail
-
SyncOnSubscribeImpl
SyncOnSubscribeImpl(Func0<? extends S> generator, Func2<? super S,? super Observer<? super T>,? extends S> next, Action1<? super S> onUnsubscribe)
-
SyncOnSubscribeImpl
public SyncOnSubscribeImpl(Func0<? extends S> generator, Func2<? super S,? super Observer<? super T>,? extends S> next)
-
SyncOnSubscribeImpl
public SyncOnSubscribeImpl(Func2<S,Observer<? super T>,S> next, Action1<? super S> onUnsubscribe)
-
-
Method Detail
-
generateState
protected S generateState()
Description copied from class:SyncOnSubscribe
Executed once when subscribed to by a subscriber (viaSyncOnSubscribe.call(Subscriber)
) to produce a state value. This value is passed intonext(S state, Observer
on the first iteration. Subsequent iterations ofobserver) next
will receive the state returned by the previous invocation ofnext
.- Specified by:
generateState
in classSyncOnSubscribe<S,T>
- Returns:
- the initial state value
-
next
protected S next(S state, Observer<? super T> observer)
Description copied from class:SyncOnSubscribe
Called to produce data to the downstream subscribers. To emit data to a downstream subscriber callobserver.onNext(t)
. To signal an error condition callobserver.onError(throwable)
or throw an Exception. To signal the end of a data stream callobserver.onCompleted()
. Implementations of this method must follow the following rules.- Must not call
observer.onNext(t)
more than 1 time per invocation. - Must not call
observer.onNext(t)
concurrently.
state
argument of the next invocation of this method.- Specified by:
next
in classSyncOnSubscribe<S,T>
- Parameters:
state
- the state value (fromSyncOnSubscribe.generateState()
on the first invocation or the previous invocation of this method.observer
- the observer of data emitted by- Returns:
- the next iteration's state value
- Must not call
-
onUnsubscribe
protected void onUnsubscribe(S state)
Description copied from class:SyncOnSubscribe
Clean up behavior that is executed after the downstream subscriber's subscription is unsubscribed. This method will be invoked exactly once.- Overrides:
onUnsubscribe
in classSyncOnSubscribe<S,T>
- Parameters:
state
- the last state value prior fromSyncOnSubscribe.generateState()
ornext(S, Observer<T>)
before unsubscribe.
-
-