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

Interface EntryEncoder<E,T>

Type Parameters:

E - the type of the entry

T - the type of the source collection to encode

All Superinterfaces:

Encoder<T>

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

An Encoder for encoding entries to an Out.

Method Summary

Modifier and Type	Method	Description
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.
@NotNull EntryProcessor<?,?,E,T>	processor()	Returns the EntryProcessor for extracting entries from EntryEncoder and decoding them.

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

comap, flatComap, toCollectionEncoder, toFieldEncoder, toFieldEncoder

Method Details

processor

@NotNull
@NotNull EntryProcessor<?,?,E,T> processor()

Returns the EntryProcessor for extracting entries from EntryEncoder and decoding them.

Returns:

the EntryProcessor

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