EventBus (EventBus API)

java.lang.Object
- com.edeqa.eventbus.EventBus<T>

public class EventBus<T extends EntityHolder>
extends java.lang.Object

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface EventBus.Runner

Nested Classes
Modifier and Type	Class and Description
`static interface`	`EventBus.Runner`

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`DEFAULT_NAME`
`static EventBus.Runner`	`DEFAULT_RUNNER`
`static EventBus.Runner`	`RUNNER_MULTI_THREAD`
`static EventBus.Runner`	`RUNNER_SINGLE_THREAD`

Constructor Summary

Constructors
Constructor and Description

EventBus()

EventBus(java.lang.String eventBusName)

Constructors
Constructor and Description
`EventBus()`
`EventBus(java.lang.String eventBusName)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clear()` Will call `EntityHolder.finish()` on each holder before clear eventBus.
`static void`	`clearAll()` Will call `EntityHolder.finish()` on each holder before clear eventBus.
`static java.util.List<EventBus<? extends EntityHolder>>`	`fetchEventBusesList()` Collects and returns list of all defined event buses.
`java.util.List<T>`	`fetchHoldersList()` Collects and returns list of all holders registered in event bus.
`static EventBus<? extends EntityHolder>`	`getEventBus(java.lang.String eventBusName)`
`java.lang.String`	`getEventBusName()`
`T`	`getHolder(java.lang.String type)`
`java.util.Map<java.lang.String,T>`	`getHolders()` Returns the map of holders in event bus.
`static java.util.Map<java.lang.String,? extends EntityHolder>`	`getHolders(java.lang.String eventBusName)`
`java.util.List<? extends EntityHolder>`	`getHoldersList()`
`static java.util.List<? extends EntityHolder>`	`getHoldersList(java.lang.String eventBusName)`
`static EventBus<? extends EntityHolder>`	`getOrCreate()`
`static EventBus<? extends EntityHolder>`	`getOrCreate(java.lang.String eventBusName)`
`EventBus.Runner`	`getRunner()`
`static void`	`inspect(java.lang.String eventName)` Provides the possibility for deep inspection of event specified.
`void`	`post(java.lang.String eventName)` Events poster.
`void`	`post(java.lang.String eventName, java.lang.Object eventObject)` Events poster.
`static void`	`post(java.lang.String eventBusName, java.lang.String eventName, java.lang.Object eventObject)` Events poster.
`static void`	`postAll(java.lang.Runnable runnable)` Will post runnable to each holder in each event bus using the same queue as events.
`static void`	`postAll(java.lang.String eventName)` Will post runnable to each holder in each event bus defined.
`static void`	`postAll(java.lang.String eventName, java.lang.Object eventObject)` Will post event/object to each holder in each event bus defined.
`void`	`postRunnable(java.lang.Runnable runnable)` Will post runnable in the same queue with events.
`static void`	`postRunnable(java.lang.String eventBusName, java.lang.Runnable runnable)` Will post runnable in the same queue with events.
`void`	`register(T holder)` Registers the holder in event bus.
`T`	`registerIfAbsent(T holder)` Registers the holder in event bus only if it is not registered.
`void`	`registerOrUpdate(T holder)` Registers the holder in event bus or updates if it already exists.
`static void`	`setLoggingLevel(java.util.logging.Level loggingLevel)`
`static void`	`setMainRunner(EventBus.Runner runner)` Redefines the default runner and overrides runners in all existing buses.
`void`	`setRunner(EventBus.Runner runner)` Changes the runner for event bus.
`void`	`unregister(java.lang.String type)` Unregisters the holder from event bus by its type.
`void`	`unregister(T holder)` Unregisters the holder from event bus.
`void`	`update(T holder)` Updates the holder and keeps its order in the queue.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_NAME
```
public static final java.lang.String DEFAULT_NAME
```
    See Also:
    
    Constant Field Values
  - DEFAULT_RUNNER
```
public static final EventBus.Runner DEFAULT_RUNNER
```
  - RUNNER_MULTI_THREAD
```
public static final EventBus.Runner RUNNER_MULTI_THREAD
```
  - RUNNER_SINGLE_THREAD
```
public static final EventBus.Runner RUNNER_SINGLE_THREAD
```
- Constructor Detail
  - EventBus
```
public EventBus()
         throws java.util.TooManyListenersException
```
    Throws:
    
    java.util.TooManyListenersException
  - EventBus
```
public EventBus(java.lang.String eventBusName)
         throws java.util.TooManyListenersException
```
    Throws:
    
    java.util.TooManyListenersException
- Method Detail
  - clearAll
```
public static void clearAll()
```
    Will call EntityHolder.finish() on each holder before clear eventBus.
  - fetchEventBusesList
```
public static java.util.List<EventBus<? extends EntityHolder>> fetchEventBusesList()
```
    Collects and returns list of all defined event buses.
    
    Returns:
    
    list of event buses
  - getEventBus
```
public static EventBus<? extends EntityHolder> getEventBus(java.lang.String eventBusName)
```
  - getHolders
```
public static java.util.Map<java.lang.String,? extends EntityHolder> getHolders(java.lang.String eventBusName)
```
  - getHoldersList
```
public static java.util.List<? extends EntityHolder> getHoldersList(java.lang.String eventBusName)
```
  - setLoggingLevel
```
public static void setLoggingLevel(java.util.logging.Level loggingLevel)
```
  - getOrCreate
```
public static EventBus<? extends EntityHolder> getOrCreate()
```
  - getOrCreate
```
public static EventBus<? extends EntityHolder> getOrCreate(java.lang.String eventBusName)
```
  - inspect
```
public static void inspect(java.lang.String eventName)
```
    Provides the possibility for deep inspection of event specified.
    
    Parameters:
    
    eventName - any not empty event name, i.e. "event1"
  - post
```
public static void post(java.lang.String eventBusName,
                        java.lang.String eventName,
                        java.lang.Object eventObject)
```
    Events poster. Events will be posted to holders using EventBus.Runner.
    
    Parameters:
    
    eventBusName - name of event bus that must process this event
    
    eventName - any not empty event name, i.e. "event1"
    
    eventObject - any object that will be sent together with event name
  - postAll
```
public static void postAll(java.lang.String eventName,
                           java.lang.Object eventObject)
```
    Will post event/object to each holder in each event bus defined.
    
    Parameters:
    
    eventName - any not empty event name, i.e. "event1"
    
    eventObject - any object that will be sent together with event name
  - postAll
```
public static void postAll(java.lang.String eventName)
```
    Will post runnable to each holder in each event bus defined.
    
    Parameters:
    
    eventName - any not empty event name, i.e. "event1"
  - postAll
```
public static void postAll(java.lang.Runnable runnable)
```
    Will post runnable to each holder in each event bus using the same queue as events.
    
    Parameters:
    
    runnable - redefine Runnable
  - postRunnable
```
public static void postRunnable(java.lang.String eventBusName,
                                java.lang.Runnable runnable)
```
    Will post runnable in the same queue with events.
    
    Parameters:
    
    eventBusName - name of target event bus
    
    runnable - redefine Runnable
  - setMainRunner
```
public static void setMainRunner(EventBus.Runner runner)
```
    Redefines the default runner and overrides runners in all existing buses.
    
    Parameters:
    
    runner - EventBus.Runner, default value is DEFAULT_RUNNER.
  - clear
```
public void clear()
```
    Will call EntityHolder.finish() on each holder before clear eventBus.
  - fetchHoldersList
```
public java.util.List<T> fetchHoldersList()
```
    Collects and returns list of all holders registered in event bus.
    
    Returns:
    
    list of holders
  - getEventBusName
```
public java.lang.String getEventBusName()
```
  - getHolder
```
public T getHolder(java.lang.String type)
```
  - getHolders
```
public java.util.Map<java.lang.String,T> getHolders()
```
    Returns the map of holders in event bus.
  - getHoldersList
```
public java.util.List<? extends EntityHolder> getHoldersList()
```
  - getRunner
```
public EventBus.Runner getRunner()
```
  - setRunner
```
public void setRunner(EventBus.Runner runner)
```
    Changes the runner for event bus. Redefine the runner if you want to send events to android main thread. See details https://github.com/edeqa/eventbus
    
    Parameters:
    
    runner - EventBus.Runner, default value is DEFAULT_RUNNER.
  - post
```
public void post(java.lang.String eventName)
```
    Events poster. Events will be posted to holders using EventBus.Runner.
    
    Parameters:
    
    eventName - any not empty event name, i.e. "event1"
  - post
```
public void post(java.lang.String eventName,
                 java.lang.Object eventObject)
```
    Events poster. Events will be posted to holders using EventBus.Runner.
    
    Parameters:
    
    eventName - any not empty event name, i.e. "event1"
    
    eventObject - any object that will be sent together with event name
  - postRunnable
```
public void postRunnable(java.lang.Runnable runnable)
```
    Will post runnable in the same queue with events.
    
    Parameters:
    
    runnable - redefine Runnable
  - register
```
public void register(T holder)
```
    Registers the holder in event bus.
    
    Parameters:
    
    holder - must implement EntityHolder, may be an instance of AbstractEntityHolder
  - registerOrUpdate
```
public void registerOrUpdate(T holder)
```
    Registers the holder in event bus or updates if it already exists.
    
    Parameters:
    
    holder - must implement EntityHolder, may be an instance of AbstractEntityHolder
  - registerIfAbsent
```
public T registerIfAbsent(T holder)
```
    Registers the holder in event bus only if it is not registered.
    
    Parameters:
    
    holder - must implement EntityHolder, may be an instance of AbstractEntityHolder
    
    Returns:
    
    registered holder
  - update
```
public void update(T holder)
```
    Updates the holder and keeps its order in the queue.
    
    Parameters:
    
    holder - must implement EntityHolder, may be an instance of AbstractEntityHolder
  - unregister
```
public void unregister(java.lang.String type)
```
    Unregisters the holder from event bus by its type.
    
    Parameters:
    
    type - type
  - unregister
```
public void unregister(T holder)
```
    Unregisters the holder from event bus.
    
    Parameters:
    
    holder - must implement EntityHolder, may be an instance of AbstractEntityHolder

Class EventBus<T extends EntityHolder>

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_NAME

DEFAULT_RUNNER

RUNNER_MULTI_THREAD

RUNNER_SINGLE_THREAD

Constructor Detail

EventBus

EventBus

Method Detail

clearAll

fetchEventBusesList

getEventBus

getHolders

getHoldersList

setLoggingLevel

getOrCreate

getOrCreate

inspect

post

postAll

postAll

postAll

postRunnable

setMainRunner

clear

fetchHoldersList

getEventBusName

getHolder

getHolders

getHoldersList

getRunner

setRunner

post

post

postRunnable

register

registerOrUpdate

registerIfAbsent

update

unregister

unregister