org.springframework.hateoas.mvc

Class TypeConstrainedMappingJackson2HttpMessageConverter

java.lang.Object

org.springframework.http.converter.AbstractHttpMessageConverter<Object>

org.springframework.http.converter.json.AbstractJackson2HttpMessageConverter

org.springframework.http.converter.json.MappingJackson2HttpMessageConverter

org.springframework.hateoas.mvc.TypeConstrainedMappingJackson2HttpMessageConverter

All Implemented Interfaces:

GenericHttpMessageConverter<Object>, HttpMessageConverter<Object>

public class TypeConstrainedMappingJackson2HttpMessageConverter
extends MappingJackson2HttpMessageConverter

Extension of MappingJackson2HttpMessageConverter to constrain the ability to read and write HTTP message based on the target type. Useful in case the ObjectMapper about to be configured has customizations that shall only be applied to object trees of a certain base type.

Author:

Oliver Gierke

Field Summary

Fields inherited from class org.springframework.http.converter.json.AbstractJackson2HttpMessageConverter

DEFAULT_CHARSET, objectMapper

Fields inherited from class org.springframework.http.converter.AbstractHttpMessageConverter

logger

Constructor Summary

Constructors

Constructor and Description
TypeConstrainedMappingJackson2HttpMessageConverter(Class<?> type) Creates a new TypeConstrainedMappingJackson2HttpMessageConverter for the given type.

Method Summary

Modifier and Type	Method and Description
boolean	canRead(Class<?> clazz, MediaType mediaType)
boolean	canRead(Type type, Class<?> contextClass, MediaType mediaType)
boolean	canWrite(Class<?> clazz, MediaType mediaType)

Methods inherited from class org.springframework.http.converter.json.MappingJackson2HttpMessageConverter

setJsonPrefix, setPrefixJson, writePrefix, writeSuffix

Methods inherited from class org.springframework.http.converter.json.AbstractJackson2HttpMessageConverter

getContentLength, getDefaultContentType, getJavaType, getJsonEncoding, getObjectMapper, read, readInternal, setObjectMapper, setPrettyPrint, supports, writeInternal

Methods inherited from class org.springframework.http.converter.AbstractHttpMessageConverter

canRead, canWrite, getSupportedMediaTypes, read, setSupportedMediaTypes, write

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.http.converter.HttpMessageConverter

getSupportedMediaTypes, read, write

Constructor Detail

TypeConstrainedMappingJackson2HttpMessageConverter

public TypeConstrainedMappingJackson2HttpMessageConverter(Class<?> type)

Creates a new TypeConstrainedMappingJackson2HttpMessageConverter for the given type.

Parameters:

type - must not be null.

Method Detail

canRead

public boolean canRead(Class<?> clazz,
                       MediaType mediaType)

Specified by:

canRead in interface HttpMessageConverter<Object>

Overrides:

canRead in class AbstractJackson2HttpMessageConverter

canRead

public boolean canRead(Type type,
                       Class<?> contextClass,
                       MediaType mediaType)

Specified by:

canRead in interface GenericHttpMessageConverter<Object>

Overrides:

canRead in class AbstractJackson2HttpMessageConverter

canWrite

public boolean canWrite(Class<?> clazz,
                        MediaType mediaType)

Specified by:

canWrite in interface HttpMessageConverter<Object>

Overrides:

canWrite in class AbstractJackson2HttpMessageConverter