Class JacksonXmlEncoder

java.lang.Object

org.springframework.http.codec.JacksonCodecSupport<tools.jackson.dataformat.xml.XmlMapper>

org.springframework.http.codec.AbstractJacksonEncoder<tools.jackson.dataformat.xml.XmlMapper>

org.springframework.http.codec.xml.JacksonXmlEncoder

All Implemented Interfaces:

Encoder<Object>, HttpMessageEncoder<Object>

public class JacksonXmlEncoder
extends AbstractJacksonEncoder<tools.jackson.dataformat.xml.XmlMapper>

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

Stream encoding is currently not supported.

Since:

7.0.3

Author:

Sebastien Deleuze

See Also:

• JacksonXmlDecoder

Field Summary

Fields inherited from class JacksonCodecSupport

FILTER_PROVIDER_HINT, JSON_VIEW_HINT, logger, mapperRegistrations

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
boolean	canEncode(ResolvableType elementType, @Nullable MimeType mimeType)	Whether the encoder supports the given source element type and the MIME type for the output stream.
Flux<DataBuffer>	encode(Publisher<?> inputStream, DataBufferFactory bufferFactory, ResolvableType elementType, @Nullable MimeType mimeType, @Nullable Map<String,Object> hints)	Encode a stream of Objects of type T into a DataBuffer output stream.

Methods inherited from class AbstractJacksonEncoder

customizeWriter, encodeValue, getAnnotation, getEncodableMimeTypes, getEncodableMimeTypes, getEncodeHints, getJsonEncoding, getStreamingMediaTypes, getStreamingMediaTypeSeparator, setStreamingMediaTypes

Methods inherited from class JacksonCodecSupport

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

Methods inherited from class Object

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

Constructor Details

JacksonXmlEncoder

public JacksonXmlEncoder()

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

JacksonXmlEncoder

public JacksonXmlEncoder(tools.jackson.dataformat.xml.XmlMapper.Builder builder)

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

See Also:

• XmlMapper.builder()

JacksonXmlEncoder

public JacksonXmlEncoder(tools.jackson.dataformat.xml.XmlMapper mapper)

Construct a new instance with the provided XmlMapper.

See Also:

• XmlMapper.builder()

JacksonXmlEncoder

public JacksonXmlEncoder(tools.jackson.dataformat.xml.XmlMapper.Builder builder,
 MimeType... mimeTypes)

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

See Also:

• XmlMapper.builder()

JacksonXmlEncoder

public JacksonXmlEncoder(tools.jackson.dataformat.xml.XmlMapper mapper,
 MimeType... mimeTypes)

Construct a new instance with the provided XmlMapper and MimeTypes.

See Also:

• XmlMapper.builder()

Method Details

canEncode

public boolean canEncode(ResolvableType elementType,
 @Nullable MimeType mimeType)

Description copied from interface: Encoder

Whether the encoder supports the given source element type and the MIME type for the output stream.

Specified by:

canEncode in interface Encoder<Object>

Overrides:

canEncode in class AbstractJacksonEncoder<tools.jackson.dataformat.xml.XmlMapper>

Parameters:

elementType - the type of elements in the source stream

mimeType - the MIME type for the output stream (can be null if not specified)

Returns:

true if supported, false otherwise

encode

public Flux<DataBuffer> encode(Publisher<?> inputStream,
 DataBufferFactory bufferFactory,
 ResolvableType elementType,
 @Nullable MimeType mimeType,
 @Nullable Map<String,Object> hints)

Description copied from interface: Encoder

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

Specified by:

encode in interface Encoder<Object>

Overrides:

encode in class AbstractJacksonEncoder<tools.jackson.dataformat.xml.XmlMapper>

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