org.springframework.http.codec.xml

Class XmlEventDecoder

java.lang.Object

org.springframework.core.codec.AbstractDecoder<javax.xml.stream.events.XMLEvent>

org.springframework.http.codec.xml.XmlEventDecoder

All Implemented Interfaces:

Decoder<javax.xml.stream.events.XMLEvent>

public class XmlEventDecoder
extends AbstractDecoder<javax.xml.stream.events.XMLEvent>

Decodes a DataBuffer stream into a stream of XMLEvents.

Given the following XML:

 <root>
     <child>foo</child>
     <child>bar</child>
 </root>
 

this decoder will produce a Flux with the following events:

1. StartDocument
2. StartElement root
3. StartElement child
4. Characters foo
5. EndElement child
6. StartElement child
7. Characters bar
8. EndElement child
9. EndElement root

Note that this decoder is not registered by default but is used internally by other decoders which are registered by default.

Since:

5.0

Author:

Arjen Poutsma

Constructor Summary

Constructors

Constructor and Description
XmlEventDecoder()

Method Summary

Modifier and Type	Method and Description
reactor.core.publisher.Flux<javax.xml.stream.events.XMLEvent>	decode(org.reactivestreams.Publisher<DataBuffer> inputStream, ResolvableType elementType, MimeType mimeType, java.util.Map<java.lang.String,java.lang.Object> hints) Decode a DataBuffer input stream into a Flux of T.

Methods inherited from class org.springframework.core.codec.AbstractDecoder

canDecode, decodeToMono, getDecodableMimeTypes

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlEventDecoder

public XmlEventDecoder()

Method Detail

decode

public reactor.core.publisher.Flux<javax.xml.stream.events.XMLEvent> decode(org.reactivestreams.Publisher<DataBuffer> inputStream,
                                                                            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.

Parameters:

inputStream - 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