org.springframework.http.converter.json

Class MappingJacksonValue

java.lang.Object

org.springframework.http.converter.json.MappingJacksonValue

public class MappingJacksonValue
extends java.lang.Object

A simple holder for the POJO to serialize via MappingJackson2HttpMessageConverter along with further serialization instructions to be passed in to the converter.

On the server side this wrapper is added with a ResponseBodyInterceptor after content negotiation selects the converter to use but before the write.

On the client side, simply wrap the POJO and pass it in to the RestTemplate.

Since:

4.1

Author:

Rossen Stoyanchev

Field Summary

Fields

Modifier and Type	Field and Description
private FilterProvider	filters
private java.lang.String	jsonpFunction
private java.lang.Class<?>	serializationView
private java.lang.Object	value

Constructor Summary

Constructors

Constructor and Description
MappingJacksonValue(java.lang.Object value) Create a new instance wrapping the given POJO to be serialized.

Method Summary

Modifier and Type	Method and Description
FilterProvider	getFilters() Return the Jackson filter provider to use.
java.lang.String	getJsonpFunction() Return the configured JSONP function name.
java.lang.Class<?>	getSerializationView() Return the serialization view to use.
java.lang.Object	getValue() Return the POJO that needs to be serialized.
void	setFilters(FilterProvider filters) Set the Jackson filter provider to serialize the POJO with.
void	setJsonpFunction(java.lang.String functionName) Set the name of the JSONP function name.
void	setSerializationView(java.lang.Class<?> serializationView) Set the serialization view to serialize the POJO with.
void	setValue(java.lang.Object value) Modify the POJO to serialize.

Methods inherited from class java.lang.Object

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

Field Detail

value

private java.lang.Object value

serializationView

private java.lang.Class<?> serializationView

filters

private FilterProvider filters

jsonpFunction

private java.lang.String jsonpFunction

Constructor Detail

MappingJacksonValue

public MappingJacksonValue(java.lang.Object value)

Create a new instance wrapping the given POJO to be serialized.

Parameters:

value - the Object to be serialized

Method Detail

setValue

public void setValue(java.lang.Object value)

Modify the POJO to serialize.

getValue

public java.lang.Object getValue()

Return the POJO that needs to be serialized.

setSerializationView

public void setSerializationView(java.lang.Class<?> serializationView)

Set the serialization view to serialize the POJO with.

See Also:

com.fasterxml.jackson.databind.ObjectMapper#writerWithView(Class), com.fasterxml.jackson.annotation.JsonView

getSerializationView

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

Return the serialization view to use.

See Also:

com.fasterxml.jackson.databind.ObjectMapper#writerWithView(Class), com.fasterxml.jackson.annotation.JsonView

setFilters

public void setFilters(FilterProvider filters)

Set the Jackson filter provider to serialize the POJO with.

Since:

4.2

See Also:

com.fasterxml.jackson.databind.ObjectMapper#writer(FilterProvider), com.fasterxml.jackson.annotation.JsonFilter, Jackson2ObjectMapperBuilder.filters(FilterProvider)

getFilters

public FilterProvider getFilters()

Return the Jackson filter provider to use.

Since:

4.2

See Also:

com.fasterxml.jackson.databind.ObjectMapper#writer(FilterProvider), com.fasterxml.jackson.annotation.JsonFilter

setJsonpFunction

public void setJsonpFunction(java.lang.String functionName)

Set the name of the JSONP function name.

getJsonpFunction

public java.lang.String getJsonpFunction()

Return the configured JSONP function name.