Package dev.siroshun.codec4j.api.codec.collection

Interface ElementEncoder<E,T>

Type Parameters:

E - the type of the element

T - the type of the source collection to encode

All Superinterfaces:

Encoder<T>

public interface ElementEncoder<E,T>
extends Encoder<T>

An Encoder for encoding elements to an Out.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ElementEncoder.EncodeProcessor<E,C>	An interface for processing elements of the collection.

Method Summary

Modifier and Type	Method	Description
static <E, C extends Iterable<E>> @NotNull Encoder<C>	create(@NotNull Encoder<E> elementEncoder)	Creates an ElementEncoder for encoding elements of ElementEncoder to an Out.
default <O> @NotNull dev.siroshun.jfun.result.Result<O,EncodeError>	encode(@NotNull Out<O> out, @UnknownNullability T input)	Encodes the data from the provided Encoder to the provided Out.
ElementEncoder.EncodeProcessor<E,T>	encodeProcessor()	Returns the ElementEncoder.EncodeProcessor for extracting elements from ElementEncoder and decoding them.

Methods inherited from interface dev.siroshun.codec4j.api.encoder.Encoder

comap, flatComap, toCollectionEncoder, toFieldEncoder, toFieldEncoder

Method Details

create

@NotNull
static <E,
C extends Iterable<E>>
@NotNull Encoder<C> create(@NotNull
 @NotNull Encoder<E> elementEncoder)

Creates an ElementEncoder for encoding elements of ElementEncoder to an Out.

Type Parameters:

E - the type of the element

C - the type of the source collection to encode

Parameters:

elementEncoder - the Encoder for encoding elements of ElementEncoder to an Out

Returns:

an ElementEncoder for encoding elements of ElementEncoder to an Out

encodeProcessor

@NotNull
ElementEncoder.EncodeProcessor<E,T> encodeProcessor()

Returns the ElementEncoder.EncodeProcessor for extracting elements from ElementEncoder and decoding them.

Returns:

the ElementEncoder.EncodeProcessor

encode

@NotNull
default <O>
@NotNull dev.siroshun.jfun.result.Result<O,EncodeError> encode(@NotNull
 @NotNull Out<O> out,
 @UnknownNullability T input)

Description copied from interface: Encoder

Encodes the data from the provided Encoder to the provided Out.

Specified by:

encode in interface Encoder<E>

Type Parameters:

O - the type of the output destination

Parameters:

out - the Out for writing the encoded data

input - the input data to encode

Returns:

a result containing the encoded data, or a EncodeError if the operation failed