org.springframework.integration.mapping

Interface InboundMessageMapper<T>

All Known Subinterfaces:

BytesMessageMapper, MethodArgsMessageMapper

All Known Implementing Classes:

AbstractJsonInboundMessageMapper, EmbeddedJsonHeadersMessageMapper, JsonInboundMessageMapper

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 InboundMessageMapper<T>

Strategy interface for mapping from an Object to aMessage.

Method Summary

Modifier and Type	Method and Description
default org.springframework.messaging.Message<?>	toMessage(T object) Convert a provided object to the Message.
org.springframework.messaging.Message<?>	toMessage(T object, java.util.Map<java.lang.String,java.lang.Object> headers) Convert a provided object to the Message and supply with headers if necessary and provided.

Method Detail

toMessage

@Nullable
default org.springframework.messaging.Message<?> toMessage(T object)
                                                              throws java.lang.Exception

Convert a provided object to the Message.

Parameters:

object - the object for message payload or some other conversion logic

Returns:

the message as a result of mapping

Throws:

java.lang.Exception - the exception thrown by the underlying mapper implementation

toMessage

@Nullable
org.springframework.messaging.Message<?> toMessage(T object,
                                                             @Nullable
                                                             java.util.Map<java.lang.String,java.lang.Object> headers)
                                                      throws java.lang.Exception

Convert a provided object to the Message and supply with headers if necessary and provided.

Parameters:

object - the object for message payload or some other conversion logic

headers - additional headers for building message. Can be null

Returns:

the message as a result of mapping

Throws:

java.lang.Exception - the exception thrown by the underlying mapper implementation

Since:

5.0