Class ByteArrayEncoder

java.lang.Object

org.springframework.core.codec.AbstractEncoder<byte[]>

org.springframework.core.codec.ByteArrayEncoder

All Implemented Interfaces:

Encoder<byte[]>

public class ByteArrayEncoder
extends AbstractEncoder<byte[]>

Encoder for byte arrays.

Since:

5.0

Author:

Arjen Poutsma

Field Summary

Fields inherited from class AbstractEncoder

logger

Constructor Summary

Constructors

Constructor	Description
ByteArrayEncoder()

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.
reactor.core.publisher.Flux<DataBuffer>	encode(Publisher<? extends byte[]> 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.
DataBuffer	encodeValue(byte[] bytes, DataBufferFactory bufferFactory, ResolvableType valueType, @Nullable MimeType mimeType, @Nullable Map<String,Object> hints)	Encode an Object of type T to a data buffer.

Methods inherited from class AbstractEncoder

getEncodableMimeTypes, getLogger, setLogger

Methods inherited from class Object

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

Methods inherited from interface Encoder

getEncodableMimeTypes

Constructor Details

ByteArrayEncoder

public ByteArrayEncoder()

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<byte[]>

Overrides:

canEncode in class AbstractEncoder<byte[]>

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 reactor.core.publisher.Flux<DataBuffer> encode(Publisher<? extends byte[]> 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.

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

encodeValue

public DataBuffer encodeValue(byte[] bytes,
 DataBufferFactory bufferFactory,
 ResolvableType valueType,
 @Nullable MimeType mimeType,
 @Nullable Map<String,Object> hints)

Description copied from interface: Encoder

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 (for example, encoding a Resource).

Parameters:

bytes - the value to be encoded

bufferFactory - for creating the output DataBuffer

valueType - the type for the value being encoded

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

hints - additional information about how to encode

Returns:

the encoded content