org.springframework.http.converter.json

Class GsonFactoryBean

java.lang.Object

org.springframework.http.converter.json.GsonFactoryBean

All Implemented Interfaces:

FactoryBean<Gson>, InitializingBean

public class GsonFactoryBean
extends java.lang.Object
implements FactoryBean<Gson>, InitializingBean

A FactoryBean for creating a Google Gson 2.x Gson instance.

Since:

4.1

Author:

Roy Clarkson, Juergen Hoeller

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	base64EncodeByteArrays
private java.lang.String	dateFormatPattern
private boolean	disableHtmlEscaping
private Gson	gson
private boolean	prettyPrinting
private boolean	serializeNulls

Constructor Summary

Constructors

Constructor and Description
GsonFactoryBean()

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet() Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware).
Gson	getObject() Return the created Gson instance.
java.lang.Class<?>	getObjectType() Return the type of object that this FactoryBean creates, or null if not known in advance.
boolean	isSingleton() Is the object managed by this factory a singleton? That is, will FactoryBean.getObject() always return the same object (a reference that can be cached)?
void	setBase64EncodeByteArrays(boolean base64EncodeByteArrays) Whether to Base64-encode byte[] properties when reading and writing JSON.
void	setDateFormatPattern(java.lang.String dateFormatPattern) Define the date/time format with a SimpleDateFormat-style pattern.
void	setDisableHtmlEscaping(boolean disableHtmlEscaping) Whether to use the GsonBuilder#disableHtmlEscaping() when writing JSON.
void	setPrettyPrinting(boolean prettyPrinting) Whether to use the GsonBuilder#setPrettyPrinting() when writing JSON.
void	setSerializeNulls(boolean serializeNulls) Whether to use the GsonBuilder#serializeNulls() option when writing JSON.

Methods inherited from class java.lang.Object

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

Field Detail

base64EncodeByteArrays

private boolean base64EncodeByteArrays

serializeNulls

private boolean serializeNulls

prettyPrinting

private boolean prettyPrinting

disableHtmlEscaping

private boolean disableHtmlEscaping

dateFormatPattern

private java.lang.String dateFormatPattern

gson

private Gson gson

Constructor Detail

GsonFactoryBean

public GsonFactoryBean()

Method Detail

setBase64EncodeByteArrays

public void setBase64EncodeByteArrays(boolean base64EncodeByteArrays)

Whether to Base64-encode byte[] properties when reading and writing JSON.

When set to true, a custom com.google.gson.TypeAdapter will be registered via GsonBuilder#registerTypeHierarchyAdapter(Class, Object) which serializes a byte[] property to and from a Base64-encoded String instead of a JSON array.

NOTE: Use of this option requires the presence of the Apache Commons Codec library on the classpath when running on Java 6 or 7. On Java 8, the standard Base64 facility is used instead.

See Also:

GsonBuilderUtils.gsonBuilderWithBase64EncodedByteArrays()

setSerializeNulls

public void setSerializeNulls(boolean serializeNulls)

Whether to use the GsonBuilder#serializeNulls() option when writing JSON. This is a shortcut for setting up a Gson as follows:

 new GsonBuilder().serializeNulls().create();
 

setPrettyPrinting

public void setPrettyPrinting(boolean prettyPrinting)

Whether to use the GsonBuilder#setPrettyPrinting() when writing JSON. This is a shortcut for setting up a Gson as follows:

 new GsonBuilder().setPrettyPrinting().create();
 

setDisableHtmlEscaping

public void setDisableHtmlEscaping(boolean disableHtmlEscaping)

Whether to use the GsonBuilder#disableHtmlEscaping() when writing JSON. Set to true to disable HTML escaping in JSON. This is a shortcut for setting up a Gson as follows:

 new GsonBuilder().disableHtmlEscaping().create();
 

setDateFormatPattern

public void setDateFormatPattern(java.lang.String dateFormatPattern)

Define the date/time format with a SimpleDateFormat-style pattern. This is a shortcut for setting up a Gson as follows:

 new GsonBuilder().setDateFormat(dateFormatPattern).create();
 

afterPropertiesSet

public void afterPropertiesSet()

Description copied from interface: InitializingBean

Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware).

This method allows the bean instance to perform initialization only possible when all bean properties have been set and to throw an exception in the event of misconfiguration.

Specified by:

afterPropertiesSet in interface InitializingBean

getObject

public Gson getObject()

Return the created Gson instance.

Specified by:

getObject in interface FactoryBean<Gson>

Returns:

an instance of the bean (can be null)

See Also:

FactoryBeanNotInitializedException

getObjectType

public java.lang.Class<?> getObjectType()

Description copied from interface: FactoryBean

Return the type of object that this FactoryBean creates, or null if not known in advance.

This allows one to check for specific types of beans without instantiating objects, for example on autowiring.

In the case of implementations that are creating a singleton object, this method should try to avoid singleton creation as far as possible; it should rather estimate the type in advance. For prototypes, returning a meaningful type here is advisable too.

This method can be called before this FactoryBean has been fully initialized. It must not rely on state created during initialization; of course, it can still use such state if available.

NOTE: Autowiring will simply ignore FactoryBeans that return null here. Therefore it is highly recommended to implement this method properly, using the current state of the FactoryBean.

Specified by:

getObjectType in interface FactoryBean<Gson>

Returns:

the type of object that this FactoryBean creates, or null if not known at the time of the call

See Also:

ListableBeanFactory.getBeansOfType(java.lang.Class<T>)

isSingleton

public boolean isSingleton()

Description copied from interface: FactoryBean

Is the object managed by this factory a singleton? That is, will FactoryBean.getObject() always return the same object (a reference that can be cached)?

NOTE: If a FactoryBean indicates to hold a singleton object, the object returned from getObject() might get cached by the owning BeanFactory. Hence, do not return true unless the FactoryBean always exposes the same reference.

The singleton status of the FactoryBean itself will generally be provided by the owning BeanFactory; usually, it has to be defined as singleton there.

NOTE: This method returning false does not necessarily indicate that returned objects are independent instances. An implementation of the extended SmartFactoryBean interface may explicitly indicate independent instances through its SmartFactoryBean.isPrototype() method. Plain FactoryBean implementations which do not implement this extended interface are simply assumed to always return independent instances if the isSingleton() implementation returns false.

Specified by:

isSingleton in interface FactoryBean<Gson>

Returns:

whether the exposed object is a singleton

See Also:

FactoryBean.getObject(), SmartFactoryBean.isPrototype()