io.jmix.ui.sys.event

Class UiEventListenerMethodAdapter

java.lang.Object

io.jmix.ui.sys.event.UiEventListenerMethodAdapter

All Implemented Interfaces:

java.util.EventListener, org.springframework.context.ApplicationListener<org.springframework.context.ApplicationEvent>, org.springframework.context.event.GenericApplicationListener, org.springframework.context.event.SmartApplicationListener, org.springframework.core.Ordered

public class UiEventListenerMethodAdapter
extends java.lang.Object
implements org.springframework.context.event.GenericApplicationListener

Field Summary

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
UiEventListenerMethodAdapter(java.lang.Object instance, java.lang.Class<?> targetClass, java.lang.reflect.Method method, org.springframework.context.ApplicationEventPublisher applicationEventPublisher)

Method Summary

Modifier and Type	Method and Description
protected void	assertTargetBean(java.lang.reflect.Method method, java.lang.Object targetBean, java.lang.Object[] args) Assert that the target bean class is an instance of the class where the given method is declared.
protected java.lang.Object	doInvoke(java.lang.Object instance, java.lang.Object... args) Invoke the event listener method with the given argument values.
protected java.lang.String	getCondition() Return the condition to use.
protected java.lang.String	getDetailedErrorMessage(java.lang.Object bean, java.lang.String message) Add additional details such as the bean type and method signature to the given error message.
protected java.lang.String	getInvocationErrorMessage(java.lang.Object bean, java.lang.String message, java.lang.Object[] resolvedArgs)
int	getOrder()
protected org.springframework.core.ResolvableType	getResolvableType(org.springframework.context.ApplicationEvent event)
protected void	handleResult(java.lang.Object instance, java.lang.Object result)
void	onApplicationEvent(org.springframework.context.ApplicationEvent event)
void	processEvent(java.lang.Object instance, org.springframework.context.ApplicationEvent event) Process the specified ApplicationEvent, checking if the condition match and handling non-null result, if any.
protected void	publishEvent(java.lang.Object instance, java.lang.Object event)
protected java.lang.Object[]	resolveArguments(org.springframework.context.ApplicationEvent event) Resolve the method arguments to use for the specified ApplicationEvent.
protected java.util.List<org.springframework.core.ResolvableType>	resolveDeclaredEventTypes(java.lang.reflect.Method method, org.springframework.context.event.EventListener ann)
protected int	resolveOrder(java.lang.reflect.Method method)
protected boolean	shouldHandle(org.springframework.context.ApplicationEvent event, java.lang.Object[] args)
boolean	supportsEventType(org.springframework.core.ResolvableType eventType)
boolean	supportsSourceType(java.lang.Class<?> sourceType)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.context.event.GenericApplicationListener

supportsEventType

Methods inherited from interface org.springframework.context.event.SmartApplicationListener

getListenerId

Methods inherited from interface org.springframework.context.ApplicationListener

forPayload

Constructor Detail

UiEventListenerMethodAdapter

public UiEventListenerMethodAdapter(java.lang.Object instance,
                                    java.lang.Class<?> targetClass,
                                    java.lang.reflect.Method method,
                                    org.springframework.context.ApplicationEventPublisher applicationEventPublisher)

Method Detail

supportsEventType

public boolean supportsEventType(@Nonnull
                                 org.springframework.core.ResolvableType eventType)

Specified by:

supportsEventType in interface org.springframework.context.event.GenericApplicationListener

supportsSourceType

public boolean supportsSourceType(@Nullable
                                  java.lang.Class<?> sourceType)

Specified by:

supportsSourceType in interface org.springframework.context.event.SmartApplicationListener

onApplicationEvent

public void onApplicationEvent(@Nonnull
                               org.springframework.context.ApplicationEvent event)

Specified by:

onApplicationEvent in interface org.springframework.context.ApplicationListener<org.springframework.context.ApplicationEvent>

getOrder

public int getOrder()

Specified by:

getOrder in interface org.springframework.context.event.SmartApplicationListener

Specified by:

getOrder in interface org.springframework.core.Ordered

resolveDeclaredEventTypes

protected java.util.List<org.springframework.core.ResolvableType> resolveDeclaredEventTypes(java.lang.reflect.Method method,
                                                                                            @Nullable
                                                                                            org.springframework.context.event.EventListener ann)

resolveOrder

protected int resolveOrder(java.lang.reflect.Method method)

processEvent

public void processEvent(java.lang.Object instance,
                         org.springframework.context.ApplicationEvent event)

Process the specified ApplicationEvent, checking if the condition match and handling non-null result, if any.

resolveArguments

@Nullable
protected java.lang.Object[] resolveArguments(org.springframework.context.ApplicationEvent event)

Resolve the method arguments to use for the specified ApplicationEvent.

These arguments will be used to invoke the method handled by this instance. Can return null to indicate that no suitable arguments could be resolved and therefore the method should not be invoked at all for the specified event.

handleResult

protected void handleResult(java.lang.Object instance,
                            java.lang.Object result)

publishEvent

protected void publishEvent(java.lang.Object instance,
                            @Nullable
                            java.lang.Object event)

shouldHandle

protected boolean shouldHandle(org.springframework.context.ApplicationEvent event,
                               @Nullable
                               java.lang.Object[] args)

doInvoke

@Nullable
protected java.lang.Object doInvoke(java.lang.Object instance,
                                              @Nullable
                                              java.lang.Object... args)

Invoke the event listener method with the given argument values.

getCondition

@Nullable
protected java.lang.String getCondition()

Return the condition to use.

Matches the condition attribute of the EventListener annotation or any matching attribute on a composed annotation that is meta-annotated with @EventListener.

getDetailedErrorMessage

protected java.lang.String getDetailedErrorMessage(java.lang.Object bean,
                                                   java.lang.String message)

Add additional details such as the bean type and method signature to the given error message.

Parameters:

message - error message to append the HandlerMethod details to

assertTargetBean

protected void assertTargetBean(java.lang.reflect.Method method,
                                java.lang.Object targetBean,
                                @Nullable
                                java.lang.Object[] args)

Assert that the target bean class is an instance of the class where the given method is declared. In some cases the actual bean instance at event- processing time may be a JDK dynamic proxy (lazy initialization, prototype beans, and others). Event listener beans that require proxying should prefer class-based proxy mechanisms.

getInvocationErrorMessage

protected java.lang.String getInvocationErrorMessage(java.lang.Object bean,
                                                     java.lang.String message,
                                                     @Nullable
                                                     java.lang.Object[] resolvedArgs)

getResolvableType

@Nullable
protected org.springframework.core.ResolvableType getResolvableType(org.springframework.context.ApplicationEvent event)