Package org.springframework.http.converter.json

Class GsonFactoryBean

java.lang.Object
org.springframework.http.converter.json.GsonFactoryBean
All Implemented Interfaces:
FactoryBean<com.google.gson.Gson>, InitializingBean
public class GsonFactoryBean extends Object implements FactoryBean<com.google.gson.Gson>, InitializingBean
A FactoryBean for creating a Google Gson 2.x Gson instance.
Since:
4.1
Author:
Roy Clarkson, Juergen Hoeller

  • Constructor Details

    • GsonFactoryBean

      public GsonFactoryBean()

  • Method Details

    • setBase64EncodeByteArrays

      public void setBase64EncodeByteArrays(boolean base64EncodeByteArrays)
      Whether to Base64-encode byte[] properties when reading and writing JSON.

      When set to true, a custom 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.

      See Also:

    • 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(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 the containing BeanFactory after it has set all bean properties and satisfied BeanFactoryAware, ApplicationContextAware etc.

      This method allows the bean instance to perform validation of its overall configuration and final initialization when all bean properties have been set.

      Specified by:
      afterPropertiesSet in interface InitializingBean

    • getObject

      @Nullable public com.google.gson.Gson getObject()
      Return the created Gson instance.
      Specified by:
      getObject in interface FactoryBean<com.google.gson.Gson>
      Returns:
      an instance of the bean (can be null)
      See Also:

    • getObjectType

      public 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<com.google.gson.Gson>
      Returns:
      the type of object that this FactoryBean creates, or null if not known at the time of the call
      See Also:

    • 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.

      The default implementation returns true, since a FactoryBean typically manages a singleton instance.

      Specified by:
      isSingleton in interface FactoryBean<com.google.gson.Gson>
      Returns:
      whether the exposed object is a singleton
      See Also: