com.illumon.util.codec

Interface ObjectCodec<TYPE>

public interface ObjectCodec<TYPE>

Codec interface for Object translation to/from byte arrays for serialization and deserialization.

Implementations must follow several rules to enable correct usage:

1. They must be stateless or designed for concurrent use (e.g. by using only ThreadLocal state), as they will generally be cached and re-used.
2. They must not modify their inputs in any way, retain references to their inputs, or return results that retain references to their inputs.
3. They should provide a public constructor that takes a single String argument, in order to allow configuration-driven reflective instantiation.

Field Summary

Fields

Modifier and Type	Field and Description
static int	VARIABLE_WIDTH_SENTINEL The value which represents variable width columns.

Method Summary

Modifier and Type	Method and Description
default void	checkWidth(int actualWidth) Verify that this codec is capable of supporting a column that has an actual width of actual width
TYPE	decode(byte[] input, int offset, int length) Decode an object from an array of bytes.
byte[]	encode(TYPE input) Encode the specified input as an array of bytes.
int	expectedObjectWidth() What width byte array does this ObjectCodec expect to encode and decode?

Field Detail

VARIABLE_WIDTH_SENTINEL

static final int VARIABLE_WIDTH_SENTINEL

The value which represents variable width columns.

See Also:

Constant Field Values

Method Detail

encode

@NotNull
byte[] encode(@Nullable
                       TYPE input)

Encode the specified input as an array of bytes. Note that it is up to the implementation how to encode null inputs. The use of a zero-length byte array (e.g. CollectionUtil.ZERO_LENGTH_BYTE_ARRAY) is strongly encouraged.

Parameters:

input - The input object, possibly null

Returns:

The output byte array

decode

@Nullable
TYPE decode(@NotNull
                      byte[] input,
                      int offset,
                      int length)

Decode an object from an array of bytes.

Parameters:

input - The input byte array containing bytes to decode

offset - The offset into the byte array to start decoding from

length - The length of the byte array to decode from, starting at the offset

Returns:

The output object, possibly null

expectedObjectWidth

int expectedObjectWidth()

What width byte array does this ObjectCodec expect to encode and decode?

Returns:

VARIABLE_WIDTH_SENTINEL if the codec must encode and decode variable width columns, otherwise the fixed size of byte array that must be decoded and encoded.

checkWidth

default void checkWidth(int actualWidth)
                 throws IllegalArgumentException

Verify that this codec is capable of supporting a column that has an actual width of actual width

Parameters:

actualWidth - the actual width of the instantiated column

Throws:

IllegalArgumentException - if the actual width is not compatible with this codec