Package org.springframework.modulith.events

Class EventExternalizationConfiguration.Selector

java.lang.Object

org.springframework.modulith.events.EventExternalizationConfiguration.Selector

Enclosing interface:

EventExternalizationConfiguration

public static class EventExternalizationConfiguration.Selector
extends Object

API to define which events are supposed to be selected for externalization.

Since:

1.1

Author:

Oliver Drotbohm

Constructor Summary

Constructors

Constructor	Description
Selector()	Creates a new EventExternalizationConfiguration.Selector.

Method Summary

Modifier and Type	Method	Description
EventExternalizationConfiguration.Router	select(Predicate<Object> predicate)	Selects events to externalize by applying the given Predicate.
<T extends Annotation> EventExternalizationConfiguration.Router	selectAndRoute(Class<T> annotationType, BiFunction<Object,T,RoutingTarget> router)	Selects events by the presence of an annotation of the given type and routes based on the given router BiFunction that also gets the event type to build up a complete RoutingTarget.
<T extends Annotation> EventExternalizationConfiguration.Router	selectAndRoute(Class<T> annotationType, Function<T,String> router)	Selects events by the presence of an annotation of the given type and routes based on the given router Function.
EventExternalizationConfiguration.Router	selectByAnnotation(Class<? extends Annotation> type)	Selects events to be externalized by inspecting the event type for the given annotation.
EventExternalizationConfiguration.Router	selectByPackage(Class<?> type)	Selects events to externalize by the package of the given type and all sub-packages.
EventExternalizationConfiguration.Router	selectByPackage(String basePackage)	Selects events to externalize by the given base package and all sub-packages.
EventExternalizationConfiguration.Router	selectByPackagesAndFilter(Collection<String> basePackages, Predicate<Object> filter)	Selects events to externalize by the given base packages (and their sub-packages) that match the given filter Predicate.
EventExternalizationConfiguration.Router	selectByType(Class<?> type)	Selects events to be externalized by type.
EventExternalizationConfiguration.Router	selectByType(Predicate<Class<?>> predicate)	Selects events to be externalized by the given Predicate.

Methods inherited from class java.lang.Object

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

Constructor Details

Selector

Selector()

Creates a new EventExternalizationConfiguration.Selector.

Method Details

select

public EventExternalizationConfiguration.Router select(Predicate<Object> predicate)

Selects events to externalize by applying the given Predicate.

Parameters:

predicate - will never be null.

Returns:

will never be null.

selectByPackage

public EventExternalizationConfiguration.Router selectByPackage(String basePackage)

Selects events to externalize by the given base package and all sub-packages.

Parameters:

basePackage - must not be null or empty.

Returns:

will never be null.

selectByPackage

public EventExternalizationConfiguration.Router selectByPackage(Class<?> type)

Selects events to externalize by the package of the given type and all sub-packages.

Parameters:

type - must not be null.

Returns:

will never be null.

selectByPackagesAndFilter

public EventExternalizationConfiguration.Router selectByPackagesAndFilter(Collection<String> basePackages,
 Predicate<Object> filter)

Selects events to externalize by the given base packages (and their sub-packages) that match the given filter Predicate.

Parameters:

basePackages - must not be null or empty.

filter - must not be null.

Returns:

will never be null.

selectByAnnotation

public EventExternalizationConfiguration.Router selectByAnnotation(Class<? extends Annotation> type)

Selects events to be externalized by inspecting the event type for the given annotation.

Parameters:

type - the annotation type to find on the event type, must not be null.

Returns:

will never be null.

selectByType

public EventExternalizationConfiguration.Router selectByType(Class<?> type)

Selects events to be externalized by type.

Parameters:

type - the type that events to be externalized need to implement, must not be null.

Returns:

will never be null.

selectByType

public EventExternalizationConfiguration.Router selectByType(Predicate<Class<?>> predicate)

Selects events to be externalized by the given Predicate.

Parameters:

predicate - must not be null.

Returns:

will never be null.

selectAndRoute

public <T extends Annotation>
EventExternalizationConfiguration.Router selectAndRoute(Class<T> annotationType,
 Function<T,String> router)

Selects events by the presence of an annotation of the given type and routes based on the given router Function.

Type Parameters:

T - the annotation type.

Parameters:

annotationType - the annotation type, must not be null.

router - must not be null.

Returns:

will never be null.

selectAndRoute

public <T extends Annotation>
EventExternalizationConfiguration.Router selectAndRoute(Class<T> annotationType,
 BiFunction<Object,T,RoutingTarget> router)

Selects events by the presence of an annotation of the given type and routes based on the given router BiFunction that also gets the event type to build up a complete RoutingTarget.

Type Parameters:

T - the annotation type.

Parameters:

annotationType - must not be null.

router - must not be null.

Returns:

will never be null.