org.springframework.http.codec.json

Class Jackson2CodecSupport

java.lang.Object

org.springframework.http.codec.json.Jackson2CodecSupport

Direct Known Subclasses:

AbstractJackson2Decoder, AbstractJackson2Encoder

public abstract class Jackson2CodecSupport
extends java.lang.Object

Base class providing support methods for Jackson 2.9 encoding and decoding.

Since:

5.0

Author:

Sebastien Deleuze, Rossen Stoyanchev

Field Summary

Fields

Modifier and Type	Field and Description
private static java.util.List<MimeType>	DEFAULT_MIME_TYPES
static java.lang.String	JSON_VIEW_HINT The key for the hint to specify a "JSON View" for encoding or decoding with the value expected to be a Class.
private static java.lang.String	JSON_VIEW_HINT_ERROR
protected Log	logger
private java.util.List<MimeType>	mimeTypes
private ObjectMapper	objectMapper

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Jackson2CodecSupport(ObjectMapper objectMapper, MimeType... mimeTypes) Constructor with a Jackson ObjectMapper to use.

Method Summary

Modifier and Type	Method and Description
protected abstract <A extends java.lang.annotation.Annotation> A	getAnnotation(MethodParameter parameter, java.lang.Class<A> annotType)
protected java.util.Map<java.lang.String,java.lang.Object>	getHints(ResolvableType resolvableType)
protected JavaType	getJavaType(java.lang.reflect.Type type, java.lang.Class<?> contextClass)
protected java.util.List<MimeType>	getMimeTypes() Subclasses should expose this as "decodable" or "encodable" mime types.
ObjectMapper	getObjectMapper()
protected MethodParameter	getParameter(ResolvableType type)
protected boolean	supportsMimeType(MimeType mimeType)

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 java.lang.String JSON_VIEW_HINT

The key for the hint to specify a "JSON View" for encoding or decoding with the value expected to be a Class.

See Also:

Jackson JSON Views

JSON_VIEW_HINT_ERROR

private static final java.lang.String JSON_VIEW_HINT_ERROR

See Also:

Constant Field Values

DEFAULT_MIME_TYPES

private static final java.util.List<MimeType> DEFAULT_MIME_TYPES

logger

protected final Log logger

objectMapper

private final ObjectMapper objectMapper

mimeTypes

private final java.util.List<MimeType> mimeTypes

Constructor Detail

Jackson2CodecSupport

protected Jackson2CodecSupport(ObjectMapper objectMapper,
                               MimeType... mimeTypes)

Constructor with a Jackson ObjectMapper to use.

Method Detail

getObjectMapper

public ObjectMapper getObjectMapper()

getMimeTypes

protected java.util.List<MimeType> getMimeTypes()

Subclasses should expose this as "decodable" or "encodable" mime types.

supportsMimeType

protected boolean supportsMimeType(@Nullable
                                   MimeType mimeType)

getJavaType

protected JavaType getJavaType(java.lang.reflect.Type type,
                               @Nullable
                               java.lang.Class<?> contextClass)

getHints

protected java.util.Map<java.lang.String,java.lang.Object> getHints(ResolvableType resolvableType)

getParameter

@Nullable
protected MethodParameter getParameter(ResolvableType type)

getAnnotation

@Nullable
protected abstract <A extends java.lang.annotation.Annotation> A getAnnotation(MethodParameter parameter,
                                                                                         java.lang.Class<A> annotType)