Package com.vaadin.flow.component
Class ComponentEventBusUtil
- java.lang.Object
-
- com.vaadin.flow.component.ComponentEventBusUtil
-
public class ComponentEventBusUtil extends Object
Static helpers and caching functionality forComponentEventBus
.- Since:
- 1.0
- Author:
- Vaadin Ltd
-
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static <T extends ComponentEvent<?>>
Constructor<T>getEventConstructor(Class<T> eventType)
Gets the constructor to use for firing a component event, of the given type, based on a DOM event.static LinkedHashMap<String,Class<?>>
getEventDataExpressions(Class<? extends ComponentEvent<?>> eventType)
Gets a map of event data expression (forDomListenerRegistration.addEventData(String)
) to Java type, with the same order as the parameters for the event constructor (as returned bygetEventConstructor(Class)
).static boolean
isDomEventConstructor(Constructor<?> constructor)
Checks if the given constructor can be used when firing aComponentEvent
based on aDomEvent
.
-
-
-
Method Detail
-
getEventDataExpressions
public static LinkedHashMap<String,Class<?>> getEventDataExpressions(Class<? extends ComponentEvent<?>> eventType)
Gets a map of event data expression (forDomListenerRegistration.addEventData(String)
) to Java type, with the same order as the parameters for the event constructor (as returned bygetEventConstructor(Class)
).Caches values and automatically uses the cached values when available.
- Parameters:
eventType
- the component event type- Returns:
- a map of event expressions, ordered in constructor parameter order
-
getEventConstructor
public static <T extends ComponentEvent<?>> Constructor<T> getEventConstructor(Class<T> eventType)
Gets the constructor to use for firing a component event, of the given type, based on a DOM event.- Type Parameters:
T
- the event type- Parameters:
eventType
- the event type- Returns:
- the constructor to use when creating an event from a DOM event
- Throws:
IllegalArgumentException
- if no suitable constructor was found
-
isDomEventConstructor
public static boolean isDomEventConstructor(Constructor<?> constructor)
Checks if the given constructor can be used when firing aComponentEvent
based on aDomEvent
.- Parameters:
constructor
- the constructor to check- Returns:
true
if the constructor can be used,false
otherwise
-
-