io.github.whippetdb.db.api

Interface TypeIO<T>

All Known Implementing Classes:

BooleanIO, ByteBufferIO, BytesIO, CharsIO, FixedBytesIO, FixedCharsIO, IntIO, LongIO

public interface TypeIO<T>

Serialize/deserialize objects

Method Summary

Modifier and Type	Method and Description
default java.lang.Integer	avgSize()
MemArray	convert(T obj, MemDataArray tmpBuf) Convert object to memory.
java.lang.Class<T>	dataType()
default boolean	isApplicable(java.lang.Object o) Reccommended to override using instanceof!
default java.lang.Integer	maxSize()
T	readObject(MemDataArray buf) Read object from memory.
default void	setSize(MemDataArray buf, long size)
default java.lang.Integer	size()
default java.lang.String	toJson()
void	writeObject(T obj, MemDataArray buf) Write object to memory.

Method Detail

dataType

java.lang.Class<T> dataType()

isApplicable

default boolean isApplicable(java.lang.Object o)

Reccommended to override using instanceof!

convert

MemArray convert(T obj,
                 MemDataArray tmpBuf)

Convert object to memory. Implementation may choose between creating new instance of memory and writing to existing buffer, which one is faster. This is intended for representing a db key as memory chunk. If the type is variable-size (size() returns null), the size should be set through casting tmpBuf as MemDataBuffer.

Parameters:

obj - the object to convert.

tmpBuf - the buffer that may be written to and returned as the result.

Returns:

memory

writeObject

void writeObject(T obj,
                 MemDataArray buf)

Write object to memory. If the type is var-size, the size should be set through casting the buf as MemDataBuffer.

Parameters:

obj -

buf -

readObject

T readObject(MemDataArray buf)

Read object from memory.

Parameters:

obj -

buf -

size

default java.lang.Integer size()

maxSize

default java.lang.Integer maxSize()

avgSize

default java.lang.Integer avgSize()

setSize

default void setSize(MemDataArray buf,
                     long size)

toJson

default java.lang.String toJson()