Spring for Android

org.springframework.http.converter.json
Class GsonHttpMessageConverter

java.lang.Object
  extended by org.springframework.http.converter.AbstractHttpMessageConverter<java.lang.Object>
      extended by org.springframework.http.converter.json.GsonHttpMessageConverter
All Implemented Interfaces:
HttpMessageConverter<java.lang.Object>

public class GsonHttpMessageConverter
extends AbstractHttpMessageConverter<java.lang.Object>

Since:
1.0
Author:
Roy Clarkson

Field Summary
static java.nio.charset.Charset DEFAULT_CHARSET
           
 
Constructor Summary
GsonHttpMessageConverter()
          Construct a new GsonHttpMessageConverter with a default Gson.
GsonHttpMessageConverter(boolean serializeNulls)
          Construct a new GsonHttpMessageConverter.
GsonHttpMessageConverter(com.google.gson.Gson gson)
          Construct a new GsonHttpMessageConverter.
 
Method Summary
 boolean canRead(java.lang.Class<?> clazz, MediaType mediaType)
          This implementation checks if the given class is supported, and if the supported media types include the given media type.
 boolean canWrite(java.lang.Class<?> clazz, MediaType mediaType)
          This implementation checks if the given class is supported, and if the supported media types include the given media type.
 java.lang.reflect.Type getType()
           
protected  java.lang.Object readInternal(java.lang.Class<?> clazz, HttpInputMessage inputMessage)
          Abstract template method that reads the actualy object.
 void setGson(com.google.gson.Gson gson)
          Sets the Gson for this view.
 void setPrefixJson(boolean prefixJson)
          Indicates whether the JSON output by this view should be prefixed with "{} &&".
 void setType(java.lang.reflect.Type type)
           
protected  boolean supports(java.lang.Class<?> clazz)
          Indicates whether the given class is supported by this converter.
protected  void writeInternal(java.lang.Object o, HttpOutputMessage outputMessage)
          Abstract template method that writes the actual body.
 
Methods inherited from class org.springframework.http.converter.AbstractHttpMessageConverter
canRead, canWrite, getContentLength, getDefaultContentType, getSupportedMediaTypes, read, setSupportedMediaTypes, write
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DEFAULT_CHARSET

public static final java.nio.charset.Charset DEFAULT_CHARSET
Constructor Detail

GsonHttpMessageConverter

public GsonHttpMessageConverter()
Construct a new GsonHttpMessageConverter with a default Gson.


GsonHttpMessageConverter

public GsonHttpMessageConverter(boolean serializeNulls)
Construct a new GsonHttpMessageConverter.

Parameters:
serializeNulls - true to generate json for null values

GsonHttpMessageConverter

public GsonHttpMessageConverter(com.google.gson.Gson gson)
Construct a new GsonHttpMessageConverter.

Parameters:
gson - a customized Gson
Method Detail

setGson

public void setGson(com.google.gson.Gson gson)
Sets the Gson for this view. If not set, a default Gson is used.

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

Throws:
java.lang.IllegalArgumentException - if gson is null

setType

public void setType(java.lang.reflect.Type type)

getType

public java.lang.reflect.Type getType()

setPrefixJson

public void setPrefixJson(boolean prefixJson)
Indicates whether the JSON output by this view should be prefixed with "{} &&". Default is false.

Prefixing the JSON string in this manner is used to help prevent JSON Hijacking. The prefix renders the string syntactically invalid as a script so that it cannot be hijacked. This prefix does not affect the evaluation of JSON, but if JSON validation is performed on the string, the prefix would need to be ignored.


canRead

public boolean canRead(java.lang.Class<?> clazz,
                       MediaType mediaType)
Description copied from class: AbstractHttpMessageConverter
This implementation checks if the given class is supported, and if the supported media types include the given media type.

Specified by:
canRead in interface HttpMessageConverter<java.lang.Object>
Overrides:
canRead in class AbstractHttpMessageConverter<java.lang.Object>
Parameters:
clazz - the class to test for readability
mediaType - the media type to read, can be null if not specified. Typically the value of a Content-Type header.
Returns:
true if readable; false otherwise

canWrite

public boolean canWrite(java.lang.Class<?> clazz,
                        MediaType mediaType)
Description copied from class: AbstractHttpMessageConverter
This implementation checks if the given class is supported, and if the supported media types include the given media type.

Specified by:
canWrite in interface HttpMessageConverter<java.lang.Object>
Overrides:
canWrite in class AbstractHttpMessageConverter<java.lang.Object>
Parameters:
clazz - the class to test for writability
mediaType - the media type to write, can be null if not specified. Typically the value of an Accept header.
Returns:
true if writable; false otherwise

supports

protected boolean supports(java.lang.Class<?> clazz)
Description copied from class: AbstractHttpMessageConverter
Indicates whether the given class is supported by this converter.

Specified by:
supports in class AbstractHttpMessageConverter<java.lang.Object>
Parameters:
clazz - the class to test for support
Returns:
true if supported; false otherwise

readInternal

protected java.lang.Object readInternal(java.lang.Class<?> clazz,
                                        HttpInputMessage inputMessage)
                                 throws java.io.IOException,
                                        HttpMessageNotReadableException
Description copied from class: AbstractHttpMessageConverter
Abstract template method that reads the actualy object. Invoked from AbstractHttpMessageConverter.read(java.lang.Class, org.springframework.http.HttpInputMessage).

Specified by:
readInternal in class AbstractHttpMessageConverter<java.lang.Object>
Parameters:
clazz - the type of object to return
inputMessage - the HTTP input message to read from
Returns:
the converted object
Throws:
java.io.IOException - in case of I/O errors
HttpMessageNotReadableException - in case of conversion errors

writeInternal

protected void writeInternal(java.lang.Object o,
                             HttpOutputMessage outputMessage)
                      throws java.io.IOException,
                             HttpMessageNotWritableException
Description copied from class: AbstractHttpMessageConverter
Abstract template method that writes the actual body. Invoked from AbstractHttpMessageConverter.write(T, org.springframework.http.MediaType, org.springframework.http.HttpOutputMessage).

Specified by:
writeInternal in class AbstractHttpMessageConverter<java.lang.Object>
Parameters:
o - the object to write to the output message
outputMessage - the message to write to
Throws:
java.io.IOException - in case of I/O errors
HttpMessageNotWritableException - in case of conversion errors

Spring for Android