public class

SourceFilteringListener

extends Object
implements SmartApplicationListener
java.lang.Object
   ↳ org.springframework.context.event.SourceFilteringListener

Class Overview

ApplicationListener decorator that filters events from a specified event source, invoking its delegate listener for matching ApplicationEvent objects only.

Can also be used as base class, overriding the onApplicationEventInternal(ApplicationEvent) method instead of specifying a delegate listener.

Summary

[Expand]
Inherited Constants
From interface org.springframework.core.Ordered
Public Constructors
SourceFilteringListener(Object source, ApplicationListener delegate)
Create a SourceFilteringListener for the given event source.
Protected Constructors
SourceFilteringListener(Object source)
Create a SourceFilteringListener for the given event source, expecting subclasses to override the onApplicationEventInternal(ApplicationEvent) method (instead of specifying a delegate listener).
Public Methods
int getOrder()
Return the order value of this object, with a higher value meaning greater in terms of sorting.
void onApplicationEvent(ApplicationEvent event)
boolean supportsEventType(Class<? extends ApplicationEvent> eventType)
Determine whether this listener actually supports the given event type.
boolean supportsSourceType(Class<?> sourceType)
Determine whether this listener actually supports the given source type.
Protected Methods
void onApplicationEventInternal(ApplicationEvent event)
Actually process the event, after having filtered according to the desired event source already.
[Expand]
Inherited Methods
From class java.lang.Object
From interface org.springframework.context.ApplicationListener
From interface org.springframework.context.event.SmartApplicationListener
From interface org.springframework.core.Ordered

Public Constructors

public SourceFilteringListener (Object source, ApplicationListener delegate)

Create a SourceFilteringListener for the given event source.

Parameters
source the event source that this listener filters for, only processing events from this source
delegate the delegate listener to invoke with event from the specified source

Protected Constructors

protected SourceFilteringListener (Object source)

Create a SourceFilteringListener for the given event source, expecting subclasses to override the onApplicationEventInternal(ApplicationEvent) method (instead of specifying a delegate listener).

Parameters
source the event source that this listener filters for, only processing events from this source

Public Methods

public int getOrder ()

Return the order value of this object, with a higher value meaning greater in terms of sorting.

Normally starting with 0, with Integer.MAX_VALUE indicating the greatest value. Same order values will result in arbitrary positions for the affected objects.

Higher values can be interpreted as lower priority. As a consequence, the object with the lowest value has highest priority (somewhat analogous to Servlet "load-on-startup" values).

Returns
  • the order value

public void onApplicationEvent (ApplicationEvent event)

public boolean supportsEventType (Class<? extends ApplicationEvent> eventType)

Determine whether this listener actually supports the given event type.

public boolean supportsSourceType (Class<?> sourceType)

Determine whether this listener actually supports the given source type.

Protected Methods

protected void onApplicationEventInternal (ApplicationEvent event)

Actually process the event, after having filtered according to the desired event source already.

The default implementation invokes the specified delegate, if any.

Parameters
event the event to process (matching the specified source)