Package org.axonframework.modelling.annotation

Class AnnotationBasedEntityEvolvingComponent<E>

java.lang.Object

org.axonframework.modelling.annotation.AnnotationBasedEntityEvolvingComponent<E>

Type Parameters:

E - The entity type to evolve.

All Implemented Interfaces:

EntityEvolver<E>, EntityEvolvingComponent<E>

public class AnnotationBasedEntityEvolvingComponent<E>
extends Object
implements EntityEvolvingComponent<E>

Implementation of the EntityEvolvingComponent that applies state changes through EventHandler(-meta)-annotated methods using the AnnotatedHandlerInspector.

Since:

5.0.0

Author:

Mateusz Nowak

See Also:

• AnnotatedHandlerInspector

Constructor Summary

Constructors

Constructor	Description
AnnotationBasedEntityEvolvingComponent(Class<E> entityType, AnnotatedHandlerInspector<E> inspector, EventConverter converter, MessageTypeResolver messageTypeResolver)	Initialize a new annotation-based EntityEvolver.
AnnotationBasedEntityEvolvingComponent(Class<E> entityType, EventConverter converter, MessageTypeResolver messageTypeResolver)	Initialize a new annotation-based EntityEvolver.

Method Summary

Modifier and Type	Method	Description
E	evolve(E entity, EventMessage event, ProcessingContext context)	Evolve the given entity by applying the given event to it.
Set<QualifiedName>	supportedEvents()	All supported events, referenced through a QualifiedName.

Methods inherited from class java.lang.Object

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

Constructor Details

AnnotationBasedEntityEvolvingComponent

public AnnotationBasedEntityEvolvingComponent(@Nonnull
 Class<E> entityType,
 @Nonnull
 EventConverter converter,
 @Nonnull
 MessageTypeResolver messageTypeResolver)

Initialize a new annotation-based EntityEvolver.

Parameters:

entityType - The type of entity this instance will handle state changes for.

converter - The converter to use for converting event payloads to the handler's expected type.

messageTypeResolver - The resolver to use for resolving the event message type.

AnnotationBasedEntityEvolvingComponent

public AnnotationBasedEntityEvolvingComponent(@Nonnull
 Class<E> entityType,
 @Nonnull
 AnnotatedHandlerInspector<E> inspector,
 @Nonnull
 EventConverter converter,
 @Nonnull
 MessageTypeResolver messageTypeResolver)

Initialize a new annotation-based EntityEvolver.

Parameters:

entityType - The type of entity this instance will handle state changes for.

inspector - The inspector to use to find the annotated handlers on the entity.

converter - The converter to use for converting event payloads to the handler's expected type.

messageTypeResolver - The resolver to use for resolving the event message type.

Method Details

evolve

public E evolve(@Nonnull
 E entity,
 @Nonnull
 EventMessage event,
 @Nonnull
 ProcessingContext context)

Description copied from interface: EntityEvolver

Evolve the given entity by applying the given event to it.

Specified by:

evolve in interface EntityEvolver<E>

Parameters:

entity - The current entity to evolve with the given event.

event - The event that might adjust the entity.

context - The context within which to evolve the entity by the given event.

Returns:

The evolved entity based on the given event, or the same entity when nothing happened.

supportedEvents

@Nonnull
public Set<QualifiedName> supportedEvents()

Description copied from interface: EntityEvolvingComponent

All supported events, referenced through a QualifiedName.

Specified by:

supportedEvents in interface EntityEvolvingComponent<E>

Returns:

All supported events, referenced through a QualifiedName.