AbstractJackson2Decoder (Spring Framework 5.1.0.RELEASE API)

java.lang.Object
- org.springframework.http.codec.json.Jackson2CodecSupport
- - org.springframework.http.codec.json.AbstractJackson2Decoder

All Implemented Interfaces:

Decoder<java.lang.Object>, HttpMessageDecoder<java.lang.Object>

Direct Known Subclasses:

Jackson2JsonDecoder, Jackson2SmileDecoder
```
public abstract class AbstractJackson2Decoder
extends Jackson2CodecSupport
implements HttpMessageDecoder<java.lang.Object>
```
Abstract base class for Jackson 2.9 decoding, leveraging non-blocking parsing.

Since:

5.0

Author:

Sebastien Deleuze, Rossen Stoyanchev, Arjen Poutsma

See Also:

Add support for non-blocking ("async") JSON parsing

Field Summary
- Fields inherited from class org.springframework.http.codec.json.Jackson2CodecSupport
  JSON_VIEW_HINT, logger

Constructor Summary

Constructors
Modifier Constructor and Description

protected AbstractJackson2Decoder(ObjectMapper mapper, MimeType... mimeTypes)
Constructor with a Jackson ObjectMapper to use.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`canDecode(ResolvableType elementType, MimeType mimeType)` Whether the decoder supports the given target element type and the MIME type of the source stream.
`reactor.core.publisher.Flux<java.lang.Object>`	`decode(org.reactivestreams.Publisher<DataBuffer> input, ResolvableType elementType, MimeType mimeType, java.util.Map<java.lang.String,java.lang.Object> hints)` Decode a `DataBuffer` input stream into a Flux of `T`.
`reactor.core.publisher.Mono<java.lang.Object>`	`decodeToMono(org.reactivestreams.Publisher<DataBuffer> input, ResolvableType elementType, MimeType mimeType, java.util.Map<java.lang.String,java.lang.Object> hints)` Decode a `DataBuffer` input stream into a Mono of `T`.
`protected <A extends java.lang.annotation.Annotation> A`	`getAnnotation(MethodParameter parameter, java.lang.Class<A> annotType)`
`java.util.List<MimeType>`	`getDecodableMimeTypes()` Return the list of MIME types this decoder supports.
`java.util.Map<java.lang.String,java.lang.Object>`	`getDecodeHints(ResolvableType actualType, ResolvableType elementType, ServerHttpRequest request, ServerHttpResponse response)` Get decoding hints based on the server request or annotations on the target controller method parameter.

Methods inherited from class org.springframework.http.codec.json.Jackson2CodecSupport
getHints, getJavaType, getMimeTypes, getObjectMapper, getParameter, supportsMimeType

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractJackson2Decoder

protected AbstractJackson2Decoder(ObjectMapper mapper,
                                  MimeType... mimeTypes)

Constructor with a Jackson ObjectMapper to use.

Method Detail

canDecode
```
public boolean canDecode(ResolvableType elementType,
                         @Nullable
                         MimeType mimeType)
```
Description copied from interface: Decoder

Whether the decoder supports the given target element type and the MIME type of the source stream.

Specified by:

canDecode in interface Decoder<java.lang.Object>

Parameters:

elementType - the target element type for the output stream

mimeType - the mime type associated with the stream to decode (can be null if not specified)

Returns:

true if supported, false otherwise

decode

public reactor.core.publisher.Flux<java.lang.Object> decode(org.reactivestreams.Publisher<DataBuffer> input,
                                                            ResolvableType elementType,
                                                            @Nullable
                                                            MimeType mimeType,
                                                            @Nullable
                                                            java.util.Map<java.lang.String,java.lang.Object> hints)

Description copied from interface: Decoder

Decode a DataBuffer input stream into a Flux of T.

Specified by:: decode in interface Decoder<java.lang.Object>
Parameters:: input - the DataBuffer input stream to decode; elementType - the expected type of elements in the output stream; this type must have been previously passed to the Decoder.canDecode(org.springframework.core.ResolvableType, org.springframework.util.MimeType) method and it must have returned true.; mimeType - the MIME type associated with the input stream (optional); hints - additional information about how to do encode
Returns:: the output stream with decoded elements

decodeToMono

public reactor.core.publisher.Mono<java.lang.Object> decodeToMono(org.reactivestreams.Publisher<DataBuffer> input,
                                                                  ResolvableType elementType,
                                                                  @Nullable
                                                                  MimeType mimeType,
                                                                  @Nullable
                                                                  java.util.Map<java.lang.String,java.lang.Object> hints)

Description copied from interface: Decoder

Decode a DataBuffer input stream into a Mono of T.

Specified by:: decodeToMono in interface Decoder<java.lang.Object>
Parameters:: input - the DataBuffer input stream to decode; elementType - the expected type of elements in the output stream; this type must have been previously passed to the Decoder.canDecode(org.springframework.core.ResolvableType, org.springframework.util.MimeType) method and it must have returned true.; mimeType - the MIME type associated with the input stream (optional); hints - additional information about how to do encode
Returns:: the output stream with the decoded element

getDecodeHints

public java.util.Map<java.lang.String,java.lang.Object> getDecodeHints(ResolvableType actualType,
                                                                       ResolvableType elementType,
                                                                       ServerHttpRequest request,
                                                                       ServerHttpResponse response)

Description copied from interface: HttpMessageDecoder

Get decoding hints based on the server request or annotations on the target controller method parameter.

Specified by:: getDecodeHints in interface HttpMessageDecoder<java.lang.Object>
Parameters:: actualType - the actual target type to decode to, possibly a reactive wrapper and sourced from MethodParameter, i.e. providing access to method parameter annotations; elementType - the element type within Flux/Mono that we're trying to decode to; request - the current request; response - the current response
Returns:: a Map with hints, possibly empty

getDecodableMimeTypes
```
public java.util.List<MimeType> getDecodableMimeTypes()
```
Description copied from interface: Decoder

Return the list of MIME types this decoder supports.

Specified by:

getDecodableMimeTypes in interface Decoder<java.lang.Object>

getAnnotation

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

Specified by:: getAnnotation in class Jackson2CodecSupport

Class AbstractJackson2Decoder

Field Summary

Fields inherited from class org.springframework.http.codec.json.Jackson2CodecSupport

Constructor Summary

Method Summary

Methods inherited from class org.springframework.http.codec.json.Jackson2CodecSupport

Methods inherited from class java.lang.Object