net.openhft.chronicle.hash.serialization

Interface SizeMarshaller

All Superinterfaces:

net.openhft.chronicle.bytes.CommonMarshallable, net.openhft.chronicle.wire.Marshallable, net.openhft.chronicle.wire.ReadMarshallable, net.openhft.chronicle.core.io.Resettable, net.openhft.chronicle.wire.WriteMarshallable, net.openhft.chronicle.wire.WriteValue

public interface SizeMarshaller
extends net.openhft.chronicle.wire.Marshallable

Strategy of storing numbers in bytes stores (usually sizes of the subsequent chunks in the same bytes store). Normal number storing (4 bytes for int, 8 bytes for long is rather wasteful for marshalling purposes, when the number (size) to store is usually very small, and 1-2 bytes could be enough to encode it (this is how stopBit() marshaller works). Also, this interface allows to generalize storing constantly-sized and variable-sized blocks of data. Constantly-sized don't require to store the size actually, the corresponding constant(long) SizeMarshaller consumes 0 bytes.

Some SizeMarshaller implementations couldn't store the whole long range, for example each constant(long) SizeMarshaller is able to "store" only a single specific value (it's constant size). If the marshaller is fed with the size it is not able store, it could throw an IllegalArgumentException.

See Also:

ChronicleHashBuilder.keySizeMarshaller(SizeMarshaller), ChronicleMapBuilder.valueSizeMarshaller(SizeMarshaller)

Field Summary

Fields inherited from interface net.openhft.chronicle.wire.WriteMarshallable

EMPTY

Fields inherited from interface net.openhft.chronicle.wire.ReadMarshallable

DISCARD

Method Summary

Modifier and Type	Method and Description
static SizeMarshaller	constant(long constantSize) Returns a SizeMarshaller, that consumes 0 bytes and is above to "store" only a single constant number, provided to this factory method.
long	maxStorableSize() Returns the maximum size this SizeMarshaller is able to store.
int	maxStoringLengthOfSizesInRange(long minSize, long maxSize) Returns the maximum storing length this SizeMarshaller produces for some value in the given range (both bounds are inclusive).
long	minStorableSize() Returns the minimum size this SizeMarshaller is able to store.
int	minStoringLengthOfSizesInRange(long minSize, long maxSize) Returns the minimum storing length this SizeMarshaller produces for some size in the given range (both bounds are inclusive).
long	readSize(net.openhft.chronicle.bytes.Bytes in) Reads and returns a size from the input.
static SizeMarshaller	stopBit() Returns a SizeMarshaller which stores number using so-called stop bit encoding.
int	storingLength(long size) Calculates how many bytes is takes to store the given size with this SizeMarshaller.
void	writeSize(net.openhft.chronicle.bytes.Bytes out, long sizeToWrite) Writes the given size into the streaming output.

Methods inherited from interface net.openhft.chronicle.wire.Marshallable

$equals, $fieldInfoMap, $fieldInfos, $hashCode, $toString, className, copyFrom, copyTo, deepCopy, fromFile, fromFile, fromFileAsMap, fromFileAsMap, fromHexString, fromString, fromString, fromString, getField, getLongField, mergeToMap, readMarshallable, reset, setField, setLongField, streamFromFile, streamFromFile, writeMarshallable

Methods inherited from interface net.openhft.chronicle.wire.WriteMarshallable

writeValue

Methods inherited from interface net.openhft.chronicle.wire.ReadMarshallable

unexpectedField

Methods inherited from interface net.openhft.chronicle.bytes.CommonMarshallable

usesSelfDescribingMessage

Method Detail

stopBit

static SizeMarshaller stopBit()

Returns a SizeMarshaller which stores number using so-called stop bit encoding. This marshaller is used as the default marshaller for keys' and values' sizes in Chronicle Map, unless Chronicle Map could figure out (or hinted in ChronicleMapBuilder) that keys or values are constant-sized, in which case constant(long) SizeMarshaller is used.

constant

static SizeMarshaller constant(long constantSize)

Returns a SizeMarshaller, that consumes 0 bytes and is above to "store" only a single constant number, provided to this factory method. This size marshaller is used in Chronicle Map to serialize keys' or values' sizes, when Chronicle Map could figure out (or was hinted in ChronicleMapBuilder) that keys or values are constant-sized.

Parameters:

constantSize - the single constant size the returned SizeMarshaller is able to "store"

Returns:

a SizeMarshaller, that is able to "store" only the given constant size

storingLength

int storingLength(long size)

Calculates how many bytes is takes to store the given size with this SizeMarshaller.

Parameters:

size - the size to store

Returns:

the number of bytes would be taken to store the given size

Throws:

IllegalArgumentException - might be thrown, if the given size if not storable by this SizeMarshaller

minStorableSize

long minStorableSize()

Returns the minimum size this SizeMarshaller is able to store.

Returns:

the minimum size this SizeMarshaller is able to store

maxStorableSize

long maxStorableSize()

Returns the maximum size this SizeMarshaller is able to store.

Returns:

the maximum size this SizeMarshaller is able to store

minStoringLengthOfSizesInRange

int minStoringLengthOfSizesInRange(long minSize,
                                   long maxSize)

Returns the minimum storing length this SizeMarshaller produces for some size in the given range (both bounds are inclusive).

Parameters:

minSize - the lower bound of the range (inclusive)

maxSize - the upper bound of the range (inclusive)

Returns:

the smallest storing length of a value in the given range

See Also:

maxStoringLengthOfSizesInRange(long, long)

maxStoringLengthOfSizesInRange

int maxStoringLengthOfSizesInRange(long minSize,
                                   long maxSize)

Returns the maximum storing length this SizeMarshaller produces for some value in the given range (both bounds are inclusive).

Parameters:

minSize - the lower bound of the range (inclusive)

maxSize - the upper bound of the range (inclusive)

Returns:

the biggest storing length of a value in the given range

See Also:

minStoringLengthOfSizesInRange(long, long)

writeSize

void writeSize(net.openhft.chronicle.bytes.Bytes out,
               long sizeToWrite)

Writes the given size into the streaming output.

Parameters:

out - the StreamingDataOutput to write the size to

sizeToWrite - the size to write

Throws:

IllegalArgumentException - might be thrown, if the given size if not storable by this SizeMarshaller

See Also:

readSize(Bytes)

readSize

long readSize(net.openhft.chronicle.bytes.Bytes in)

Reads and returns a size from the input.

Parameters:

in - the StreamingDataInput to read the size from

Returns:

the read size

See Also:

writeSize(Bytes, long)