Class JacksonSmileEncoder

java.lang.Object

org.springframework.http.codec.JacksonCodecSupport

org.springframework.http.codec.AbstractJacksonEncoder

org.springframework.http.codec.smile.JacksonSmileEncoder

All Implemented Interfaces:

Encoder<Object>, HttpMessageEncoder<Object>

public class JacksonSmileEncoder
extends AbstractJacksonEncoder

Encode from an Object stream to a byte stream of Smile objects using Jackson 3.x.

For non-streaming use cases, Flux elements are collected into a List before serialization for performance reasons.

The default constructor loads JacksonModules found by MapperBuilder.findModules(ClassLoader).

Since:

7.0

Author:

Sebastien Deleuze

See Also:

• JacksonSmileDecoder

Field Summary

Fields inherited from class org.springframework.http.codec.JacksonCodecSupport

FILTER_PROVIDER_HINT, JSON_VIEW_HINT, logger, objectMapperRegistrations

Constructor Summary

Constructors

Constructor	Description
JacksonSmileEncoder()	Construct a new instance with a SmileMapper customized with the JacksonModules found by MapperBuilder.findModules(ClassLoader).
JacksonSmileEncoder(tools.jackson.dataformat.smile.SmileMapper mapper)	Construct a new instance with the provided SmileMapper.
JacksonSmileEncoder(tools.jackson.dataformat.smile.SmileMapper mapper, MimeType... mimeTypes)	Construct a new instance with the provided SmileMapper and MimeTypes.

Method Summary

Modifier and Type	Method	Description
protected byte @Nullable []	getStreamingMediaTypeSeparator(@Nullable MimeType mimeType)	Return the separator to use for the given mime type.

Methods inherited from class org.springframework.http.codec.AbstractJacksonEncoder

canEncode, customizeWriter, encode, encodeValue, getAnnotation, getEncodableMimeTypes, getEncodableMimeTypes, getEncodeHints, getJsonEncoding, getStreamingMediaTypes, setStreamingMediaTypes

Methods inherited from class org.springframework.http.codec.JacksonCodecSupport

getHints, getJavaType, getMediaTypesForProblemDetail, getMimeTypes, getMimeTypes, getObjectMapper, getObjectMapperRegistrations, getObjectMappersForType, getParameter, registerObjectMappersForType, selectObjectMapper, supportsMimeType

Methods inherited from class java.lang.Object

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

Constructor Details

JacksonSmileEncoder

public JacksonSmileEncoder()

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

JacksonSmileEncoder

public JacksonSmileEncoder(tools.jackson.dataformat.smile.SmileMapper mapper)

Construct a new instance with the provided SmileMapper.

See Also:

• SmileMapper.builder()
• MapperBuilder.findAndAddModules(ClassLoader)

JacksonSmileEncoder

public JacksonSmileEncoder(tools.jackson.dataformat.smile.SmileMapper mapper,
 MimeType... mimeTypes)

Construct a new instance with the provided SmileMapper and MimeTypes.

See Also:

• SmileMapper.builder()
• MapperBuilder.findAndAddModules(ClassLoader)

Method Details

getStreamingMediaTypeSeparator

protected byte @Nullable [] getStreamingMediaTypeSeparator(@Nullable MimeType mimeType)

Return the separator to use for the given mime type.

By default, this method returns a single byte 0 if the given mime type is one of the configured streaming mime types.

Overrides:

getStreamingMediaTypeSeparator in class AbstractJacksonEncoder