Package org.springframework.modulith.test

Interface PublishedEvents.TypedPublishedEvents<T>

Type Parameters:

T - the event type

All Superinterfaces:

Iterable<T>, TypedEvents

Enclosing interface:

PublishedEvents

public static interface PublishedEvents.TypedPublishedEvents<T>
extends Iterable<T>, TypedEvents

All application events of a given type that were fired during a test execution.

Author:

Oliver Drotbohm

Method Summary

Modifier and Type	Method	Description
<S> PublishedEvents.TypedPublishedEvents<T>	matching(Function<T,S> mapper, @Nullable S value)	Deprecated, for removal: This API element is subject to removal in a future version. use matchingValue(Function, Object) instead.
<S> PublishedEvents.TypedPublishedEvents<T>	matching(Function<T,S> mapper, Predicate<? super S> predicate)	Returns all PublishedEvents.TypedPublishedEvents that match the given predicate after applying the given mapping step.
PublishedEvents.TypedPublishedEvents<T>	matching(Predicate<? super T> predicate)	Returns all PublishedEvents.TypedPublishedEvents that match the given predicate.
default <S> PublishedEvents.TypedPublishedEvents<T>	matchingMapped(Function<T,S> mapper, Predicate<? super S> predicate)	Deprecated, for removal: This API element is subject to removal in a future version. since 0.3, use matching(Function, Predicate) instead.
<S> PublishedEvents.TypedPublishedEvents<T>	matchingValue(Function<T,S> mapper, @Nullable S value)	Returns all PublishedEvents.TypedPublishedEvents that match the given value after applying the given mapping step.
default <S extends T> PublishedEvents.TypedPublishedEvents<S>	ofSubType(Class<S> subType)	Further constrain the event type for downstream assertions.
<S> PublishedEvents.TypedPublishedEvents<S>	ofType(Class<S> type)	Returns all events of the given type.

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Methods inherited from interface org.springframework.modulith.test.TypedEvents

eventOfTypeWasPublished

Method Details

ofSubType

default <S extends T>
PublishedEvents.TypedPublishedEvents<S> ofSubType(Class<S> subType)

Further constrain the event type for downstream assertions.

Type Parameters:

S -

Parameters:

subType - the sub type

Returns:

will never be null.

ofType

<S> PublishedEvents.TypedPublishedEvents<S> ofType(Class<S> type)

Description copied from interface: TypedEvents

Returns all events of the given type.

Specified by:

ofType in interface TypedEvents

Type Parameters:

S - the event type

Parameters:

type - must not be null.

Returns:

matching

PublishedEvents.TypedPublishedEvents<T> matching(Predicate<? super T> predicate)

Returns all PublishedEvents.TypedPublishedEvents that match the given predicate.

Parameters:

predicate - must not be null.

Returns:

will never be null.

matching

<S> PublishedEvents.TypedPublishedEvents<T> matching(Function<T,S> mapper,
 Predicate<? super S> predicate)

Returns all PublishedEvents.TypedPublishedEvents that match the given predicate after applying the given mapping step.

Type Parameters:

S - the intermediate type to apply the Predicate on

Parameters:

mapper - the mapping step to extract a part of the original event subject to test for the Predicate. Must not be null.

predicate - the Predicate to apply on the value extracted. Must not be null.

Returns:

will never be null.

matching

@Deprecated(since="2.0",
            forRemoval=true)
<S> PublishedEvents.TypedPublishedEvents<T> matching(Function<T,S> mapper,
 @Nullable S value)

Deprecated, for removal: This API element is subject to removal in a future version.

use matchingValue(Function, Object) instead.

Returns all PublishedEvents.TypedPublishedEvents that match the given value after applying the given mapping step.

Type Parameters:

S - the intermediate type to apply the Predicate on

Parameters:

mapper - the mapping step to extract a part of the original event subject to verify against the given value, must not be null.

value - the value expected as outcome of the mapping step, can be null.

Returns:

will never be null.

matchingValue

<S> PublishedEvents.TypedPublishedEvents<T> matchingValue(Function<T,S> mapper,
 @Nullable S value)

Returns all PublishedEvents.TypedPublishedEvents that match the given value after applying the given mapping step.

Type Parameters:

S - the intermediate type to apply the Predicate on

Parameters:

mapper - the mapping step to extract a part of the original event subject to verify against the given value, must not be null.

value - the value expected as outcome of the mapping step, can be null.

Returns:

will never be null.

Since:

2.0

matchingMapped

@Deprecated(forRemoval=true,
            since="0.3")
default <S> PublishedEvents.TypedPublishedEvents<T> matchingMapped(Function<T,S> mapper,
 Predicate<? super S> predicate)

Deprecated, for removal: This API element is subject to removal in a future version.

since 0.3, use matching(Function, Predicate) instead.

Returns all PublishedEvents.TypedPublishedEvents that match the given predicate after applying the given mapping step.

Type Parameters:

S - the intermediate type to apply the Predicate on

Parameters:

mapper - the mapping step to extract a part of the original event subject to test for the Predicate.

predicate - the Predicate to apply on the value extracted.

Returns:

will never be null.