Package io.activej.codec

Class StructuredCodecs

java.lang.Object

io.activej.codec.StructuredCodecs

public final class StructuredCodecs
extends Object

This class contains various primitive StructuredCodecs and their combinators.

Field Summary

Fields

Modifier and Type	Field	Description
static StructuredCodec<Boolean>	BOOLEAN_CODEC
static StructuredCodec<Byte>	BYTE_CODEC
static StructuredCodec<byte[]>	BYTES_CODEC
static StructuredCodec<Character>	CHARACTER_CODEC
static StructuredCodec<Class<?>>	CLASS_CODEC
static StructuredCodec<Double>	DOUBLE_CODEC
static StructuredCodec<Float>	FLOAT_CODEC
static StructuredCodec<Integer>	INT_CODEC
static StructuredCodec<Integer>	INT32_CODEC
static StructuredCodec<Long>	LONG_CODEC
static StructuredCodec<Long>	LONG64_CODEC
static StructuredCodec<Short>	SHORT_CODEC
static StructuredCodec<String>	STRING_CODEC
static StructuredCodec<Void>	VOID_CODEC

Constructor Summary

Constructors

Constructor	Description
StructuredCodecs()

Method Summary

Modifier and Type	Method	Description
static <T> StructuredCodec<List<T>>	concat(StructuredCodec<? extends T>... elementCodecs)
static <T> StructuredCodec<List<T>>	concat(List<StructuredCodec<? extends T>> elementCodecs)	Combinator codec that writes/reads a heterogeneous list using codecs from given list without list boundaries
static <R> StructuredCodec<R>	object(TupleDecoder0<R> constructor)	A DSL to call ofObjectMap(Map) with fixed number of key-value pairs and map it to some result type R.
static <R, T1> StructuredCodec<R>	object(TupleDecoder1<T1,R> constructor, String field1, Function<R,T1> getter1, StructuredCodec<T1> codec1)	A DSL to call ofObjectMap(Map) with fixed number of key-value pairs and map it to some result type R.
static <R, T1, T2> StructuredCodec<R>	object(TupleDecoder2<T1,T2,R> constructor, String field1, Function<R,T1> getter1, StructuredCodec<T1> codec1, String field2, Function<R,T2> getter2, StructuredCodec<T2> codec2)	A DSL to call ofObjectMap(Map) with fixed number of key-value pairs and map it to some result type R.
static <R, T1, T2, T3> StructuredCodec<R>	object(TupleDecoder3<T1,T2,T3,R> constructor, String field1, Function<R,T1> getter1, StructuredCodec<T1> codec1, String field2, Function<R,T2> getter2, StructuredCodec<T2> codec2, String field3, Function<R,T3> getter3, StructuredCodec<T3> codec3)	A DSL to call ofObjectMap(Map) with fixed number of key-value pairs and map it to some result type R.
static <R, T1, T2, T3, T4> StructuredCodec<R>	object(TupleDecoder4<T1,T2,T3,T4,R> constructor, String field1, Function<R,T1> getter1, StructuredCodec<T1> codec1, String field2, Function<R,T2> getter2, StructuredCodec<T2> codec2, String field3, Function<R,T3> getter3, StructuredCodec<T3> codec3, String field4, Function<R,T4> getter4, StructuredCodec<T4> codec4)	A DSL to call ofObjectMap(Map) with fixed number of key-value pairs and map it to some result type R.
static <R, T1, T2, T3, T4, T5> StructuredCodec<R>	object(TupleDecoder5<T1,T2,T3,T4,T5,R> constructor, String field1, Function<R,T1> getter1, StructuredCodec<T1> codec1, String field2, Function<R,T2> getter2, StructuredCodec<T2> codec2, String field3, Function<R,T3> getter3, StructuredCodec<T3> codec3, String field4, Function<R,T4> getter4, StructuredCodec<T4> codec4, String field5, Function<R,T5> getter5, StructuredCodec<T5> codec5)	A DSL to call ofObjectMap(Map) with fixed number of key-value pairs and map it to some result type R.
static <R, T1, T2, T3, T4, T5, T6> StructuredCodec<R>	object(TupleDecoder6<T1,T2,T3,T4,T5,T6,R> constructor, String field1, Function<R,T1> getter1, StructuredCodec<T1> codec1, String field2, Function<R,T2> getter2, StructuredCodec<T2> codec2, String field3, Function<R,T3> getter3, StructuredCodec<T3> codec3, String field4, Function<R,T4> getter4, StructuredCodec<T4> codec4, String field5, Function<R,T5> getter5, StructuredCodec<T5> codec5, String field6, Function<R,T6> getter6, StructuredCodec<T6> codec6)	A DSL to call ofObjectMap(Map) with fixed number of key-value pairs and map it to some result type R.
static <T> StructuredCodec<Class<? extends T>>	ofClass()
static <E extends Enum<E>> StructuredCodec<E>	ofEnum(Class<E> enumType)
static <T> StructuredCodec<List<T>>	ofList(StructuredCodec<T> valueAdapters)	Combinator codec that writes/reads a list of T with given codec for T
static <K, V> StructuredCodec<Map<K,V>>	ofMap(StructuredCodec<K> codecKey, StructuredCodec<V> codecValue)	Combinator codec that writes/reads a map with keys of type K and values of type V with given codecs for K and V
static <T> StructuredCodec<@Nullable T>	ofNullable(StructuredCodec<T> codec)
static <T> StructuredCodec<Map<String,T>>	ofObjectMap(Map<String,StructuredCodec<? extends T>> fieldCodecs)	Combinator codec that writes/reads a heterogeneous map with string keys and values using codecs from given map
static <T> StructuredCodec<Optional<T>>	ofOptional(StructuredCodec<T> codec)	Combinator codec that writes/reads Optional<T> as nullable T with given codec for T
static <T> StructuredCodec<Set<T>>	ofSet(StructuredCodec<T> codec)	Combinator codec that writes/reads a set of T with given codec for T
static StructuredCodec<Object[]>	ofTupleArray(StructuredCodec<?>... elementDecoders)	Combinator codec that writes/reads a heterogeneous fixed-size array ob objects with given codecs
static StructuredCodec<Object[]>	ofTupleArray(List<StructuredCodec<?>> codecs)
static <T> StructuredCodec<List<T>>	ofTupleList(StructuredCodec<? extends T>... elementDecoders)
static <T> StructuredCodec<List<T>>	ofTupleList(List<StructuredCodec<? extends T>> codecs)
static <T, R> StructuredCodec<R>	transform(StructuredCodec<T> codec, DecoderFunction<T,R> reader, Function<R,T> writer)
static <R> StructuredCodec<R>	tuple(TupleDecoder0<R> constructor)	A DSL to call ofTupleList(List) with fixed number of arguments and map it to some result type R
static <R, T1> StructuredCodec<R>	tuple(TupleDecoder1<T1,R> constructor, Function<R,T1> getter1, StructuredCodec<T1> codec1)	A DSL to call ofTupleList(List) with fixed number of arguments and map it to some result type R
static <R, T1, T2> StructuredCodec<R>	tuple(TupleDecoder2<T1,T2,R> constructor, Function<R,T1> getter1, StructuredCodec<T1> codec1, Function<R,T2> getter2, StructuredCodec<T2> codec2)	A DSL to call ofTupleList(List) with fixed number of arguments and map it to some result type R
static <R, T1, T2, T3> StructuredCodec<R>	tuple(TupleDecoder3<T1,T2,T3,R> constructor, Function<R,T1> getter1, StructuredCodec<T1> codec1, Function<R,T2> getter2, StructuredCodec<T2> codec2, Function<R,T3> getter3, StructuredCodec<T3> codec3)	A DSL to call ofTupleList(List) with fixed number of arguments and map it to some result type R
static <R, T1, T2, T3, T4> StructuredCodec<R>	tuple(TupleDecoder4<T1,T2,T3,T4,R> constructor, Function<R,T1> getter1, StructuredCodec<T1> codec1, Function<R,T2> getter2, StructuredCodec<T2> codec2, Function<R,T3> getter3, StructuredCodec<T3> codec3, Function<R,T4> getter4, StructuredCodec<T4> codec4)	A DSL to call ofTupleList(List) with fixed number of arguments and map it to some result type R
static <R, T1, T2, T3, T4, T5> StructuredCodec<R>	tuple(TupleDecoder5<T1,T2,T3,T4,T5,R> constructor, Function<R,T1> getter1, StructuredCodec<T1> codec1, Function<R,T2> getter2, StructuredCodec<T2> codec2, Function<R,T3> getter3, StructuredCodec<T3> codec3, Function<R,T4> getter4, StructuredCodec<T4> codec4, Function<R,T5> getter5, StructuredCodec<T5> codec5)	A DSL to call ofTupleList(List) with fixed number of arguments and map it to some result type R
static <R, T1, T2, T3, T4, T5, T6> StructuredCodec<R>	tuple(TupleDecoder6<T1,T2,T3,T4,T5,T6,R> constructor, Function<R,T1> getter1, StructuredCodec<T1> codec1, Function<R,T2> getter2, StructuredCodec<T2> codec2, Function<R,T3> getter3, StructuredCodec<T3> codec3, Function<R,T4> getter4, StructuredCodec<T4> codec4, Function<R,T5> getter5, StructuredCodec<T5> codec5, Function<R,T6> getter6, StructuredCodec<T6> codec6)	A DSL to call ofTupleList(List) with fixed number of arguments and map it to some result type R

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

BOOLEAN_CODEC

public static final StructuredCodec<Boolean> BOOLEAN_CODEC

CHARACTER_CODEC

public static final StructuredCodec<Character> CHARACTER_CODEC

BYTE_CODEC

public static final StructuredCodec<Byte> BYTE_CODEC

SHORT_CODEC

public static final StructuredCodec<Short> SHORT_CODEC

INT_CODEC

public static final StructuredCodec<Integer> INT_CODEC

LONG_CODEC

public static final StructuredCodec<Long> LONG_CODEC

INT32_CODEC

public static final StructuredCodec<Integer> INT32_CODEC

LONG64_CODEC

public static final StructuredCodec<Long> LONG64_CODEC

FLOAT_CODEC

public static final StructuredCodec<Float> FLOAT_CODEC

DOUBLE_CODEC

public static final StructuredCodec<Double> DOUBLE_CODEC

STRING_CODEC

public static final StructuredCodec<String> STRING_CODEC

BYTES_CODEC

public static final StructuredCodec<byte[]> BYTES_CODEC

VOID_CODEC

public static final StructuredCodec<Void> VOID_CODEC

CLASS_CODEC

public static final StructuredCodec<Class<?>> CLASS_CODEC

Constructor Details

StructuredCodecs

public StructuredCodecs()

Method Details

ofEnum

public static <E extends Enum<E>>
StructuredCodec<E> ofEnum(Class<E> enumType)

ofClass

public static <T>
StructuredCodec<Class<? extends T>> ofClass()

ofOptional

public static <T> StructuredCodec<Optional<T>> ofOptional(StructuredCodec<T> codec)

Combinator codec that writes/reads Optional<T> as nullable T with given codec for T

ofNullable

public static <T> StructuredCodec<@Nullable T> ofNullable(StructuredCodec<T> codec)

transform

public static <T,
R> StructuredCodec<R> transform(StructuredCodec<T> codec,
DecoderFunction<T,R> reader,
Function<R,T> writer)

ofList

public static <T> StructuredCodec<List<T>> ofList(StructuredCodec<T> valueAdapters)

Combinator codec that writes/reads a list of T with given codec for T

ofSet

public static <T> StructuredCodec<Set<T>> ofSet(StructuredCodec<T> codec)

Combinator codec that writes/reads a set of T with given codec for T

ofTupleArray

public static StructuredCodec<Object[]> ofTupleArray(StructuredCodec<?>... elementDecoders)

Combinator codec that writes/reads a heterogeneous fixed-size array ob objects with given codecs

ofTupleArray

public static StructuredCodec<Object[]> ofTupleArray(List<StructuredCodec<?>> codecs)

ofTupleList

public static <T> StructuredCodec<List<T>> ofTupleList(StructuredCodec<? extends T>... elementDecoders)

ofTupleList

public static <T> StructuredCodec<List<T>> ofTupleList(List<StructuredCodec<? extends T>> codecs)

ofMap

public static <K,
V> StructuredCodec<Map<K,V>> ofMap(StructuredCodec<K> codecKey,
StructuredCodec<V> codecValue)

Combinator codec that writes/reads a map with keys of type K and values of type V with given codecs for K and V

ofObjectMap

public static <T> StructuredCodec<Map<String,T>> ofObjectMap(Map<String,StructuredCodec<? extends T>> fieldCodecs)

Combinator codec that writes/reads a heterogeneous map with string keys and values using codecs from given map

concat

public static <T> StructuredCodec<List<T>> concat(StructuredCodec<? extends T>... elementCodecs)

concat

public static <T> StructuredCodec<List<T>> concat(List<StructuredCodec<? extends T>> elementCodecs)

Combinator codec that writes/reads a heterogeneous list using codecs from given list without list boundaries

tuple

public static <R> StructuredCodec<R> tuple(TupleDecoder0<R> constructor)

A DSL to call ofTupleList(List) with fixed number of arguments and map it to some result type R

tuple

public static <R,
T1> StructuredCodec<R> tuple(TupleDecoder1<T1,R> constructor,
Function<R,T1> getter1,
StructuredCodec<T1> codec1)

A DSL to call ofTupleList(List) with fixed number of arguments and map it to some result type R

tuple

public static <R,
T1,
T2> StructuredCodec<R> tuple(TupleDecoder2<T1,T2,R> constructor,
Function<R,T1> getter1,
StructuredCodec<T1> codec1,
Function<R,T2> getter2,
StructuredCodec<T2> codec2)

A DSL to call ofTupleList(List) with fixed number of arguments and map it to some result type R

tuple

public static <R,
T1,
T2,
T3> StructuredCodec<R> tuple(TupleDecoder3<T1,T2,T3,R> constructor,
Function<R,T1> getter1,
StructuredCodec<T1> codec1,
Function<R,T2> getter2,
StructuredCodec<T2> codec2,
Function<R,T3> getter3,
StructuredCodec<T3> codec3)

A DSL to call ofTupleList(List) with fixed number of arguments and map it to some result type R

tuple

public static <R,
T1,
T2,
T3,
T4> StructuredCodec<R> tuple(TupleDecoder4<T1,T2,T3,T4,R> constructor,
Function<R,T1> getter1,
StructuredCodec<T1> codec1,
Function<R,T2> getter2,
StructuredCodec<T2> codec2,
Function<R,T3> getter3,
StructuredCodec<T3> codec3,
Function<R,T4> getter4,
StructuredCodec<T4> codec4)

A DSL to call ofTupleList(List) with fixed number of arguments and map it to some result type R

tuple

public static <R,
T1,
T2,
T3,
T4,
T5> StructuredCodec<R> tuple(TupleDecoder5<T1,T2,T3,T4,T5,R> constructor,
Function<R,T1> getter1,
StructuredCodec<T1> codec1,
Function<R,T2> getter2,
StructuredCodec<T2> codec2,
Function<R,T3> getter3,
StructuredCodec<T3> codec3,
Function<R,T4> getter4,
StructuredCodec<T4> codec4,
Function<R,T5> getter5,
StructuredCodec<T5> codec5)

A DSL to call ofTupleList(List) with fixed number of arguments and map it to some result type R

tuple

public static <R,
T1,
T2,
T3,
T4,
T5,
T6>
StructuredCodec<R> tuple(TupleDecoder6<T1,T2,T3,T4,T5,T6,R> constructor,
Function<R,T1> getter1,
StructuredCodec<T1> codec1,
Function<R,T2> getter2,
StructuredCodec<T2> codec2,
Function<R,T3> getter3,
StructuredCodec<T3> codec3,
Function<R,T4> getter4,
StructuredCodec<T4> codec4,
Function<R,T5> getter5,
StructuredCodec<T5> codec5,
Function<R,T6> getter6,
StructuredCodec<T6> codec6)

A DSL to call ofTupleList(List) with fixed number of arguments and map it to some result type R

object

public static <R> StructuredCodec<R> object(TupleDecoder0<R> constructor)

A DSL to call ofObjectMap(Map) with fixed number of key-value pairs and map it to some result type R. This is the main combinator for POJO codecs

object

public static <R,
T1> StructuredCodec<R> object(TupleDecoder1<T1,R> constructor,
String field1,
Function<R,T1> getter1,
StructuredCodec<T1> codec1)

A DSL to call ofObjectMap(Map) with fixed number of key-value pairs and map it to some result type R. This is the main combinator for POJO codecs

object

public static <R,
T1,
T2> StructuredCodec<R> object(TupleDecoder2<T1,T2,R> constructor,
String field1,
Function<R,T1> getter1,
StructuredCodec<T1> codec1,
String field2,
Function<R,T2> getter2,
StructuredCodec<T2> codec2)

A DSL to call ofObjectMap(Map) with fixed number of key-value pairs and map it to some result type R. This is the main combinator for POJO codecs

object

public static <R,
T1,
T2,
T3> StructuredCodec<R> object(TupleDecoder3<T1,T2,T3,R> constructor,
String field1,
Function<R,T1> getter1,
StructuredCodec<T1> codec1,
String field2,
Function<R,T2> getter2,
StructuredCodec<T2> codec2,
String field3,
Function<R,T3> getter3,
StructuredCodec<T3> codec3)

A DSL to call ofObjectMap(Map) with fixed number of key-value pairs and map it to some result type R. This is the main combinator for POJO codecs

object

public static <R,
T1,
T2,
T3,
T4> StructuredCodec<R> object(TupleDecoder4<T1,T2,T3,T4,R> constructor,
String field1,
Function<R,T1> getter1,
StructuredCodec<T1> codec1,
String field2,
Function<R,T2> getter2,
StructuredCodec<T2> codec2,
String field3,
Function<R,T3> getter3,
StructuredCodec<T3> codec3,
String field4,
Function<R,T4> getter4,
StructuredCodec<T4> codec4)

A DSL to call ofObjectMap(Map) with fixed number of key-value pairs and map it to some result type R. This is the main combinator for POJO codecs

object

public static <R,
T1,
T2,
T3,
T4,
T5> StructuredCodec<R> object(TupleDecoder5<T1,T2,T3,T4,T5,R> constructor,
String field1,
Function<R,T1> getter1,
StructuredCodec<T1> codec1,
String field2,
Function<R,T2> getter2,
StructuredCodec<T2> codec2,
String field3,
Function<R,T3> getter3,
StructuredCodec<T3> codec3,
String field4,
Function<R,T4> getter4,
StructuredCodec<T4> codec4,
String field5,
Function<R,T5> getter5,
StructuredCodec<T5> codec5)

A DSL to call ofObjectMap(Map) with fixed number of key-value pairs and map it to some result type R. This is the main combinator for POJO codecs

object

public static <R,
T1,
T2,
T3,
T4,
T5,
T6>
StructuredCodec<R> object(TupleDecoder6<T1,T2,T3,T4,T5,T6,R> constructor,
String field1,
Function<R,T1> getter1,
StructuredCodec<T1> codec1,
String field2,
Function<R,T2> getter2,
StructuredCodec<T2> codec2,
String field3,
Function<R,T3> getter3,
StructuredCodec<T3> codec3,
String field4,
Function<R,T4> getter4,
StructuredCodec<T4> codec4,
String field5,
Function<R,T5> getter5,
StructuredCodec<T5> codec5,
String field6,
Function<R,T6> getter6,
StructuredCodec<T6> codec6)

A DSL to call ofObjectMap(Map) with fixed number of key-value pairs and map it to some result type R. This is the main combinator for POJO codecs