org.springframework.context.event

Annotation Type EventListener



  • @Target(value={METHOD,ANNOTATION_TYPE})
     @Retention(value=RUNTIME)
     @Documented
    public @interface EventListener
    Annotation that marks a method as a listener for application events.

    If an annotated method supports a single event type, the method may declare a single parameter that reflects the event type to listen to. If an annotated method supports multiple event types, this annotation may refer to one or more supported event types using the classes attribute. See the classes() javadoc for further details.

    Events can be ApplicationEvent instances as well as arbitrary objects.

    Processing of @EventListener annotations is performed via the internal EventListenerMethodProcessor bean which gets registered automatically when using Java config or manually via the <context:annotation-config/> or <context:component-scan/> element when using XML config.

    Annotated methods may have a non-void return type. When they do, the result of the method invocation is sent as a new event. If the return type is either an array or a collection, each element is sent as a new individual event.

    It is also possible to define the order in which listeners for a certain event are to be invoked. To do so, add Spring's common @Order annotation alongside this event listener annotation.

    While it is possible for an event listener to declare that it throws arbitrary exception types, any checked exceptions thrown from an event listener will be wrapped in an UndeclaredThrowableException since the event publisher can only handle runtime exceptions.

    Since:
    4.2
    Author:
    Stephane Nicoll
    See Also:
    EventListenerMethodProcessor
    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element and Description
      java.lang.Class<?>[] classes
      The event classes that this listener handles.
      java.lang.String condition
      Spring Expression Language (SpEL) attribute used for making the event handling conditional.
      java.lang.Class<?>[] value
      Alias for classes().
    • Element Detail

      • classes

        @AliasFor(value="value")
        public abstract java.lang.Class<?>[] classes
        The event classes that this listener handles.

        If this attribute is specified with a single value, the annotated method may optionally accept a single parameter. However, if this attribute is specified with multiple values, the annotated method must not declare any parameters.

        Default:
        {}
      • condition

        public abstract java.lang.String condition
        Spring Expression Language (SpEL) attribute used for making the event handling conditional.

        Default is "", meaning the event is always handled.

        The SpEL expression evaluates against a dedicated context that provides the following meta-data:

        • #root.event, #root.args for references to the ApplicationEvent and method arguments respectively.
        • Method arguments can be accessed by index. For instance the first argument can be accessed via #root.args[0], #p0 or #a0. Arguments can also be accessed by name if that information is available.
        Default:
        ""