Class JacksonCborEncoder

java.lang.Object

org.springframework.http.codec.JacksonCodecsupport<tools.jackson.dataformat.cbor.CBORMapper>

org.springframework.http.codec.AbstractJacksonEncoder<tools.jackson.dataformat.cbor.CBORMapper>

org.springframework.http.codec.cbor.JacksonCborEncoder

All Implemented Interfaces:

Encoder<Object>, HttpMessageEncoder<Object>

public class JacksonCborEncoder
extends AbstractJacksonEncoder<tools.jackson.dataformat.cbor.CBORMapper>

Encode from an Object to bytes of CBOR objects using Jackson 3.x.

stream encoding is currently not supported.

since:

7.0

Author:

sebastien Deleuze

see Also:

• JacksonCborDecoder
• Add CBOR support to WebFlux

Field summary

Fields inherited from class&nbsp;JacksonCodecsupport

FILTER_PROVIDER_HINT, JsON_VIEW_HINT, logger, mapperRegistrations

Constructor summary

Constructors

Constructor	Description
JacksonCborEncoder()	Construct a new instance with a CBORMapper customized with the JacksonModules found by MapperBuilder.findModules(ClassLoader).
JacksonCborEncoder(tools.jackson.dataformat.cbor.CBORMapper mapper)	Construct a new instance with the provided CBORMapper.
JacksonCborEncoder(tools.jackson.dataformat.cbor.CBORMapper.Builder builder)	Construct a new instance with the provided CBORMapper.Builder customized with the JacksonModules found by MapperBuilder.findModules(ClassLoader).
JacksonCborEncoder(tools.jackson.dataformat.cbor.CBORMapper.Builder builder, MimeType... mimeTypes)	Construct a new instance with the provided CBORMapper.Builder customized with the JacksonModules found by MapperBuilder.findModules(ClassLoader), and MimeTypes.
JacksonCborEncoder(tools.jackson.dataformat.cbor.CBORMapper mapper, MimeType... mimeTypes)	Construct a new instance with the provided CBORMapper and MimeTypes.

Method summary

Modifier and Type	Method	Description
reactor.core.publisher.Flux<DataBuffer>	encode(Publisher<?>&nbsp;inputstream, DataBufferFactory&nbsp;bufferFactory, ResolvableType&nbsp;elementType, @Nullable MimeType&nbsp;mimeType, @Nullable Map<string,Object>&nbsp;hints)	Encode a stream of Objects of type T into a DataBuffer output stream.

Methods inherited from class&nbsp;AbstractJacksonEncoder

canEncode, customizeWriter, encodeValue, getAnnotation, getEncodableMimeTypes, getEncodableMimeTypes, getEncodeHints, getJsonEncoding, getstreamingMediaTypes, getstreamingMediaTypeseparator, setstreamingMediaTypes

Methods inherited from class&nbsp;JacksonCodecsupport

getHints, getJavaType, getMapper, getMapperRegistrations, getMappersForType, getMediaTypesForProblemDetail, getMimeTypes, getMimeTypes, getParameter, registerMappersForType, selectMapper, supportsMimeType

Methods inherited from class&nbsp;Object

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

Constructor Details

JacksonCborEncoder

public JacksonCborEncoder()

Construct a new instance with a CBORMapper customized with the JacksonModules found by MapperBuilder.findModules(ClassLoader).

JacksonCborEncoder

public JacksonCborEncoder(tools.jackson.dataformat.cbor.CBORMapper.Builder builder)

Construct a new instance with the provided CBORMapper.Builder customized with the JacksonModules found by MapperBuilder.findModules(ClassLoader).

see Also:

• CBORMapper.builder()

JacksonCborEncoder

public JacksonCborEncoder(tools.jackson.dataformat.cbor.CBORMapper mapper)

Construct a new instance with the provided CBORMapper.

see Also:

• CBORMapper.builder()

JacksonCborEncoder

public JacksonCborEncoder(tools.jackson.dataformat.cbor.CBORMapper.Builder builder,
 MimeType... mimeTypes)

Construct a new instance with the provided CBORMapper.Builder customized with the JacksonModules found by MapperBuilder.findModules(ClassLoader), and MimeTypes.

see Also:

• CBORMapper.builder()

JacksonCborEncoder

public JacksonCborEncoder(tools.jackson.dataformat.cbor.CBORMapper mapper,
 MimeType... mimeTypes)

Construct a new instance with the provided CBORMapper and MimeTypes.

see Also:

• CBORMapper.builder()

Method Details

encode

public&nbsp;reactor.core.publisher.Flux<DataBuffer>&nbsp;encode(Publisher<?>&nbsp;inputstream,
 DataBufferFactory&nbsp;bufferFactory,
 ResolvableType&nbsp;elementType,
 @Nullable MimeType&nbsp;mimeType,
 @Nullable Map<string,Object>&nbsp;hints)

Description copied from interface:&nbsp;Encoder

Encode a stream of Objects of type T into a DataBuffer output stream.

specified by:

encode&nbsp;in interface&nbsp;Encoder<Object>

Overrides:

encode&nbsp;in class&nbsp;AbstractJacksonEncoder<tools.jackson.dataformat.cbor.CBORMapper>

Parameters:

inputstream - the input stream of Objects to encode. If the input should be encoded as a single value rather than as a stream of elements, an instance of Mono should be used.

bufferFactory - for creating output stream DataBuffer's

elementType - the expected type of elements in the input stream; this type must have been previously passed to the Encoder.canEncode(ResolvableType, MimeType) method and it must have returned true.

mimeType - the MIME type for the output content (optional)

hints - additional information about how to encode

Returns:

the output stream