Bus (tinybus 3.0.2 API)

All Known Implementing Classes:

TinyBus
```
public interface Bus
```
Dispatches events to listeners, and provides ways for listeners to register themselves.
The Bus allows publish-subscribe-style communication between components without requiring the components to explicitly register with one another (and thus be aware of each other). It is designed exclusively to replace traditional Android in-process event distribution using explicit registration or listeners. It is not a general-purpose publish-subscribe system, nor is it intended for interprocess communication.
Receiving Events
To receive events, an object should:
1. Expose a public method, known as the event handler, which accepts a single argument of the type of event desired;
2. Mark it with a Subscribe annotation;
3. Pass itself to an Bus instance's register(Object) method.
Posting Events
To post an event, simply provide the event object to the post(Object) method. The Bus instance will determine the type of event and route it to all registered listeners.
Events are routed to all subscribers registered for exactly this type of event. Event's class hierarchy is ignored.
When post is called, all registered subscribers for an event are run in sequence synchronously, so subscribers should be reasonably quick. If an event may trigger an extended process (such as a database load), spawn a thread or queue it for later.
You are allowed to post a new event while already handling an event inside a subscriber method. In this case the bus will finalize dispatching of current event first and then a new event will be dispatched.
Handler Methods
Event handler methods must accept only one argument: the event.
Handlers should not, in general, throw. If they do, the Bus will wrap the exception and re-throw it.
Producer Methods
Producer methods should accept no arguments and return their event type. When a subscriber is registered for a type that a producer is also already registered for, the subscriber will be called with the return value from the producer. Null values coming from producers are not dispatched to subscribers.
This class is not safe for concurrent use. It must be called from a single thread.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`cancelDelayed(java.lang.Class<?> eventClass)` Removes a pending event of given type from delivery queue.
`boolean`	`hasRegistered(java.lang.Object object)` Checks whether given object is currently registered in the bus.
`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 object)` Registers all handler methods on `object` to receive events and producer methods to provide events.
`void`	`unregister(java.lang.Object object)` Unregisters all producer and handler methods on a registered `object`.

- Method Detail
  - register
```
void register(java.lang.Object object)
```
    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.
    
    Parameters:
    
    object - object whose handler methods should be registered.
    
    Throws:
    
    java.lang.NullPointerException - if the object is null.
  - unregister
```
void unregister(java.lang.Object object)
```
    Unregisters all producer and handler methods on a registered object.
    
    Parameters:
    
    object - object whose producer and handler methods should be unregistered.
    
    Throws:
    
    java.lang.IllegalArgumentException - if the object was not previously registered.
    
    java.lang.NullPointerException - if the object is null.
  - post
```
void post(java.lang.Object event)
```
    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.
    
    Parameters:
    
    event - event to post.
    
    Throws:
    
    java.lang.NullPointerException - if the event is null.
  - hasRegistered
```
boolean hasRegistered(java.lang.Object object)
```
    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.
    
    Parameters:
    
    object - the object to check
    
    Returns:
    
    true if object is registered or false otherwise
  - postDelayed
```
void postDelayed(java.lang.Object event,
                 long delayMillis)
```
    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.
    
    Parameters:
    
    event - event to be posted
    
    delayMillis - delay (in milliseconds) until the event will be executed
  - cancelDelayed
```
void cancelDelayed(java.lang.Class<?> eventClass)
```
    Removes a pending event of given type from delivery queue.
    
    Parameters:
    
    eventClass - event type of event to be cancelled

Interface Bus

Receiving Events

Posting Events

Handler Methods

Producer Methods

Method Summary

Method Detail

register

unregister

post

hasRegistered

postDelayed

cancelDelayed