io.apptik.rxhub

Interface RxHub

All Known Implementing Classes:

AbstractRxHub, DefaultRxHub

public interface RxHub

RxJava based Hub connecting Observables and Observers so that Observers can receive events without knowledge of which Observables, if any, there are, while maintaining clear connection between them.

See Also:

AbstractRxHub

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	RxHub.NodeType
static class	RxHub.Source

Method Summary

Modifier and Type	Method and Description
void	addProvider(java.lang.Object tag, rx.Observable provider) Subscribes Node to Observable.
boolean	canTriggerEmit(java.lang.Object tag) Implement this to return the ability to manually (in non-Rx fashion) emit events
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 getNode(Object).
RxHub.NodeType	getNodeType(java.lang.Object tag) Implement this to return the type of node per tag
boolean	isNodeThreadsafe(java.lang.Object tag) Implement this to return if the node is threadsafe
void	removeProvider(java.lang.Object tag, rx.Observable provider) Unsubscribe Observable from a Node

Method Detail

addProvider

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

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

Parameters:

tag - the ID of the Node

provider - the Observable to subscribe to

removeProvider

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

Unsubscribe Observable from a Node

Parameters:

tag - the ID of the Node

provider - the Observable to unsubscribe from

clearProviders

void clearProviders()

Clears all subscriptions of all Nodes

getNode

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

Returns the Node Observable identified by the tag

Parameters:

tag - the ID of the Node

Returns:

the Node Observable

getNodeFiltered

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

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

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

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

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

Parameters:

tag - the ID of the Node

event - the Event to emit

getNodeType

RxHub.NodeType getNodeType(java.lang.Object tag)

Implement this to return the type of node per tag

Parameters:

tag - the identifier of the node

Returns:

the Node Type

isNodeThreadsafe

boolean isNodeThreadsafe(java.lang.Object tag)

Implement this to return if the node is threadsafe

Parameters:

tag - the identifier of the node

Returns:

true if the node is threadsafe, false otherwise

canTriggerEmit

boolean canTriggerEmit(java.lang.Object tag)

Implement this to return the ability to manually (in non-Rx fashion) emit events

Parameters:

tag - the identifier of the node

Returns:

true when manual emit is possible, false otherwise