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

Interface ElementDecoder.DecodeProcessor<E,C>

Type Parameters:

E - the type of the element

C - the type of the collection to decode elements to

Enclosing interface:

ElementDecoder<E,R>

public static interface ElementDecoder.DecodeProcessor<E,C>

An interface to processing elements of the collection.

Method Summary

Modifier and Type	Method	Description
@NotNull dev.siroshun.jfun.result.Result<Void,DecodeError>	acceptElement(C identity, @UnknownNullability E element)	Accepts the element to the identity object of ElementDecoder.DecodeProcessor.
C	createIdentity()	Creates a ElementDecoder.DecodeProcessor for an identity of In.readList(Object, java.util.function.BiFunction).
@NotNull dev.siroshun.jfun.result.Result<E,DecodeError>	decodeElement(@NotNull In in)	Decodes an element from the provided In.
C	finalizeIdentity(C identity)	Finalizes the identity object of ElementDecoder.DecodeProcessor.

Method Details

decodeElement

@NotNull
@NotNull dev.siroshun.jfun.result.Result<E,DecodeError> decodeElement(@NotNull
 @NotNull In in)

Decodes an element from the provided In.

Parameters:

in - the In for reading the element to decode

Returns:

a result containing the decoded element, or a DecodeError if the operation failed

createIdentity

@NotNull
C createIdentity()

Creates a ElementDecoder.DecodeProcessor for an identity of In.readList(Object, java.util.function.BiFunction).

Returns:

a ElementDecoder.DecodeProcessor for an identity of In.readList(Object, java.util.function.BiFunction)

acceptElement

@NotNull
@NotNull dev.siroshun.jfun.result.Result<Void,DecodeError> acceptElement(@NotNull
 C identity,
 @UnknownNullability E element)

Accepts the element to the identity object of ElementDecoder.DecodeProcessor.

Parameters:

identity - the identity object

element - the element

Returns:

the Result of accepting the element

finalizeIdentity

@NotNull
C finalizeIdentity(@NotNull
 C identity)

Finalizes the identity object of ElementDecoder.DecodeProcessor.

Parameters:

identity - the identity object

Returns:

the final ElementDecoder.DecodeProcessor object