Package org.axonframework.modelling.entity.child

Interface EntityChildMetamodel<C,P>

Type Parameters:

C - the type of the child entity

P - the type of the parent entity

All Superinterfaces:

EntityEvolver<P>

All Known Implementing Classes:

AbstractEntityChildMetamodel, ListEntityChildMetamodel, MapEntityChildMetamodel, SingleEntityChildMetamodel

public interface EntityChildMetamodel<C,P>
extends EntityEvolver<P>

Interface describing a child EntityMetamodel that can be handled in the context of its parent. Handling commands for this metamodel is done in the context of the parent. This metamodel resolves the child from the given parent and can then invoke the right child instance to handle the command.

Since:

5.0.0

Author:

Mitchell Herrijgers

Method Summary

Modifier and Type	Method	Description
boolean	canHandle(CommandMessage message, P parentEntity, ProcessingContext context)	Checks if this child can handle the given CommandMessage for the given parent entity, and a child entity is available to handle it.
EntityMetamodel<C>	entityMetamodel()	Returns the EntityMetamodel of the child entity this metamodel describes.
Class<C>	entityType()	Returns the Class of the child entity this metamodel describes.
MessageStream.Single<CommandResultMessage>	handle(CommandMessage message, P parentEntity, ProcessingContext context)	Handles the given CommandMessage for the given child entity, using the provided parent entity.
static <C, P> ListEntityChildMetamodel.Builder<C,P>	list(Class<P> parentClass, EntityMetamodel<C> metamodel)	Starts a builder for a list of child entities within the given parent entity type.
static <K, C, P> MapEntityChildMetamodel.Builder<K,C,P>	map(Class<P> parentClass, EntityMetamodel<C> metamodel)	Starts a builder for a map of child entities within the given parent entity type.
static <C, P> SingleEntityChildMetamodel.Builder<C,P>	single(Class<P> parentClass, EntityMetamodel<C> metamodel)	Starts a builder for a single child entity within the given parent entity type.
Set<QualifiedName>	supportedCommands()	Returns the set of all QualifiedNames that this metamodel supports for command handlers.

Methods inherited from interface org.axonframework.modelling.EntityEvolver

evolve

Method Details

supportedCommands

Set<QualifiedName> supportedCommands()

Returns the set of all QualifiedNames that this metamodel supports for command handlers.

Returns:

a set of QualifiedName instances representing the supported command names

canHandle

boolean canHandle(CommandMessage message,
 P parentEntity,
 ProcessingContext context)

Checks if this child can handle the given CommandMessage for the given parent entity, and a child entity is available to handle it.

Parameters:

message - the CommandMessage to check

parentEntity - the parent entity instance to check against

context - the ProcessingContext for the command

Returns:

true if this child can handle the command, false otherwise

handle

MessageStream.Single<CommandResultMessage> handle(CommandMessage message,
 P parentEntity,
 ProcessingContext context)

Handles the given CommandMessage for the given child entity, using the provided parent entity.

Parameters:

message - the CommandMessage to handle

parentEntity - the child entity instance to handle the command for

context - the ProcessingContext for the command

Returns:

the result of the command handling, which may be a CommandResultMessage or an error message

entityType

Class<C> entityType()

Returns the Class of the child entity this metamodel describes.

Returns:

the Class of the child entity this metamodel describes

entityMetamodel

EntityMetamodel<C> entityMetamodel()

Returns the EntityMetamodel of the child entity this metamodel describes.

Returns:

the EntityMetamodel of the child entity this metamodel describes

single

static <C,
P>
SingleEntityChildMetamodel.Builder<C,P> single(Class<P> parentClass,
 EntityMetamodel<C> metamodel)

Starts a builder for a single child entity within the given parent entity type.

Type Parameters:

C - the type of the child entity

P - the type of the parent entity

Parameters:

parentClass - the class of the parent entity

metamodel - the EntityMetamodel of the child entity

Returns:

a SingleEntityChildMetamodel.Builder for the child entity.

list

static <C,
P> ListEntityChildMetamodel.Builder<C,P> list(Class<P> parentClass,
 EntityMetamodel<C> metamodel)

Starts a builder for a list of child entities within the given parent entity type.

Type Parameters:

C - the type of the child entity

P - the type of the parent entity

Parameters:

parentClass - the class of the parent entity

metamodel - the EntityMetamodel of the child entity

Returns:

a ListEntityChildMetamodel.Builder for the child entity

map

static <K,
C,
P>
MapEntityChildMetamodel.Builder<K,C,P> map(Class<P> parentClass,
 EntityMetamodel<C> metamodel)

Starts a builder for a map of child entities within the given parent entity type.

Type Parameters:

K - the type of the key of the Map containing the child entities

C - the type of the child entity

P - the type of the parent entity

Parameters:

parentClass - the class of the parent entity

metamodel - the EntityMetamodel of the child entity

Returns:

a MapEntityChildMetamodel.Builder for the child entity