Class Events

java.lang.Object

org.microbean.event.Events

public class Events
extends Object

A utility class for working with events.

Author:

Laird Nelson

Constructor Summary

Constructors

Constructor	Description
Events(EventTypes eventTypes, Qualifiers qualifiers, EventTypeMatcher eventTypeMatcher, EventQualifiersMatcher eventQualifiersMatcher)	Creates a new Events.

Method Summary

Modifier and Type	Method	Description
final void	fire(TypeMirror typeArgumentSource, List<Attributes> attributes, Object event, ReferencesSelector rs)	Delivers ("fires") the supplied event to suitable EventListeners.
protected void	fire(EventListener<?, ? super Object> el, Object event, ReferencesSelector rs)	Delivers ("Fires") the supplied event to the supplied EventListener via its EventListener.eventReceived(Object, ReferencesSelector) method.

Methods inherited from class Object

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

Constructor Details

Events

public Events(EventTypes eventTypes,
 Qualifiers qualifiers,
 EventTypeMatcher eventTypeMatcher,
 EventQualifiersMatcher eventQualifiersMatcher)

Creates a new Events.

Parameters:

eventTypes - an EventTypes; must not be null

qualifiers - a Qualifiers; must not be null

eventTypeMatcher - an EventTypeMatcher; must not be null

eventQualifiersMatcher - an EventQualifiersMatcher; must not be null

Throws:

NullPointerException - if any argument is null

Method Details

fire

public final void fire(TypeMirror typeArgumentSource,
 List<Attributes> attributes,
 Object event,
 ReferencesSelector rs)

Delivers ("fires") the supplied event to suitable EventListeners.

A suitable EventListener is one whose EventListener.attributedType() method returns an AttributedType

Parameters:

typeArgumentSource - handwave here about the specified type and type argument substitution

attributes - a List of Attributes qualifying the event; must not be null

event - the event; must not be null

rs - a ReferencesSelector; used to find EventListener<?, ?> references; must not be null

Throws:

NullPointerException - if any argument is null

IllegalArgumentException - if typeArgumentSource is unsuitable

See Also:

• fire(EventListener, Object, ReferencesSelector)
• EventTypes.eventTypes(TypeMirror, Object)

fire

protected void fire(EventListener<?, ? super Object> el,
 Object event,
 ReferencesSelector rs)

Delivers ("Fires") the supplied event to the supplied EventListener via its EventListener.eventReceived(Object, ReferencesSelector) method.

The default implementation of this method behaves as if its body were exactly el.eventReceived(event, rs).

When this method is invoked by the fire(TypeMirror, List, Object, ReferencesSelector) method, it is guaranteed that the supplied EventListener is a suitable one for the supplied event.

Overrides of this method must not call the fire(TypeMirror, List, Object, ReferencesSelector) method, or an infinite loop may result.

Parameters:

el - an EventListener that has been determined to be suitable for the supplied event; must not be null

event - the event to deliver; must not be null

rs - a ReferencesSelector; must not be null

Throws:

NullPointerException - if any argument is null