org.apache.directory.mavibot.btree.serializer

Interface ElementSerializer<T>

Type Parameters:

T - The type for the element to serialize and compare

All Known Implementing Classes:

AbstractElementSerializer, BooleanSerializer, ByteArraySerializer, ByteSerializer, CharArraySerializer, CharSerializer, IntSerializer, LongArraySerializer, LongSerializer, NameRevisionSerializer, RevisionNameSerializer, RevisionOffsetSerializer, ShortSerializer, StringSerializer

public interface ElementSerializer<T>

This interface is used by implementations of serializer, deserializer and comparator.

Method Summary

Modifier and Type	Method and Description
int	compare(T type1, T type2) Returns the comparison of two types.
T	deserialize(BufferHandler bufferHandler) Deserialize an element from a BufferHandler
T	deserialize(java.nio.ByteBuffer buffer) Deserialize an element from a ByteBuffer
T	fromBytes(byte[] buffer) Deserialize an element from a byte[]
T	fromBytes(byte[] buffer, int pos) Deserialize an element from a byte[]
java.util.Comparator<T>	getComparator()
java.lang.Class<?>	getType()
byte[]	serialize(T key) Produce the byte[] representation of the element

Method Detail

serialize

byte[] serialize(T key)

Produce the byte[] representation of the element

Parameters:

key - The element to serialize

Returns:

The byte[] containing the serialized element

deserialize

T deserialize(BufferHandler bufferHandler)
       throws java.io.IOException

Deserialize an element from a BufferHandler

Parameters:

bufferHandler - The incoming bufferHandler

Returns:

The deserialized element

Throws:

java.io.IOException - If the deserialization failed

deserialize

T deserialize(java.nio.ByteBuffer buffer)
       throws java.io.IOException

Deserialize an element from a ByteBuffer

Parameters:

buffer - The incoming ByteBuffer

Returns:

The deserialized element

Throws:

java.io.IOException - If the deserialization failed

fromBytes

T fromBytes(byte[] buffer)
     throws java.io.IOException

Deserialize an element from a byte[]

Parameters:

buffer - The incoming byte[]

Returns:

The deserialized element

Throws:

java.io.IOException - If the deserialization failed

fromBytes

T fromBytes(byte[] buffer,
            int pos)
     throws java.io.IOException

Deserialize an element from a byte[]

Parameters:

buffer - The incoming byte[]

Returns:

The deserialized element

Throws:

java.io.IOException - If the deserialization failed

compare

int compare(T type1,
            T type2)

Returns the comparison of two types.

• If type1 < type2, return -1
• If type1 > type2, return 1
• If type1 == type2, return 0

Parameters:

type1 - The first type to compare

type2 - The second type to compare

Returns:

The comparison result

getComparator

java.util.Comparator<T> getComparator()

Returns:

the comparator for the used type

getType

java.lang.Class<?> getType()

Returns:

the type being serialized