org.springframework.http.codec.json

Class AbstractJackson2Codec

java.lang.Object

org.springframework.http.codec.json.AbstractJackson2Codec

Direct Known Subclasses:

Jackson2JsonDecoder, Jackson2JsonEncoder

public class AbstractJackson2Codec
extends Object

Abstract base class for Jackson based decoder/encoder implementations.

Author:

Sebastien Deleuze

Field Summary

Fields

Modifier and Type	Field and Description
protected static List<org.springframework.util.MimeType>	JSON_MIME_TYPES
static String	JSON_VIEW_HINT Hint key to use with a Class value specifying the JSON View to use to serialize or deserialize an object.
protected ObjectMapper	mapper

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractJackson2Codec(ObjectMapper mapper) Create a new Jackson codec for the given mapper.

Method Summary

Modifier and Type	Method and Description
protected JavaType	getJavaType(Type type, Class<?> contextClass) Return the Jackson JavaType for the specified type and context class.

Methods inherited from class java.lang.Object

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

Field Detail

JSON_VIEW_HINT

public static final String JSON_VIEW_HINT

Hint key to use with a Class value specifying the JSON View to use to serialize or deserialize an object.

See Also:

Jackson JSON Views

JSON_MIME_TYPES

protected static final List<org.springframework.util.MimeType> JSON_MIME_TYPES

mapper

protected final ObjectMapper mapper

Constructor Detail

AbstractJackson2Codec

protected AbstractJackson2Codec(ObjectMapper mapper)

Create a new Jackson codec for the given mapper.

Parameters:

mapper - the Jackson ObjectMapper to use

Method Detail

getJavaType

protected JavaType getJavaType(Type type,
                               Class<?> contextClass)

Return the Jackson JavaType for the specified type and context class.

The default implementation returns typeFactory.constructType(type, contextClass), but this can be overridden in subclasses, to allow for custom generic collection handling. For instance:

 protected JavaType getJavaType(Type type) {
   if (type instanceof Class && List.class.isAssignableFrom((Class)type)) {
     return TypeFactory.collectionType(ArrayList.class, MyBean.class);
   } else {
     return super.getJavaType(type);
   }
 }
 

Parameters:

type - the generic type to return the Jackson JavaType for

contextClass - a context class for the target type, for example a class in which the target type appears in a method signature (can be null)

Returns:

the Jackson JavaType