com.google.web.bindery.event.shared.testing

Class CountingEventBus

java.lang.Object

com.google.web.bindery.event.shared.EventBus

com.google.web.bindery.event.shared.testing.CountingEventBus

public class CountingEventBus
extends EventBus

Wraps an EventBus to keep a count of registered handlers and how many times events have fired. Handy for tests.

Constructor Summary

Constructors

Constructor and Description
CountingEventBus()
CountingEventBus(EventBus wrapped)

Method Summary

Methods

Modifier and Type	Method and Description
<H> HandlerRegistration	addHandler(Event.Type<H> type, H handler) Adds an unfiltered handler to receive events of this type from all sources.
<H> HandlerRegistration	addHandlerToSource(Event.Type<H> type, Object source, H handler) Adds a handler to receive events of this type from the given source.
void	fireEvent(Event<?> event) Fires the event from no source.
void	fireEventFromSource(Event<?> event, Object source) Fires the given event to the handlers listening to the event's type.
int	getCount(Event.Type<?> type) Deprecated. Please use getHandlerCount.
int	getFiredCount(Event.Type<?> type) How many events have fired for the given type.
int	getFiredCountFromSource(Event.Type<?> type, Object source) How many events have fired for the given pairing of type and source.
int	getHandlerCount(Event.Type<?> type) How many handlers are registered for the given type.

Methods inherited from class com.google.web.bindery.event.shared.EventBus

dispatchEvent, setSourceOfEvent

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, toString

Constructor Detail

CountingEventBus

public CountingEventBus()

CountingEventBus

public CountingEventBus(EventBus wrapped)

Method Detail

addHandler

public <H> HandlerRegistration addHandler(Event.Type<H> type,
                                 H handler)

Description copied from class: EventBus

Adds an unfiltered handler to receive events of this type from all sources.

It is rare to call this method directly. More typically an Event subclass will provide a static register method, or a widget will accept handlers directly.

Specified by:

addHandler in class EventBus

Type Parameters:

H - The type of handler

Parameters:

type - the event type associated with this handler

handler - the handler

Returns:

the handler registration, can be stored in order to remove the handler later

addHandlerToSource

public <H> HandlerRegistration addHandlerToSource(Event.Type<H> type,
                                         Object source,
                                         H handler)

Description copied from class: EventBus

Adds a handler to receive events of this type from the given source.

It is rare to call this method directly. More typically a Event subclass will provide a static register method, or a widget will accept handlers directly.

Specified by:

addHandlerToSource in class EventBus

Type Parameters:

H - The type of handler

Parameters:

type - the event type associated with this handler

source - the source associated with this handler

handler - the handler

Returns:

the handler registration, can be stored in order to remove the handler later

fireEvent

public void fireEvent(Event<?> event)

Description copied from class: EventBus

Fires the event from no source. Only unfiltered handlers will receive it.

Any exceptions thrown by handlers will be bundled into a UmbrellaException and then re-thrown after all handlers have completed. An exception thrown by a handler will not prevent other handlers from executing.

Specified by:

fireEvent in class EventBus

Parameters:

event - the event to fire

fireEventFromSource

public void fireEventFromSource(Event<?> event,
                       Object source)

Description copied from class: EventBus

Fires the given event to the handlers listening to the event's type.

Any exceptions thrown by handlers will be bundled into a UmbrellaException and then re-thrown after all handlers have completed. An exception thrown by a handler will not prevent other handlers from executing.

Specified by:

fireEventFromSource in class EventBus

Parameters:

event - the event to fire

getCount

public int getCount(Event.Type<?> type)

Deprecated. Please use getHandlerCount.

How many handlers are registered for the given type.

getFiredCount

public int getFiredCount(Event.Type<?> type)

How many events have fired for the given type. These events may not have been passed to any handlers.

getFiredCountFromSource

public int getFiredCountFromSource(Event.Type<?> type,
                          Object source)

How many events have fired for the given pairing of type and source. These events may not have been passed to any handlers.

getHandlerCount

public int getHandlerCount(Event.Type<?> type)

How many handlers are registered for the given type.