Class Transformers

java.lang.Object

org.springframework.integration.dsl.Transformers

public abstract class Transformers
extends Object

A utility class to provide methods for out-of-the-box Transformers.

Since:

5.0

Author:

Artem Bilan

Constructor Summary

Constructors

Constructor	Description
Transformers()

Method Summary

Modifier and Type	Method	Description
static <T,U> PayloadTypeConvertingTransformer<T,U>	converter(Converter<T,U> converter)
static <T> DecodingTransformer<T>	decoding(Codec codec, Class<T> type)	The factory method for the DecodingTransformer.
static <T> DecodingTransformer<T>	decoding(Codec codec, String typeExpression)	The factory method for the DecodingTransformer.
static <T> DecodingTransformer<T>	decoding(Codec codec, Function<Message<?>, Class<T>> typeFunction)	The factory method for the DecodingTransformer.
static <T> DecodingTransformer<T>	decoding(Codec codec, Expression typeExpression)	The factory method for the DecodingTransformer.
static PayloadDeserializingTransformer	deserializer(String... allowedPatterns)
static PayloadDeserializingTransformer	deserializer(@Nullable Deserializer<Object> deserializer, String... allowedPatterns)
static <T> EncodingPayloadTransformer<T>	encoding(Codec codec)	The factory method for the EncodingPayloadTransformer.
static JsonToObjectTransformer	fromJson()
static JsonToObjectTransformer	fromJson(@Nullable Class<?> targetClass)
static JsonToObjectTransformer	fromJson(@Nullable Class<?> targetClass, @Nullable JsonObjectMapper<?,?> jsonObjectMapper)
static JsonToObjectTransformer	fromJson(ResolvableType targetType)	Construct a JsonToObjectTransformer based on the provided ResolvableType.
static JsonToObjectTransformer	fromJson(ResolvableType targetType, @Nullable JsonObjectMapper<?,?> jsonObjectMapper)	Construct a JsonToObjectTransformer based on the provided ResolvableType and JsonObjectMapper.
static JsonToObjectTransformer	fromJson(@Nullable JsonObjectMapper<?,?> jsonObjectMapper)
static MapToObjectTransformer	fromMap(Class<?> targetClass)
static MapToObjectTransformer	fromMap(String beanName)
static StreamTransformer	fromStream()	The factory method for the StreamTransformer.
static StreamTransformer	fromStream(@Nullable String charset)	Create an instance with the charset to convert the stream to a String; if null a byte[] will be produced instead.
static ObjectToStringTransformer	objectToString()
static ObjectToStringTransformer	objectToString(@Nullable String charset)
static PayloadSerializingTransformer	serializer()
static PayloadSerializingTransformer	serializer(@Nullable Serializer<Object> serializer)
static SyslogToMapTransformer	syslogToMap()
static ObjectToJsonTransformer	toJson()
static ObjectToJsonTransformer	toJson(@Nullable String contentType)
static ObjectToJsonTransformer	toJson(@Nullable ObjectToJsonTransformer.ResultType resultType)	Factory for the ObjectToJsonTransformer based on the provided ObjectToJsonTransformer.ResultType.
static ObjectToJsonTransformer	toJson(@Nullable ObjectToJsonTransformer.ResultType resultType, @Nullable String contentType)
static ObjectToJsonTransformer	toJson(@Nullable JsonObjectMapper<?,?> jsonObjectMapper)
static ObjectToJsonTransformer	toJson(@Nullable JsonObjectMapper<?,?> jsonObjectMapper, @Nullable String contentType)
static ObjectToJsonTransformer	toJson(@Nullable JsonObjectMapper<?,?> jsonObjectMapper, @Nullable ObjectToJsonTransformer.ResultType resultType)
static ObjectToJsonTransformer	toJson(@Nullable JsonObjectMapper<?,?> jsonObjectMapper, @Nullable ObjectToJsonTransformer.ResultType resultType, @Nullable String contentType)
static ObjectToMapTransformer	toMap()
static ObjectToMapTransformer	toMap(boolean shouldFlattenKeys)
static ObjectToMapTransformer	toMap(JsonObjectMapper<?,?> jsonObjectMapper)
static ObjectToMapTransformer	toMap(JsonObjectMapper<?,?> jsonObjectMapper, boolean shouldFlattenKeys)

Methods inherited from class java.lang.Object

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

Constructor Details

Transformers

public Transformers()

Method Details

objectToString

public static ObjectToStringTransformer objectToString()

objectToString

public static ObjectToStringTransformer objectToString(@Nullable String charset)

toMap

public static ObjectToMapTransformer toMap()

toMap

public static ObjectToMapTransformer toMap(boolean shouldFlattenKeys)

toMap

public static ObjectToMapTransformer toMap(JsonObjectMapper<?,?> jsonObjectMapper)

toMap

public static ObjectToMapTransformer toMap(JsonObjectMapper<?,?> jsonObjectMapper,
 boolean shouldFlattenKeys)

fromMap

public static MapToObjectTransformer fromMap(Class<?> targetClass)

fromMap

public static MapToObjectTransformer fromMap(String beanName)

toJson

public static ObjectToJsonTransformer toJson()

toJson

public static ObjectToJsonTransformer toJson(@Nullable JsonObjectMapper<?,?> jsonObjectMapper)

toJson

public static ObjectToJsonTransformer toJson(@Nullable JsonObjectMapper<?,?> jsonObjectMapper,
 @Nullable ObjectToJsonTransformer.ResultType resultType)

toJson

public static ObjectToJsonTransformer toJson(@Nullable String contentType)

toJson

public static ObjectToJsonTransformer toJson(@Nullable JsonObjectMapper<?,?> jsonObjectMapper,
 @Nullable String contentType)

toJson

public static ObjectToJsonTransformer toJson(@Nullable ObjectToJsonTransformer.ResultType resultType)

Factory for the ObjectToJsonTransformer based on the provided ObjectToJsonTransformer.ResultType.

Parameters:

resultType - the ObjectToJsonTransformer.ResultType to use. Defaults to ObjectToJsonTransformer.ResultType.STRING.

Returns:

the ObjectToJsonTransformer

Since:

5.0.9

toJson

public static ObjectToJsonTransformer toJson(@Nullable ObjectToJsonTransformer.ResultType resultType,
 @Nullable String contentType)

toJson

public static ObjectToJsonTransformer toJson(@Nullable JsonObjectMapper<?,?> jsonObjectMapper,
 @Nullable ObjectToJsonTransformer.ResultType resultType,
 @Nullable String contentType)

fromJson

public static JsonToObjectTransformer fromJson()

fromJson

public static JsonToObjectTransformer fromJson(@Nullable Class<?> targetClass)

fromJson

public static JsonToObjectTransformer fromJson(ResolvableType targetType)

Construct a JsonToObjectTransformer based on the provided ResolvableType.

Parameters:

targetType - the ResolvableType top use.

Returns:

the JsonToObjectTransformer instance.

Since:

5.2

fromJson

public static JsonToObjectTransformer fromJson(@Nullable JsonObjectMapper<?,?> jsonObjectMapper)

fromJson

public static JsonToObjectTransformer fromJson(@Nullable Class<?> targetClass,
 @Nullable JsonObjectMapper<?,?> jsonObjectMapper)

fromJson

public static JsonToObjectTransformer fromJson(ResolvableType targetType,
 @Nullable JsonObjectMapper<?,?> jsonObjectMapper)

Construct a JsonToObjectTransformer based on the provided ResolvableType and JsonObjectMapper.

Parameters:

targetType - the ResolvableType top use.

jsonObjectMapper - the JsonObjectMapper top use.

Returns:

the JsonToObjectTransformer instance.

Since:

5.2

serializer

public static PayloadSerializingTransformer serializer()

serializer

public static PayloadSerializingTransformer serializer(@Nullable Serializer<Object> serializer)

deserializer

public static PayloadDeserializingTransformer deserializer(String... allowedPatterns)

deserializer

public static PayloadDeserializingTransformer deserializer(@Nullable Deserializer<Object> deserializer,
 String... allowedPatterns)

converter

public static <T,U>
PayloadTypeConvertingTransformer<T,U> converter(Converter<T,U> converter)

syslogToMap

public static SyslogToMapTransformer syslogToMap()

encoding

public static <T> EncodingPayloadTransformer<T> encoding(Codec codec)

The factory method for the EncodingPayloadTransformer.

Type Parameters:

T - the payload type.

Parameters:

codec - the Codec to use.

Returns:

the EncodingPayloadTransformer instance.

decoding

public static <T> DecodingTransformer<T> decoding(Codec codec,
 Class<T> type)

The factory method for the DecodingTransformer.

Type Parameters:

T - the target type.

Parameters:

codec - the Codec to use.

type - the target type to transform to.

Returns:

the DecodingTransformer instance.

decoding

public static <T> DecodingTransformer<T> decoding(Codec codec,
 String typeExpression)

The factory method for the DecodingTransformer.

Type Parameters:

T - the target type.

Parameters:

codec - the Codec to use.

typeExpression - the target type SpEL expression.

Returns:

the DecodingTransformer instance.

decoding

public static <T> DecodingTransformer<T> decoding(Codec codec,
 Function<Message<?>, Class<T>> typeFunction)

The factory method for the DecodingTransformer.

Type Parameters:

T - the target type.

Parameters:

codec - the Codec to use.

typeFunction - the target type function.

Returns:

the DecodingTransformer instance.

decoding

public static <T> DecodingTransformer<T> decoding(Codec codec,
 Expression typeExpression)

The factory method for the DecodingTransformer.

Type Parameters:

T - the target type.

Parameters:

codec - the Codec to use.

typeExpression - the target type SpEL expression.

Returns:

the DecodingTransformer instance.

fromStream

public static StreamTransformer fromStream()

The factory method for the StreamTransformer.

Returns:

the StreamTransformer instance.

fromStream

public static StreamTransformer fromStream(@Nullable String charset)

Create an instance with the charset to convert the stream to a String; if null a byte[] will be produced instead.

Parameters:

charset - the charset.

Returns:

the StreamTransformer instance.