de.halfbit.tinybus

Class TinyBus

java.lang.Object

de.halfbit.tinybus.TinyBus

All Implemented Interfaces:

Bus

public class TinyBus
extends java.lang.Object
implements Bus

Main bus implementation. You can either create a bus instance by calling constructor or use static from(Context) method.

When you use constructor you create a stand alone bus instance which is not bound to any context. You are not able to wire(Wireable) any Wireable's to such bus.

Create your bus using from(Context) method, if you want to use Wireable's.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TinyBus.Wireable You can wire instances of this class to a bus instance using wire(Wireable) method.

Constructor Summary

Constructors

Constructor and Description
TinyBus()
TinyBus(android.content.Context context)

Method Summary

Modifier and Type	Method and Description
void	cancelDelayed(java.lang.Class<?> eventClass) Removes a pending event of given type from delivery queue.
static TinyBus	from(android.content.Context context) Use this method to get a bus instance bound to the given context.
TinyBusDepot.LifecycleCallbacks	getLifecycleCallbacks()
boolean	hasRegistered(java.lang.Object obj) Checks whether given object is currently registered in the bus.
boolean	hasWireable(java.lang.Class<? extends TinyBus.Wireable> wireClass)
void	post(java.lang.Object event) Posts an event to all registered handlers.
void	postDelayed(java.lang.Object event, long delayMillis) Causes the event to be posted to the bus after the specified amount of time elapses.
void	register(java.lang.Object obj) Registers all handler methods on object to receive events and producer methods to provide events.
void	unregister(java.lang.Object obj) Unregisters all producer and handler methods on a registered object.
<T extends TinyBus.Wireable> T	unwire(java.lang.Class<T> wireClass)
TinyBus	wire(TinyBus.Wireable wireable)

Methods inherited from class java.lang.Object

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

Constructor Detail

TinyBus

public TinyBus()

TinyBus

public TinyBus(android.content.Context context)

Method Detail

from

public static TinyBus from(android.content.Context context)

Use this method to get a bus instance bound to the given context. If instance does not yet exist in the context, a new instance will be created. Otherwise existing instance gets returned.

Bus instance can be bound to a context.

If you need a singleton instance existing only once for the whole application, provide application context here. This option can be chosen for Activity to Service communication.

If you need a bus instance per Activity, you have to provide activity context in there. This option is perfect for Activity to Fragment or Fragment to Fragment communication.

Bus instance gets destroyed when your context is destroyed.

Parameters:

context - context to which this instance of bus has to be bound

Returns:

event bus instance, never null

register

public void register(java.lang.Object obj)

Description copied from interface: Bus

Registers all handler methods on object to receive events and producer methods to provide events.

If any subscribers are registering for types which already have a producer they will be called immediately with the result of calling that producer.

If any producers are registering for types which already have subscribers, each subscriber will be called with the value from the result of calling the producer.

Specified by:

register in interface Bus

Parameters:

obj - object whose handler methods should be registered.

unregister

public void unregister(java.lang.Object obj)

Description copied from interface: Bus

Unregisters all producer and handler methods on a registered object.

Specified by:

unregister in interface Bus

Parameters:

obj - object whose producer and handler methods should be unregistered.

hasRegistered

public boolean hasRegistered(java.lang.Object obj)

Description copied from interface: Bus

Checks whether given object is currently registered in the bus.

In most cases, when you (un)register objects inside standard onStart() and onStop() lifecycle callbacks, you don't need this method at all. But in some more trickier cases, when you (un)register objects depending on some other conditions, this method can be very helpful.

Specified by:

hasRegistered in interface Bus

Parameters:

obj - the object to check

Returns:

true if object is registered or false otherwise

post

public void post(java.lang.Object event)

Description copied from interface: Bus

Posts an event to all registered handlers. This method will return successfully after the event has been posted to all handlers if there was no exceptions thrown by handlers. Exceptions in handlers are wrapper with a RuntimeException and re-thrown.

Specified by:

post in interface Bus

Parameters:

event - event to post.

postDelayed

public void postDelayed(java.lang.Object event,
                        long delayMillis)

Description copied from interface: Bus

Causes the event to be posted to the bus after the specified amount of time elapses. Only one event of same type can be delayed. If another event of same type is already pending for delivery, then the bus will replace old event with the new one and reschedule it with the new delay value.

Note that the time-base is SystemClock.uptimeMillis(). This means the time spent in deep sleep will add an additional delay to execution.

Specified by:

postDelayed in interface Bus

Parameters:

event - event to be posted

delayMillis - delay (in milliseconds) until the event will be executed

cancelDelayed

public void cancelDelayed(java.lang.Class<?> eventClass)

Description copied from interface: Bus

Removes a pending event of given type from delivery queue.

Specified by:

cancelDelayed in interface Bus

Parameters:

eventClass - event type of event to be cancelled

wire

public TinyBus wire(TinyBus.Wireable wireable)

unwire

public <T extends TinyBus.Wireable> T unwire(java.lang.Class<T> wireClass)

hasWireable

public boolean hasWireable(java.lang.Class<? extends TinyBus.Wireable> wireClass)

getLifecycleCallbacks

public TinyBusDepot.LifecycleCallbacks getLifecycleCallbacks()