Package org.axonframework.messaging.core

Interface MessageTypeResolver

All Known Implementing Classes:

AnnotationMessageTypeResolver, ClassBasedMessageTypeResolver, HierarchicalMessageTypeResolver, NamespaceMessageTypeResolver, StructuralAwareMessageTypeResolver

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface MessageTypeResolver

Functional interface describing a resolver from Message payload to it's type. Used to set the type when putting the given payload on its respective bus.

Since:

5.0.0

Author:

Allard Buijze, Mitchell Herrijgers, Steven van Beelen

Method Summary

Modifier and Type	Method	Description
Optional<MessageType>	resolve(Class<?> payloadType)	Resolves a type for the given payloadType.
default Optional<MessageType>	resolve(Object payload)	Resolves a type for the given payload.
default MessageType	resolveOrThrow(Class<?> payloadType)	Resolves a type for the given payloadType.
default MessageType	resolveOrThrow(Object payload)	Resolves a type for the given payload.

Method Details

resolveOrThrow

default MessageType resolveOrThrow(Object payload)

Resolves a type for the given payload. If the given payload is already a Message implementation, the Message Type is returned.

Parameters:

payload - The Message payload to resolve a type for.

Returns:

The type for the given payload.

Throws:

MessageTypeNotResolvedException - if the type could not be resolved.

resolveOrThrow

default MessageType resolveOrThrow(Class<?> payloadType)

Resolves a type for the given payloadType.

Parameters:

payloadType - The type of the Message payload to resolve a type for.

Returns:

The type for the given payloadType.

Throws:

MessageTypeNotResolvedException - if the type could not be resolved.

resolve

default Optional<MessageType> resolve(Object payload)

Resolves a type for the given payload. If the given payload is already a Message implementation, the Message Type is returned.

This method returns an Optional that will be empty if the type could not be resolved.

Parameters:

payload - The Message payload to resolve a type for.

Returns:

An Optional containing the type for the given payload, or empty if the type could not be resolved.

resolve

Optional<MessageType> resolve(Class<?> payloadType)

Resolves a type for the given payloadType.

This method returns an Optional that will be empty if the type could not be resolved.

Parameters:

payloadType - The type of the Message payload to resolve a type for.

Returns:

An Optional containing the type for the given payloadType, or empty if the type could not be resolved.