Class GsonMessageConverter

java.lang.Object

org.springframework.messaging.converter.AbstractMessageConverter

org.springframework.messaging.converter.AbstractJsonMessageConverter

org.springframework.messaging.converter.GsonMessageConverter

All Implemented Interfaces:

MessageConverter, SmartMessageConverter

public class GsonMessageConverter
extends AbstractJsonMessageConverter

Implementation of MessageConverter that can read and write JSON using Google Gson.

Since:

5.3

Author:

Juergen Hoeller

See Also:

• Gson
• GsonBuilder
• setGson(Gson)

Field Summary

Fields inherited from class AbstractMessageConverter

logger

Constructor Summary

Constructors

Constructor	Description
GsonMessageConverter()	Construct a new GsonMessageConverter with default configuration.
GsonMessageConverter(com.google.gson.Gson gson)	Construct a new GsonMessageConverter with the given delegate.

Method Summary

Modifier and Type	Method	Description
protected Object	fromJson(Reader reader, Type resolvedType)
protected Object	fromJson(String payload, Type resolvedType)
com.google.gson.Gson	getGson()	Return the configured Gson instance for this converter.
void	setGson(com.google.gson.Gson gson)	Set the Gson instance to use.
protected String	toJson(Object payload, Type resolvedType)
protected void	toJson(Object payload, Type resolvedType, Writer writer)

Methods inherited from class AbstractJsonMessageConverter

convertFromInternal, convertToInternal, supports

Methods inherited from class AbstractMessageConverter

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

Methods inherited from class Object

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

Constructor Details

GsonMessageConverter

public GsonMessageConverter()

Construct a new GsonMessageConverter with default configuration.

GsonMessageConverter

public GsonMessageConverter(com.google.gson.Gson gson)

Construct a new GsonMessageConverter with the given delegate.

Parameters:

gson - the Gson instance to use

Method Details

setGson

public void setGson(com.google.gson.Gson gson)

Set the Gson instance to use. If not set, a default Gson instance will be used.

Setting a custom-configured Gson is one way to take further control of the JSON serialization process.

See Also:

• GsonMessageConverter(Gson)

getGson

public com.google.gson.Gson getGson()

Return the configured Gson instance for this converter.

fromJson

protected Object fromJson(Reader reader,
 Type resolvedType)

Specified by:

fromJson in class AbstractJsonMessageConverter

fromJson

protected Object fromJson(String payload,
 Type resolvedType)

Specified by:

fromJson in class AbstractJsonMessageConverter

toJson

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

Specified by:

toJson in class AbstractJsonMessageConverter

Throws:

IOException

toJson

protected String toJson(Object payload,
 Type resolvedType)

Specified by:

toJson in class AbstractJsonMessageConverter