接口 Encoder<T>
- 类型参数:
T
- the type of elements in the input stream
- 所有已知子接口:
HttpMessageEncoder<T>
- 所有已知实现类:
AbstractEncoder
,AbstractJackson2Encoder
,AbstractSingleValueEncoder
,ByteArrayEncoder
,ByteBufferEncoder
,CharSequenceEncoder
,DataBufferEncoder
,Jackson2CborEncoder
,Jackson2JsonEncoder
,Jackson2SmileEncoder
,Jaxb2XmlEncoder
,ProtobufEncoder
,ResourceEncoder
,ResourceRegionEncoder
public interface Encoder<T>
Strategy to encode a stream of Objects of type<T>
into an output stream of bytes.- 从以下版本开始:
- 5.0
- 作者:
- Sebastien Deleuze, Rossen Stoyanchev
方法概要
所有方法 实例方法 抽象方法 默认方法 修饰符和类型 方法 说明 boolean
canEncode(ResolvableType elementType, MimeType mimeType)
Whether the encoder supports the given source element type and the MIME type for the output stream.reactor.core.publisher.Flux<DataBuffer>
encode(org.reactivestreams.Publisher<? extends T> inputStream, DataBufferFactory bufferFactory, ResolvableType elementType, MimeType mimeType, Map<String,Object> hints)
Encode a stream of Objects of typeT
into aDataBuffer
output stream.default DataBuffer
encodeValue(T value, DataBufferFactory bufferFactory, ResolvableType valueType, MimeType mimeType, Map<String,Object> hints)
Encode an Object of type T to a data buffer.List<MimeType>
getEncodableMimeTypes()
Return the list of mime types this encoder supports.
方法详细资料
canEncode
boolean canEncode(ResolvableType elementType, @Nullable MimeType mimeType)
Whether the encoder supports the given source element type and the MIME type for the output stream.- 参数:
elementType
- the type of elements in the source streammimeType
- the MIME type for the output stream (can benull
if not specified)- 返回:
true
if supported,false
otherwise
encode
reactor.core.publisher.Flux<DataBuffer> encode(org.reactivestreams.Publisher<? extends T> inputStream, DataBufferFactory bufferFactory, ResolvableType elementType, @Nullable MimeType mimeType, @Nullable Map<String,Object> hints)
Encode a stream of Objects of typeT
into aDataBuffer
output stream.- 参数:
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 ofMono
should be used.bufferFactory
- for creating output streamDataBuffer
'selementType
- the expected type of elements in the input stream; this type must have been previously passed to thecanEncode(org.springframework.core.ResolvableType, org.springframework.util.MimeType)
method and it must have returnedtrue
.mimeType
- the MIME type for the output content (optional)hints
- additional information about how to encode- 返回:
- the output stream
encodeValue
default DataBuffer encodeValue(T value, DataBufferFactory bufferFactory, ResolvableType valueType, @Nullable MimeType mimeType, @Nullable Map<String,Object> hints)
Encode an Object of type T to a data buffer. This is useful for scenarios, that distinct messages (or events) are encoded and handled individually, in fully aggregated form.By default this method raises
UnsupportedOperationException
and it is expected that some encoders cannot produce a single buffer or cannot do so synchronously (e.g. encoding aResource
).- 参数:
value
- the value to be encodedbufferFactory
- for creating the outputDataBuffer
valueType
- the type for the value being encodedmimeType
- the MIME type for the output content (optional)hints
- additional information about how to encode- 返回:
- the encoded content
- 从以下版本开始:
- 5.2
getEncodableMimeTypes
List<MimeType> getEncodableMimeTypes()
Return the list of mime types this encoder supports.