roboguice.event
Class EventManager

java.lang.Object
  extended by roboguice.event.EventManager
Direct Known Subclasses:
EventManager.NullEventManager

public class EventManager
extends Object

Manager class handling the following: Registration of event observing methods: registerObserver() unregisterObserver() clear() Raising Events: fire() notifyWithResult()

Author:
Adam Tybor, John Ericksen

Nested Class Summary
static class EventManager.NullEventManager
           
static class EventManager.ObserverMethodListener<T>
           
 
Field Summary
protected  com.google.inject.Provider<android.content.Context> contextProvider
           
protected  Map<android.content.Context,Map<Class<?>,Set<EventListener<?>>>> registrations
           
 
Constructor Summary
EventManager()
           
 
Method Summary
 void clear(android.content.Context context)
          Clears all observers of the given context.
 void fire(android.content.Context context, Object event)
          Raises the event's class' event on the given context.
 void fire(Object event)
          Raises the event's class' event on the current context.
 boolean isEnabled()
           
<T> void
registerObserver(Class<T> event, EventListener listener)
          Register an observer EventListener with the current context (provided).
<T> void
registerObserver(android.content.Context context, Class<T> event, EventListener listener)
          Register the given EventListener to the contest and event class.
<T> void
registerObserver(android.content.Context context, Object instance, Method method, Class<T> event)
          Registers given method with provided context and event.
<T> void
registerObserver(Object instance, Method method, Class<T> event)
          Register a method observer with the current context (provided).
<T> void
unregisterObserver(Class<T> event, EventListener<T> listener)
          Unregister the given EventListener with the current context (provided).
<T> void
unregisterObserver(android.content.Context context, Class<T> event, EventListener<T> listener)
          Unregisters the provided event listener from the given event
<T> void
unregisterObserver(android.content.Context context, Object instance, Class<T> event)
          Unregister all methods observing the given event from the provided context.
<T> void
unregisterObserver(Object instance, Class<T> event)
          Unregister the given event from the current context (provided).
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

contextProvider

@Inject
protected com.google.inject.Provider<android.content.Context> contextProvider

registrations

protected Map<android.content.Context,Map<Class<?>,Set<EventListener<?>>>> registrations
Constructor Detail

EventManager

public EventManager()
Method Detail

isEnabled

public boolean isEnabled()

registerObserver

public <T> void registerObserver(Class<T> event,
                                 EventListener listener)
Register an observer EventListener with the current context (provided).

Type Parameters:
T - event type
Parameters:
event - to observe
listener - to be triggered

registerObserver

public <T> void registerObserver(Object instance,
                                 Method method,
                                 Class<T> event)
Register a method observer with the current context (provided).

Type Parameters:
T - event type
Parameters:
instance - to be called
method - to be called
event - observed

unregisterObserver

public <T> void unregisterObserver(Class<T> event,
                                   EventListener<T> listener)
Unregister the given EventListener with the current context (provided).

Type Parameters:
T - event type
Parameters:
event - observed
listener - to be unregistered

unregisterObserver

public <T> void unregisterObserver(Object instance,
                                   Class<T> event)
Unregister the given event from the current context (provided).

Type Parameters:
T - event type
Parameters:
instance - to be unregistered
event - observed

fire

public void fire(Object event)
Raises the event's class' event on the current context. This event object is passed (if configured) to the registered observer's method.

Parameters:
event - observed

registerObserver

public <T> void registerObserver(android.content.Context context,
                                 Class<T> event,
                                 EventListener listener)
Register the given EventListener to the contest and event class.

Type Parameters:
T - event type
Parameters:
context - associated with event
event - observed
listener - to be triggered

registerObserver

public <T> void registerObserver(android.content.Context context,
                                 Object instance,
                                 Method method,
                                 Class<T> event)
Registers given method with provided context and event.

Parameters:
context - associated with event
instance - to be called
method - to be called
event - observed

unregisterObserver

public <T> void unregisterObserver(android.content.Context context,
                                   Class<T> event,
                                   EventListener<T> listener)
Unregisters the provided event listener from the given event

Type Parameters:
T - event type
Parameters:
context - associated with event
event - observed
listener - to be unregistered

unregisterObserver

public <T> void unregisterObserver(android.content.Context context,
                                   Object instance,
                                   Class<T> event)
Unregister all methods observing the given event from the provided context.

Parameters:
context - associated with event
instance - to be unregistered
event - observed

clear

public void clear(android.content.Context context)
Clears all observers of the given context.

Parameters:
context - associated with event

fire

public void fire(android.content.Context context,
                 Object event)
Raises the event's class' event on the given context. This event object is passed (if configured) to the registered observer's method.

Parameters:
context - associated with event
event - observed


Copyright © 2011. All Rights Reserved.