org.axonframework.messaging.annotation

Class MultiHandlerDefinition

java.lang.Object

org.axonframework.messaging.annotation.MultiHandlerDefinition

All Implemented Interfaces:

HandlerDefinition

public class MultiHandlerDefinition
extends Object
implements HandlerDefinition

HandlerDefinition instance that delegates to multiple other instances, in the order provided. Also, it wraps the delegate with HandlerEnhancerDefinition.

Since:

3.3

Author:

Tyler Thrailkill, Milan Savic

Constructor Summary

Constructors

Constructor and Description
MultiHandlerDefinition(HandlerDefinition... delegates) Initializes an instance that delegates to the given delegates, in the order provided.
MultiHandlerDefinition(List<HandlerDefinition> delegates) Initializes an instance that delegates to the given delegates, in the order provided.
MultiHandlerDefinition(List<HandlerDefinition> delegates, HandlerEnhancerDefinition handlerEnhancerDefinition) Initializes an instance that delegates to the given delegates, in the order provided.

Method Summary

Modifier and Type	Method and Description
<T> Optional<MessageHandlingMember<T>>	createHandler(Class<T> declaringType, Executable executable, ParameterResolverFactory parameterResolverFactory) Create a MessageHandlingMember for the given executable method.
List<HandlerDefinition>	getDelegates() Returns the delegates of this instance, in the order they are evaluated to resolve parameters.
HandlerEnhancerDefinition	getHandlerEnhancerDefinition() Returns handler enhancer definition used to wrap handlers.
static MultiHandlerDefinition	ordered(HandlerDefinition... delegates) Creates a MultiHandlerDefinition instance with the given delegates, which are automatically ordered based on the @Priority annotation on their respective classes.
static MultiHandlerDefinition	ordered(HandlerEnhancerDefinition handlerEnhancerDefinition, HandlerDefinition... delegates) Creates a MultiHandlerDefinition instance with the given delegates, which are automatically ordered based on the @Priority annotation on their respective classes.
static MultiHandlerDefinition	ordered(List<HandlerDefinition> delegates) Creates a MultiHandlerDefinition instance with the given delegates, which are automatically ordered based on the @Priority annotation on their respective classes.
static MultiHandlerDefinition	ordered(List<HandlerDefinition> delegates, HandlerEnhancerDefinition handlerEnhancerDefinition) Creates a MultiHandlerDefinition instance with the given delegates, which are automatically ordered based on the @Priority annotation on their respective classes.

Methods inherited from class java.lang.Object

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

Constructor Detail

MultiHandlerDefinition

public MultiHandlerDefinition(HandlerDefinition... delegates)

Initializes an instance that delegates to the given delegates, in the order provided. Changes in the given array are not reflected in the created instance.

Parameters:

delegates - The handlerDefinitions providing the parameter values to use

MultiHandlerDefinition

public MultiHandlerDefinition(List<HandlerDefinition> delegates)

Initializes an instance that delegates to the given delegates, in the order provided. Changes in the given list are not reflected in the created instance.

Parameters:

delegates - The handlerDefinitions providing the parameter values to use

MultiHandlerDefinition

public MultiHandlerDefinition(List<HandlerDefinition> delegates,
                              HandlerEnhancerDefinition handlerEnhancerDefinition)

Initializes an instance that delegates to the given delegates, in the order provided. Changes in the given List are not reflected in the created instance.

Parameters:

delegates - The list of handlerDefinitions providing the parameter values to use

handlerEnhancerDefinition - The enhancer used to wrap the delegates

Method Detail

ordered

public static MultiHandlerDefinition ordered(HandlerDefinition... delegates)

Creates a MultiHandlerDefinition instance with the given delegates, which are automatically ordered based on the @Priority annotation on their respective classes. Classes with the same Priority are kept in the order as provided in the delegates. As an enhancer, ClasspathHandlerEnhancerDefinition is used.

If one of the delegates is a MultiHandlerDefinition itself, that factory's delegates are 'mixed' with the given delegates, based on their respective order.

Parameters:

delegates - The delegates to include in the factory

Returns:

an instance delegating to the given delegates

ordered

public static MultiHandlerDefinition ordered(HandlerEnhancerDefinition handlerEnhancerDefinition,
                                             HandlerDefinition... delegates)

Creates a MultiHandlerDefinition instance with the given delegates, which are automatically ordered based on the @Priority annotation on their respective classes. Classes with the same Priority are kept in the order as provided in the delegates. As an enhancer, provided one is used.

If one of the delegates is a MultiHandlerDefinition itself, that factory's delegates are 'mixed' with the given delegates, based on their respective order.

Parameters:

handlerEnhancerDefinition - The enhancer used to wrap the delegates

delegates - The delegates to include in the factory

Returns:

an instance delegating to the given delegates

ordered

public static MultiHandlerDefinition ordered(List<HandlerDefinition> delegates)

Creates a MultiHandlerDefinition instance with the given delegates, which are automatically ordered based on the @Priority annotation on their respective classes. Classes with the same Priority are kept in the order as provided in the delegates. As an enhancer, ClasspathHandlerEnhancerDefinition is used.

If one of the delegates is a MultiHandlerDefinition itself, that factory's delegates are 'mixed' with the given delegates, based on their respective order.

Parameters:

delegates - The delegates to include in the factory

Returns:

an instance delegating to the given delegates

ordered

public static MultiHandlerDefinition ordered(List<HandlerDefinition> delegates,
                                             HandlerEnhancerDefinition handlerEnhancerDefinition)

Creates a MultiHandlerDefinition instance with the given delegates, which are automatically ordered based on the @Priority annotation on their respective classes. Classes with the same Priority are kept in the order as provided in the delegates. As an enhancer, provided one is used.

If one of the delegates is a MultiHandlerDefinition itself, that factory's delegates are 'mixed' with the given delegates, based on their respective order.

Parameters:

delegates - The delegates to include in the factory

handlerEnhancerDefinition - The enhancer used to wrap the delegates

Returns:

an instance delegating to the given delegates

getDelegates

public List<HandlerDefinition> getDelegates()

Returns the delegates of this instance, in the order they are evaluated to resolve parameters.

Returns:

the delegates of this instance, in the order they are evaluated to resolve parameters

getHandlerEnhancerDefinition

public HandlerEnhancerDefinition getHandlerEnhancerDefinition()

Returns handler enhancer definition used to wrap handlers.

Returns:

handler enhancer definition

createHandler

public <T> Optional<MessageHandlingMember<T>> createHandler(@Nonnull
                                                            Class<T> declaringType,
                                                            @Nonnull
                                                            Executable executable,
                                                            @Nonnull
                                                            ParameterResolverFactory parameterResolverFactory)

Description copied from interface: HandlerDefinition

Create a MessageHandlingMember for the given executable method. Use the given parameterResolverFactory to resolve the method's parameters.

Specified by:

createHandler in interface HandlerDefinition

Type Parameters:

T - The type of the declaring object

Parameters:

declaringType - The type of object declaring the given executable method

executable - The method to inspect

parameterResolverFactory - Factory for a ParameterResolver of the method

Returns:

An optional containing the handler if the method is suitable, or an empty Nullable otherwise