io.apptik.rxhub

Class AbstractRxHub

java.lang.Object

io.apptik.rxhub.AbstractRxHub

All Implemented Interfaces:

RxHub

Direct Known Subclasses:

DefaultRxHub

public abstract class AbstractRxHub
extends java.lang.Object
implements RxHub

Base implementation of RxHub Essentially this is a collection of Observable nodes which can also subscribe to other Observables and pass events to their Subscribers

Nodes can be either Subject or Relay. Nodes are identified by their Tags. Nodes subscribes to Observables however each subscription created is per RxHub.Source. A Source is identified by Observable and a Tag. For example when Observable A is added with Tag T1 and Tag T2. Two nodes are created receiving the same events. Each of those nodes can be used and unsubscribed from Observable A independently.

Observers subscribe to a Node. Observers does not need to know about the source of the Events i.e the Observers that the Nodes is subscribed to.

To fetch the Node to subscribe to getNode(Object) must be called.

Non-Rx code can also call emit(Object, Object) to manually emit Events through specific Node.

Nested Class Summary

Nested classes/interfaces inherited from interface io.apptik.rxhub.RxHub

RxHub.NodeType, RxHub.Source

Constructor Summary

Constructors

Constructor and Description
AbstractRxHub()

Method Summary

Modifier and Type	Method and Description
void	addProvider(java.lang.Object tag, rx.Observable provider) Subscribes Node to Observable.
void	clearProviders() Clears all subscriptions of all Nodes
void	emit(java.lang.Object tag, java.lang.Object event) Manually emit event to a specific Node.
rx.Observable	getNode(java.lang.Object tag) Returns the Node Observable identified by the tag
<T> rx.Observable<T>	getNodeFiltered(java.lang.Object tag, java.lang.Class<T> filterClass) Type safe variant of RxHub.getNode(Object).
void	removeProvider(java.lang.Object tag, rx.Observable provider) Unsubscribe Observable from a Node

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.apptik.rxhub.RxHub

canTriggerEmit, getNodeType, isNodeThreadsafe

Constructor Detail

AbstractRxHub

public AbstractRxHub()

Method Detail

addProvider

public final void addProvider(java.lang.Object tag,
                              rx.Observable provider)

Description copied from interface: RxHub

Subscribes Node to Observable. If there is no Node with the specific tag a new one will be created except if the node is of type RxHub.NodeType.ObservableRef

Specified by:

addProvider in interface RxHub

Parameters:

tag - the ID of the Node

provider - the Observable to subscribe to

removeProvider

public final void removeProvider(java.lang.Object tag,
                                 rx.Observable provider)

Description copied from interface: RxHub

Unsubscribe Observable from a Node

Specified by:

removeProvider in interface RxHub

Parameters:

tag - the ID of the Node

provider - the Observable to unsubscribe from

getNode

public final rx.Observable getNode(java.lang.Object tag)

Description copied from interface: RxHub

Returns the Node Observable identified by the tag

Specified by:

getNode in interface RxHub

Parameters:

tag - the ID of the Node

Returns:

the Node Observable

getNodeFiltered

public final <T> rx.Observable<T> getNodeFiltered(java.lang.Object tag,
                                                  java.lang.Class<T> filterClass)

Description copied from interface: RxHub

Type safe variant of RxHub.getNode(Object). Returns the Node Observable identified by the tag and filtered by the Class provided

Specified by:

getNodeFiltered in interface RxHub

Type Parameters:

T - the Type of the events the returned Observable will emit

Parameters:

tag - the ID of the Node

filterClass - the Class to filter the observable by

Returns:

the Filtered Node Observable

emit

public final void emit(java.lang.Object tag,
                       java.lang.Object event)

Description copied from interface: RxHub

Manually emit event to a specific Node. In order to prohibit this behaviour override this

Specified by:

emit in interface RxHub

Parameters:

tag - the ID of the Node

event - the Event to emit

clearProviders

public final void clearProviders()

Description copied from interface: RxHub

Clears all subscriptions of all Nodes

Specified by:

clearProviders in interface RxHub