org.vaadin.spring.events.annotation

Annotation Type EventBusListenerMethod

@Target(value=METHOD)
 @Retention(value=RUNTIME)
 @Documented
public @interface EventBusListenerMethod

Annotation to be placed on event bus listener methods. A listener method must always conform to one of the following method signatures:

1. myMethodName(Event<MyPayloadType>)
2. myMethodName(MyPayloadType)

A listener method can have any visibility and any return type.

Author:

Petter Holmström (petter@vaadin.com)

See Also:

EventBusListener, EventBus.subscribe(Object), EventBus.subscribe(Object, boolean)

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Class<? extends EventBusListenerMethodFilter>	filter
EventScope	scope The default scope of a listener method is EventScope.UNDEFINED This means that listener will listen for any EventScope if EventBus.subscribe(EventBusListener, boolean) is set to propagate event

Element Detail

scope

public abstract EventScope scope

The default scope of a listener method is EventScope.UNDEFINED This means that listener will listen for any EventScope if EventBus.subscribe(EventBusListener, boolean) is set to propagate event

Default:

org.vaadin.spring.events.EventScope.UNDEFINED

filter

public abstract Class<? extends EventBusListenerMethodFilter> filter

Default:

org.vaadin.spring.events.NoEventBusListenerMethodFilter.class