com.microsoft.azure.spring.integration.core.converter

Interface AzureMessageConverter<T>

Type Parameters:

T - Azure message type

All Known Implementing Classes:

AbstractAzureMessageConverter

public interface AzureMessageConverter<T>

A converter to turn the payload of a Message from serialized form to a typed Object and vice versa.

Author:

Warren Zhu

Method Summary

Modifier and Type	Method and Description
T	fromMessage(org.springframework.messaging.Message<?> message, Class<T> targetClass) Convert the payload of a Message from a serialized form to a typed Object of the specified target class.
default <U> org.springframework.messaging.Message<U>	toMessage(T azureMessage, Class<U> targetPayloadClass)
<U> org.springframework.messaging.Message<U>	toMessage(T azureMessage, Map<String,Object> headers, Class<U> targetPayloadClass) Create a Message whose payload is the result of converting the given payload Object to serialized form.

Method Detail

fromMessage

@Nullable
T fromMessage(org.springframework.messaging.Message<?> message,
                         Class<T> targetClass)

Convert the payload of a Message from a serialized form to a typed Object of the specified target class.

Parameters:

message - the input message

targetClass - the target class for the conversion

Returns:

the result of the conversion, or null if the converter cannot perform the conversion

toMessage

@Nullable
<U> org.springframework.messaging.Message<U> toMessage(T azureMessage,
                                                                  Map<String,Object> headers,
                                                                  Class<U> targetPayloadClass)

Create a Message whose payload is the result of converting the given payload Object to serialized form. The optional MessageHeaders parameter may contain additional headers to be added to the message.

Parameters:

azureMessage - the Object to convert

headers - optional headers for the message

targetPayloadClass - the target payload class for the conversion

Returns:

the new message, or null if the converter does not support the Object type or the target media type

toMessage

@Nullable
default <U> org.springframework.messaging.Message<U> toMessage(T azureMessage,
                                                                          Class<U> targetPayloadClass)