io.lacuna.bifurcan

Class DurableEncodings

java.lang.Object

io.lacuna.bifurcan.DurableEncodings

public class DurableEncodings
extends Object

Utility methods for constructing IDurableEncodings.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DurableEncodings.Codec A convenience interface capturing the codec behavior for a primitive encoding.

Field Summary

Fields

Modifier and Type	Field and Description
static IDurableEncoding.Primitive	VOID An encoding which encodes nothing and yields null.

Constructor Summary

Constructors

Constructor and Description
DurableEncodings()

Method Summary

Modifier and Type	Method and Description
static int	blockSize(IDurableEncoding encoding)
static IDurableEncoding.List	list(IDurableEncoding elementEncoding)
static IDurableEncoding.Map	map(IDurableEncoding keyEncoding, IDurableEncoding valueEncoding)
static IDurableEncoding.Primitive	primitive(String description, int blockSize, DurableEncodings.Codec codec)
static IDurableEncoding.Primitive	primitive(String description, int blockSize, ToLongFunction<Object> valueHash, BiPredicate<Object,Object> valueEquality, Comparator<Object> comparator, Predicate<Object> isSingleton, DurableEncodings.Codec codec)
static IDurableEncoding.Set	set(IDurableEncoding elementEncoding)
static IDurableEncoding.Primitive	tuple(Function<Object,Object[]> preEncode, Function<Object[],Object> postDecode, IDurableEncoding... encodings) Creates a tuple encoding, which allows us to decompose a compound object into individual values we know how to encode.
static IDurableEncoding.Primitive	tuple(Function<Object,Object[]> preEncode, Function<Object[],Object> postDecode, int blockSize, IDurableEncoding... encodings) Same as tuple(Function, Function, IDurableEncoding...), except that blockSize can be explicitly specified.
static IDurableEncoding	unityped(IDurableEncoding.Primitive primitiveEncoding) A unityped encoding, where all possible primitive values can be handled by primitiveEncoding.

Methods inherited from class java.lang.Object

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

Field Detail

VOID

public static final IDurableEncoding.Primitive VOID

An encoding which encodes nothing and yields null.

Constructor Detail

DurableEncodings

public DurableEncodings()

Method Detail

blockSize

public static int blockSize(IDurableEncoding encoding)

Returns:

the block size for encoding, which is 1 for all non-primitives

list

public static IDurableEncoding.List list(IDurableEncoding elementEncoding)

Returns:

an encoding of List[elementEncoding]

set

public static IDurableEncoding.Set set(IDurableEncoding elementEncoding)

Returns:

an encoding of Set[elementEncoding]

map

public static IDurableEncoding.Map map(IDurableEncoding keyEncoding,
                                       IDurableEncoding valueEncoding)

Returns:

an encoding of Map[keyEncoding, valueEncoding]

primitive

public static IDurableEncoding.Primitive primitive(String description,
                                                   int blockSize,
                                                   DurableEncodings.Codec codec)

Returns:

a primitive encoding

primitive

public static IDurableEncoding.Primitive primitive(String description,
                                                   int blockSize,
                                                   ToLongFunction<Object> valueHash,
                                                   BiPredicate<Object,Object> valueEquality,
                                                   Comparator<Object> comparator,
                                                   Predicate<Object> isSingleton,
                                                   DurableEncodings.Codec codec)

Returns:

a primitive encoding

tuple

public static IDurableEncoding.Primitive tuple(Function<Object,Object[]> preEncode,
                                               Function<Object[],Object> postDecode,
                                               IDurableEncoding... encodings)

Creates a tuple encoding, which allows us to decompose a compound object into individual values we know how to encode. To deconstruct the value, we use preEncode, which yields an array of individual values, which by convention have the same order as encodings. To reconstruct the value, we use postDecode, which takes an array of individual values an yields a compound value. The block size of this encoding is equal to the smallest block size of its sub-encodings.

tuple

public static IDurableEncoding.Primitive tuple(Function<Object,Object[]> preEncode,
                                               Function<Object[],Object> postDecode,
                                               int blockSize,
                                               IDurableEncoding... encodings)

Same as tuple(Function, Function, IDurableEncoding...), except that blockSize can be explicitly specified.

unityped

public static IDurableEncoding unityped(IDurableEncoding.Primitive primitiveEncoding)

A unityped encoding, where all possible primitive values can be handled by primitiveEncoding.