io.lacuna.bifurcan.encodings

Class SelfDescribing

java.lang.Object

io.lacuna.bifurcan.encodings.SelfDescribing

All Implemented Interfaces:

DurableEncoding

public class SelfDescribing
extends java.lang.Object
implements DurableEncoding

Nested Class Summary

Nested classes/interfaces inherited from interface io.lacuna.bifurcan.DurableEncoding

DurableEncoding.Descriptor, DurableEncoding.SkippableIterator

Constructor Summary

Constructors

Constructor and Description
SelfDescribing(java.lang.String descriptor, int blockSize, java.util.function.BiConsumer<java.lang.Object,DurableOutput> encode, java.util.function.Function<DurableInput,java.lang.Object> decode)
SelfDescribing(java.lang.String descriptor, int blockSize, java.util.function.BiConsumer<java.lang.Object,DurableOutput> encode, java.util.function.Function<DurableInput,java.lang.Object> decode, java.util.function.Function<DurableInput,DurableInput> decompress, java.util.function.Function<DurableOutput,DurableOutput> compress)

Method Summary

Modifier and Type	Method and Description
int	blockSize() Describes the number of primitive values which should be encoded as a block.
DurableEncoding.SkippableIterator	decode(DurableInput compressed) Decodes a block of primitive values, returning an iterator of thunks representing each individual value.
DurableEncoding.Descriptor	descriptor() A plain-text description of the encoding, which is also used as its identity.
DurableEncoding	elementEncoding(long index) The encoding for an element at `index` within a list.
void	encode(IList<java.lang.Object> primitives, DurableOutput out) Encodes the block of primitive values to `out`.
boolean	encodesLists() Describes whether this encoding can be used to encode lists.
boolean	encodesMaps() Describes whether this encoding can be used to encode maps (and implicitly sets, which are treated as maps without values).
boolean	encodesPrimitives() Describes whether this encoding can be used to encode non-collection types.
boolean	hasOrdering() Describes whether this encoding can be used with sorted collections.
DurableEncoding	keyEncoding() The encoding for any key in a map or set.
DurableEncoding	valueEncoding(java.lang.Object key) The encoding for any value corresponding to `key` within a map.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.lacuna.bifurcan.DurableEncoding

defaultComparator, keyComparator, keyEquality, keyHash

Constructor Detail

SelfDescribing

public SelfDescribing(java.lang.String descriptor,
                      int blockSize,
                      java.util.function.BiConsumer<java.lang.Object,DurableOutput> encode,
                      java.util.function.Function<DurableInput,java.lang.Object> decode)

SelfDescribing

public SelfDescribing(java.lang.String descriptor,
                      int blockSize,
                      java.util.function.BiConsumer<java.lang.Object,DurableOutput> encode,
                      java.util.function.Function<DurableInput,java.lang.Object> decode,
                      java.util.function.Function<DurableInput,DurableInput> decompress,
                      java.util.function.Function<DurableOutput,DurableOutput> compress)

Method Detail

encodesMaps

public boolean encodesMaps()

Description copied from interface: DurableEncoding

Describes whether this encoding can be used to encode maps (and implicitly sets, which are treated as maps without values).

Specified by:

encodesMaps in interface DurableEncoding

keyEncoding

public DurableEncoding keyEncoding()

Description copied from interface: DurableEncoding

The encoding for any key in a map or set.

Specified by:

keyEncoding in interface DurableEncoding

valueEncoding

public DurableEncoding valueEncoding(java.lang.Object key)

Description copied from interface: DurableEncoding

The encoding for any value corresponding to `key` within a map.

Specified by:

valueEncoding in interface DurableEncoding

encodesLists

public boolean encodesLists()

Description copied from interface: DurableEncoding

Describes whether this encoding can be used to encode lists.

Specified by:

encodesLists in interface DurableEncoding

elementEncoding

public DurableEncoding elementEncoding(long index)

Description copied from interface: DurableEncoding

The encoding for an element at `index` within a list.

Specified by:

elementEncoding in interface DurableEncoding

encodesPrimitives

public boolean encodesPrimitives()

Description copied from interface: DurableEncoding

Describes whether this encoding can be used to encode non-collection types.

Specified by:

encodesPrimitives in interface DurableEncoding

hasOrdering

public boolean hasOrdering()

Description copied from interface: DurableEncoding

Describes whether this encoding can be used with sorted collections.

Specified by:

hasOrdering in interface DurableEncoding

descriptor

public DurableEncoding.Descriptor descriptor()

Description copied from interface: DurableEncoding

A plain-text description of the encoding, which is also used as its identity. All encodings sharing a name should be equivalent.

Specified by:

descriptor in interface DurableEncoding

blockSize

public int blockSize()

Description copied from interface: DurableEncoding

Describes the number of primitive values which should be encoded as a block.

Specified by:

blockSize in interface DurableEncoding

encode

public void encode(IList<java.lang.Object> primitives,
                   DurableOutput out)

Description copied from interface: DurableEncoding

Encodes the block of primitive values to `out`.

Specified by:

encode in interface DurableEncoding

decode

public DurableEncoding.SkippableIterator decode(DurableInput compressed)

Description copied from interface: DurableEncoding

Decodes a block of primitive values, returning an iterator of thunks representing each individual value.

Specified by:

decode in interface DurableEncoding