Package dev.siroshun.codec4j.api.codec

Interface Codec<T>

Type Parameters:

T - the type of the data

All Superinterfaces:

Decoder<T>, Encoder<T>

All Known Implementing Classes:

MapCodec

public interface Codec<T>
extends Encoder<T>, Decoder<T>

An interface for encoding and decoding data.

Field Summary

Fields

Modifier and Type	Field	Description
static final Codec<Boolean>	BOOLEAN	A Codec for Boolean.
static final Codec<Byte>	BYTE	A Codec for Byte.
static final Codec<Character>	CHAR	A Codec for Character.
static final Codec<Double>	DOUBLE	A Codec for Double.
static final Codec<Float>	FLOAT	A Codec for Float.
static final Codec<Integer>	INT	A Codec for Integer.
static final Codec<Long>	LONG	A Codec for Long.
static final Codec<Short>	SHORT	A Codec for Short.
static final Codec<String>	STRING	A Codec for String.

Method Summary

Modifier and Type	Method	Description
static <T> @NotNull Codec<T>	byValueType(Type.Value<T> type)	Gets the Codec of the specified Type.Value.
static <A> @NotNull Codec<A>	codec(@NotNull Encoder<? super A> encoder, @NotNull Decoder<? extends A> decoder)	Creates a new Codec with the specified Encoder and Decoder.
static <A> @NotNull Codec<A>	codec(@NotNull Encoder<? super A> encoder, @NotNull Decoder<? extends A> decoder, @NotNull String name)	Creates a new Codec with the specified Encoder, Decoder and name.
default <A> @NotNull Codec<A>	flatXmap(@NotNull Function<? super A,dev.siroshun.jfun.result.Result<T,EncodeError>> fromA, @NotNull Function<? super T,dev.siroshun.jfun.result.Result<A,DecodeError>> toA)	Maps the data from the provided Codec to another type and flattens the Result.
default @NotNull Codec<T>	named(@NotNull String name)	Creates a new Codec with the specified name and this Codec as the delegate codec.
default @NotNull Codec<Collection<T>>	toCollectionCodec()	Creates a new Codec for Collection of Codec.
default @NotNull FieldCodecBuilder<T>	toFieldCodec(@NotNull String fieldName)	Creates a new FieldCodecBuilder for Codec.
default @NotNull Codec<List<T>>	toListCodec()	Creates a new Codec for List of Codec.
default <V> @NotNull Codec<Map<T,V>>	toMapCodecAsKey(@NotNull Codec<V> valueCodec)	Creates a new Codec for Map of Codec as a key.
default <K> @NotNull Codec<Map<K,T>>	toMapCodecAsValue(@NotNull Codec<K> keyCodec)	Creates a new Codec for Map of Codec as a value.
default @NotNull Codec<Set<T>>	toSetCodec()	Creates a new Codec for Set of Codec.
default <A> @NotNull Codec<A>	xmap(@NotNull Function<? super A,? extends T> fromA, @NotNull Function<? super T,? extends A> toA)	Maps the data from the provided Codec to another type.

Methods inherited from interface dev.siroshun.codec4j.api.decoder.Decoder

catchError, decode, flatMap, inspect, map, toListDecoder, toOptionalFieldDecoder, toRequiredFieldDecoder, toSetDecoder, toSetDecoder, toSupplyingFieldDecoder

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

comap, encode, flatComap, toCollectionEncoder, toFieldEncoder, toFieldEncoder

Field Details

BOOLEAN

static final Codec<Boolean> BOOLEAN

A Codec for Boolean.

This Codec calls Out.writeBoolean(boolean) for encoding, and In.readAsBoolean() for decoding.

BYTE

static final Codec<Byte> BYTE

A Codec for Byte.

This Codec calls Out.writeByte(byte) for encoding, and In.readAsByte() for decoding.

CHAR

static final Codec<Character> CHAR

A Codec for Character.

This Codec calls Out.writeByte(byte) for encoding, and In.readAsChar() for decoding.

DOUBLE

static final Codec<Double> DOUBLE

A Codec for Double.

This Codec calls Out.writeDouble(double) for encoding, and In.readAsDouble() for decoding.

FLOAT

static final Codec<Float> FLOAT

A Codec for Float.

This Codec calls Out.writeFloat(float) for encoding, and In.readAsFloat() for decoding.

INT

static final Codec<Integer> INT

A Codec for Integer.

This Codec calls Out.writeInt(int) for encoding, and In.readAsInt() for decoding.

LONG

static final Codec<Long> LONG

A Codec for Long.

This Codec calls Out.writeLong(long) for encoding, and In.readAsLong() for decoding.

SHORT

static final Codec<Short> SHORT

A Codec for Short.

This Codec calls Out.writeShort(short) for encoding, and In.readAsShort() for decoding.

STRING

static final Codec<String> STRING

A Codec for String.

This Codec calls Out.writeString(String) for encoding, and In.readAsString() for decoding.

Method Details

codec

@Contract(value="_, _ -> new",
          pure=true)
@NotNull
static <A> @NotNull Codec<A> codec(@NotNull
 @NotNull Encoder<? super A> encoder,
 @NotNull
 @NotNull Decoder<? extends A> decoder)

Creates a new Codec with the specified Encoder and Decoder.

Type Parameters:

A - the type of the data

Parameters:

encoder - the Encoder for encoding the data

decoder - the Decoder for decoding the data

Returns:

a new Codec with the specified Encoder and Decoder

codec

@Contract(value="_, _, _ -> new",
          pure=true)
@NotNull
static <A> @NotNull Codec<A> codec(@NotNull
 @NotNull Encoder<? super A> encoder,
 @NotNull
 @NotNull Decoder<? extends A> decoder,
 @NotNull
 @NotNull String name)

Creates a new Codec with the specified Encoder, Decoder and name.

Type Parameters:

A - the type of the data

Parameters:

encoder - the Encoder for encoding the data

decoder - the Decoder for decoding the data

name - the name of the new Codec

Returns:

a new Codec with the specified Encoder, Decoder and name

xmap

@NotNull
default <A> @NotNull Codec<A> xmap(@NotNull
 @NotNull Function<? super A,? extends T> fromA,
 @NotNull
 @NotNull Function<? super T,? extends A> toA)

Maps the data from the provided Codec to another type.

Type Parameters:

A - the type of the mapped data

Parameters:

fromA - the Function to map the data from the provided Codec to another type

toA - the Function to map the data from another type to the provided Codec

Returns:

a new Codec that maps the data from the provided Codec to another type

flatXmap

@NotNull
default <A> @NotNull Codec<A> flatXmap(@NotNull
 @NotNull Function<? super A,dev.siroshun.jfun.result.Result<T,EncodeError>> fromA,
 @NotNull
 @NotNull Function<? super T,dev.siroshun.jfun.result.Result<A,DecodeError>> toA)

Maps the data from the provided Codec to another type and flattens the Result.

Type Parameters:

A - the type of the mapped data

Parameters:

fromA - the Function to map the data from the provided Codec to another type and returns a Result of the mapping

toA - the Function to map the data from another type to the provided Codec and returns a Result of the mapping

Returns:

a new Codec that maps the data from the provided Codec to another type and flattens the Result

named

@NotNull
default @NotNull Codec<T> named(@NotNull
 @NotNull String name)

Creates a new Codec with the specified name and this Codec as the delegate codec.

Parameters:

name - the name of the new Codec

Returns:

a named Codec with this Codec as the delegate codec

toListCodec

@NotNull
default @NotNull Codec<List<T>> toListCodec()

Creates a new Codec for List of Codec.

Returns:

a new Codec for List of Codec

toSetCodec

@NotNull
default @NotNull Codec<Set<T>> toSetCodec()

Creates a new Codec for Set of Codec.

Returns:

a new Codec for Set of Codec

toCollectionCodec

@NotNull
default @NotNull Codec<Collection<T>> toCollectionCodec()

Creates a new Codec for Collection of Codec.

Returns:

a new Codec for Collection of Codec

toMapCodecAsKey

@NotNull
default <V> @NotNull Codec<Map<T,V>> toMapCodecAsKey(@NotNull
 @NotNull Codec<V> valueCodec)

Creates a new Codec for Map of Codec as a key.

Type Parameters:

V - the type of the value of the Map

Parameters:

valueCodec - the Codec for the value of the Map

Returns:

a new Codec for Map of Codec as a key

toMapCodecAsValue

@NotNull
default <K> @NotNull Codec<Map<K,T>> toMapCodecAsValue(@NotNull
 @NotNull Codec<K> keyCodec)

Creates a new Codec for Map of Codec as a value.

Type Parameters:

K - the type of the key of the Map

Parameters:

keyCodec - the Codec for the key of the Map

Returns:

a new Codec for Map of Codec as a value

toFieldCodec

@NotNull
default @NotNull FieldCodecBuilder<T> toFieldCodec(@NotNull
 @NotNull String fieldName)

Creates a new FieldCodecBuilder for Codec.

Parameters:

fieldName - the name of the field

Returns:

a new FieldCodec for Codec

byValueType

@NotNull
static <T> @NotNull Codec<T> byValueType(@NotNull
 Type.Value<T> type)

Gets the Codec of the specified Type.Value.

Type Parameters:

T - the type of the value

Parameters:

type - the Type.Value to get Codec

Returns:

the Codec of the specified Type.Value