Package org.springframework.messaging.converter

Class AbstractJsonMessageConverter

java.lang.Object

org.springframework.messaging.converter.AbstractMessageConverter

org.springframework.messaging.converter.AbstractJsonMessageConverter

All Implemented Interfaces:

MessageConverter, SmartMessageConverter

Direct Known Subclasses:

GsonMessageConverter, JsonbMessageConverter, KotlinSerializationJsonMessageConverter

public abstract class AbstractJsonMessageConverter
extends AbstractMessageConverter

Common base class for plain JSON converters, for example, Gson and JSON-B.

Since:

5.3

Author:

Juergen Hoeller

See Also:

• GsonMessageConverter
• JsonbMessageConverter
• fromJson(Reader, Type)
• fromJson(String, Type)
• toJson(Object, Type)
• toJson(Object, Type, Writer)

Field Summary

Fields inherited from class org.springframework.messaging.converter.AbstractMessageConverter

logger

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractJsonMessageConverter()

Method Summary

Modifier and Type	Method	Description
protected @Nullable Object	convertFromInternal(Message<?> message, Class<?> targetClass, @Nullable Object conversionHint)	Convert the message payload from serialized form to an Object.
protected @Nullable Object	convertToInternal(Object payload, @Nullable MessageHeaders headers, @Nullable Object conversionHint)	Convert the payload object to serialized form.
protected abstract Object	fromJson(Reader reader, Type resolvedType)
protected abstract Object	fromJson(String payload, Type resolvedType)
protected boolean	supports(Class<?> clazz)	Whether the given class is supported by this converter.
protected abstract String	toJson(Object payload, Type resolvedType)
protected abstract void	toJson(Object payload, Type resolvedType, Writer writer)

Methods inherited from class org.springframework.messaging.converter.AbstractMessageConverter

addSupportedMimeTypes, canConvertFrom, canConvertTo, fromMessage, fromMessage, getContentTypeResolver, getDefaultContentType, getMimeType, getSerializedPayloadClass, getSupportedMimeTypes, isStrictContentTypeMatch, setContentTypeResolver, setSerializedPayloadClass, setStrictContentTypeMatch, supportsMimeType, toMessage, toMessage

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractJsonMessageConverter

protected AbstractJsonMessageConverter()

Method Details

supports

protected boolean supports(Class<?> clazz)

Description copied from class: AbstractMessageConverter

Whether the given class is supported by this converter.

Specified by:

supports in class AbstractMessageConverter

Parameters:

clazz - the class to test for support

Returns:

true if supported; false otherwise

convertFromInternal

protected @Nullable Object convertFromInternal(Message<?> message,
 Class<?> targetClass,
 @Nullable Object conversionHint)

Description copied from class: AbstractMessageConverter

Convert the message payload from serialized form to an Object.

Overrides:

convertFromInternal in class AbstractMessageConverter

Parameters:

message - the input message

targetClass - the target class for the conversion

conversionHint - an extra object passed to the MessageConverter, for example, the associated MethodParameter (may be null}

Returns:

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

convertToInternal

protected @Nullable Object convertToInternal(Object payload,
 @Nullable MessageHeaders headers,
 @Nullable Object conversionHint)

Description copied from class: AbstractMessageConverter

Convert the payload object to serialized form.

Overrides:

convertToInternal in class AbstractMessageConverter

Parameters:

payload - the Object to convert

headers - optional headers for the message (may be null)

conversionHint - an extra object passed to the MessageConverter, for example, the associated MethodParameter (may be null}

Returns:

the resulting payload for the message, or null if the converter cannot perform the conversion

fromJson

protected abstract Object fromJson(Reader reader,
 Type resolvedType)
                            throws IOException

Throws:

IOException

fromJson

protected abstract Object fromJson(String payload,
 Type resolvedType)

toJson

protected abstract void toJson(Object payload,
 Type resolvedType,
 Writer writer)
                        throws IOException

Throws:

IOException

toJson

protected abstract String toJson(Object payload,
 Type resolvedType)