Decoder (datafixerupper 4.0.0-SNAPSHOT API)

Type Parameters:

A - The type this Decoder deserializes.

All Known Subinterfaces:

Codec<A>, PrimitiveCodec<A>

All Known Implementing Classes:

CompoundListCodec, EitherCodec, ListCodec, MapCodec.MapCodecCodec, PairCodec, UnboundedMapCodec
```
public interface Decoder<A>
```
Deserializes (decodes) objects of a given type from a serialized form.
A Decoder is used to transform objects from some serialized representation to a specific type using a supplied DynamicOps. Decoders encapsulate the deserialization routine for a specific type, regardless of the input serialization form.
Implementations of Decoder are immutable once created. The methods defined in this interface never mutate the decoder in a way visible to the outside.

Implementation Note:

The default methods in this interface that return decoders or map decoders wrap this decoder without adding any debugging context. These methods should be overridden if deeply nested decoders are undesirable or additional debugging context is desired.

See Also:

Encoder, Codec

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`Decoder.Boxed<A>` A simple decoder interface that decodes an object from a `Dynamic`.
`static interface`	`Decoder.Simple<A>` A simple decoder interface that completely decodes an object from a `Dynamic`, discarding any remaining serialized data.
`static interface`	`Decoder.Terminal<A>` A simple decoder interface that discards any serialized input that was not used to decode the object.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default Decoder.Boxed<A>`	`boxed()` Creates a `Decoder.Boxed` from this `Decoder`.
`default <T> DataResult<(A,T)>`	`decode(Dynamic<T> input)` Decodes an object from the specified `Dynamic` data.
`<T> DataResult<(A,T)>`	`decode(DynamicOps<T> ops, T input)` Decodes an object from the specified serialized data.
`static <A> Decoder<A>`	`error(String error)` An `Decoder` that performs no deserialization.
`default MapDecoder<A>`	`fieldOf(String name)` Returns a `MapDecoder` that decodes objects in a record under a field with the given name.
`default <B> Decoder<B>`	`flatMap((? super A) -> ? extends DataResult<? extends B> function)` Transforms this decoder to operate on a different type using the given `DataResult`-producing mapping function.
`default <B> Decoder<B>`	`map((? super A) -> ? extends B function)` Transforms this decoder to operate on a different type using the given mapping function.
`static <A> Decoder<A>`	`ofBoxed(Decoder.Boxed<? extends A> boxed)` Creates a `Decoder` from the given `Decoder.Boxed`.
`static <A> Decoder<A>`	`ofSimple(Decoder.Simple<? extends A> simple)` Creates a `Decoder` from the given `Decoder.Simple`.
`static <A> Decoder<A>`	`ofTerminal(Decoder.Terminal<? extends A> terminal)` Creates a `Decoder` from the given `Decoder.Terminal`.
`default <T> DataResult<A>`	`parse(Dynamic<T> input)` Decodes an object from the specified `Dynamic` data, discarding any remaining data.
`default <T> DataResult<A>`	`parse(DynamicOps<T> ops, T input)` Decodes an object from the specified serialized data, discarding any remaining data.
`default Decoder<A>`	`promotePartial((String) -> void onError)` Returns a `Decoder` that returns the partial decoded result in this decoder returns an error.
`default Decoder.Simple<A>`	`simple()` Creates a `Decoder.Simple` from this `Decoder`.
`default Decoder.Terminal<A>`	`terminal()` Creates a `Decoder.Terminal` from this `Decoder`.
`static <A> MapDecoder<A>`	`unit(A instance)` A `MapDecoder` that performs no deserialization and always returns the given value.
`static <A> MapDecoder<A>`	`unit(by-name A instance)` A `MapDecoder` that performs no deserialization and always returns a supplied value.
`default Decoder<A>`	`withLifecycle(Lifecycle lifecycle)` Sets the `Lifecycle` for the serialized data this decoder produces.

- Method Detail
  - decode
```
<T> DataResult<(A,T)> decode(DynamicOps<T> ops,
                             T input)
```
    Decodes an object from the specified serialized data. If decoding fails, returns an error DataResult.
    
    Type Parameters:
    
    T - The type of the serialized form.
    
    Parameters:
    
    ops - The DynamicOps instance defining the serialized form.
    
    input - The serialized data.
    
    Returns:
    
    A Pair containing the decoded object and the remaining serialized data, wrapped in a DataResult.
  - parse
```
default <T> DataResult<A> parse(DynamicOps<T> ops,
                                T input)
```
    Decodes an object from the specified serialized data, discarding any remaining data. If decoding fails, returns an error DataResult.
    For preserving remaining serialize data, use decode(DynamicOps, Object).
    
    Implementation Requirements:
    
    The default implementation is equivalent to decode(ops, input).map(Pair::getFirst).
    
    Type Parameters:
    
    T - The type of the serialized form.
    
    Parameters:
    
    ops - The DynamicOps instance defining the serialized form.
    
    input - The serialized data.
    
    Returns:
    
    A DataResult containing the decoded object.
  - decode
```
default <T> DataResult<(A,T)> decode(Dynamic<T> input)
```
    Decodes an object from the specified Dynamic data. If decoding fails, returns an error DataResult.
    
    Implementation Requirements:
    
    The default implementation is equivalent to calling decode(DynamicOps, Object) on the wrapped ops and value.
    
    Type Parameters:
    
    T - The type of the serialized form.
    
    Parameters:
    
    input - The serialized data.
    
    Returns:
    
    A DataResult containing a pair or the decoded object and any remaining serialized data.
    
    See Also:
    
    decode(DynamicOps, Object)
  - parse
```
default <T> DataResult<A> parse(Dynamic<T> input)
```
    Decodes an object from the specified Dynamic data, discarding any remaining data. If decoding fails, returns an error DataResult.
    
    Implementation Requirements:
    
    The default implementation is equivalent to decode(input).map(Pair::getFirst).
    
    Type Parameters:
    
    T - The type of the serialized form.
    
    Parameters:
    
    input - The serialized data.
    
    Returns:
    
    A DataResult containing the decoded object.
  - terminal
```
default Decoder.Terminal<A> terminal()
```
    Creates a Decoder.Terminal from this Decoder.
    
    Implementation Requirements:
    
    The default implementation returns a Decoder.Terminal based on parse(DynamicOps, Object).
  - boxed
```
default Decoder.Boxed<A> boxed()
```
    Creates a Decoder.Boxed from this Decoder.
    
    Implementation Requirements:
    
    The default implementation returns a Decoder.Boxed based on decode(Dynamic).
  - simple
```
default Decoder.Simple<A> simple()
```
    Creates a Decoder.Simple from this Decoder.
    
    Implementation Requirements:
    
    The default implementation returns a Decoder.Simple based on parse(Dynamic).
  - fieldOf
```
default MapDecoder<A> fieldOf(String name)
```
    Returns a MapDecoder that decodes objects in a record under a field with the given name. The returned MapDecoder may be used in conjunction with a partially deserialized MapLike to deserialize many different fields, all using different decoders, from a single record.
    
    Implementation Requirements:
    
    The default implementation returns a FieldDecoder wrapping this decoder.
    
    Parameters:
    
    name - The field to decode objects from.
    
    Returns:
    
    A MapDecoder that performs the same decoding as this decoder, but takes the serialized value from a record under the given field.
    
    See Also:
    
    MapLike
  - flatMap
```
default <B> Decoder<B> flatMap((? super A) -> ? extends DataResult<? extends B> function)
```
    Transforms this decoder to operate on a different type using the given DataResult-producing mapping function.
    
    API Note:
    
    This method implements a flat map for Decoder.
    
    Implementation Requirements:
    
    The default implementation returns another Decoder that wraps this decoder.
    
    Type Parameters:
    
    B - The new type of the decoder.
    
    Parameters:
    
    function - A function transforming the old type to the new type. Errors from this decoder and from the function are merged.
    
    Returns:
    
    A decoder that operates on the type B.
    
    See Also:
    
    map(Function)
  - map
```
default <B> Decoder<B> map((? super A) -> ? extends B function)
```
    Transforms this decoder to operate on a different type using the given mapping function.
    
    API Note:
    
    This method implements a map for Decoder.
    
    Implementation Requirements:
    
    The default implementation returns another Decoder that wraps this decoder.
    
    Type Parameters:
    
    B - The new type of the decoder.
    
    Parameters:
    
    function - A function transforming the old type to the new type.
    
    Returns:
    
    A decoder that operates on the type B.
  - promotePartial
```
default Decoder<A> promotePartial((String) -> void onError)
```
    Returns a Decoder that returns the partial decoded result in this decoder returns an error.
    
    Implementation Requirements:
    
    The default implementation returns another Decoder that wraps this decoder.
    
    Parameters:
    
    onError - A callback to run if an error occurs when decoding. The function receives the error message as its argument.
    
    Returns:
    
    A Decoder that promotes any partial result to a successful decoded result.
    
    See Also:
    
    DataResult.promotePartial(Consumer)
  - withLifecycle
```
default Decoder<A> withLifecycle(Lifecycle lifecycle)
```
    Sets the Lifecycle for the serialized data this decoder produces.
    
    Implementation Requirements:
    
    The default implementation returns another Decoder that wraps this decoder.
    
    Parameters:
    
    lifecycle - the lifecycle to use.
    
    Returns:
    
    A decoder equivalent to this decoder but with the given lifecycle.
    
    See Also:
    
    Lifecycle
  - ofTerminal
```
static <A> Decoder<A> ofTerminal(Decoder.Terminal<? extends A> terminal)
```
    Creates a Decoder from the given Decoder.Terminal.
    
    Type Parameters:
    
    A - The type to decode into.
    
    Parameters:
    
    terminal - The terminal decoder.
    
    Returns:
    
    A Decoder from the given terminal decoder.
    
    See Also:
    
    Decoder.Terminal.decoder()
  - ofBoxed
```
static <A> Decoder<A> ofBoxed(Decoder.Boxed<? extends A> boxed)
```
    Creates a Decoder from the given Decoder.Boxed.
    
    Type Parameters:
    
    A - The type to decode into.
    
    Parameters:
    
    boxed - The boxed decoder.
    
    Returns:
    
    A Decoder from the given boxed decoder.
    
    See Also:
    
    Decoder.Boxed.decoder()
  - ofSimple
```
static <A> Decoder<A> ofSimple(Decoder.Simple<? extends A> simple)
```
    Creates a Decoder from the given Decoder.Simple.
    
    Type Parameters:
    
    A - The type to decode into.
    
    Parameters:
    
    simple - The simple decoder.
    
    Returns:
    
    A Decoder from the given simple decoder.
    
    See Also:
    
    Decoder.Simple.decoder()
  - unit
```
static <A> MapDecoder<A> unit(A instance)
```
    A MapDecoder that performs no deserialization and always returns the given value. Its MapDecoder.decode(DynamicOps, MapLike) decoding} method always returns the instance and its key stream is always empty.
    
    Type Parameters:
    
    A - The type of the instance.
    
    Parameters:
    
    instance - The instance to return from the decoder.
    
    Returns:
    
    A MapDecoder that always returns the given value.
    
    See Also:
    
    unit(Supplier)
  - unit
```
static <A> MapDecoder<A> unit(by-name A instance)
```
    A MapDecoder that performs no deserialization and always returns a supplied value. Its MapDecoder.decode(DynamicOps, MapLike) decoding} method always returns a value generated from the supplier and its key stream is always empty.
    
    Type Parameters:
    
    A - The type of values to decode.
    
    Parameters:
    
    instance - A Supplier that returns instances to return from the decoder.
    
    Returns:
    
    A MapDecoder that always returns supplied values.
  - error
```
static <A> Decoder<A> error(String error)
```
    An Decoder that performs no deserialization. Its decoding method always returns the given error.
    
    Type Parameters:
    
    A - The type the returned decoder operates on.
    
    Parameters:
    
    error - The error the returned decoder should produce.
    
    Returns:
    
    An Decoder that performs no deserialization.

Interface Decoder<A>

Nested Class Summary

Method Summary

Method Detail

decode

parse

decode

parse

terminal

boxed

simple

fieldOf

flatMap

map

promotePartial

withLifecycle

ofTerminal

ofBoxed

ofSimple

unit

unit

error