org.apache.directory.mavibot.btree.serializer

Class StringSerializer

java.lang.Object

org.apache.directory.mavibot.btree.serializer.AbstractElementSerializer<java.lang.String>

org.apache.directory.mavibot.btree.serializer.StringSerializer

All Implemented Interfaces:

ElementSerializer<java.lang.String>

public class StringSerializer
extends AbstractElementSerializer<java.lang.String>

The String serializer.

Field Summary

Fields

Modifier and Type	Field and Description
static StringSerializer	INSTANCE A static instance of a StringSerializer

Constructor Summary

Constructors

Modifier	Constructor and Description
private	StringSerializer() Create a new instance of StringSerializer
	StringSerializer(java.util.Comparator<java.lang.String> comparator) Create a new instance of StringSerializer with custom comparator

Method Summary

Modifier and Type	Method and Description
int	compare(java.lang.String type1, java.lang.String type2) Returns the comparison of two types.
java.lang.String	deserialize(BufferHandler bufferHandler) Deserialize an element from a BufferHandler
static java.lang.String	deserialize(byte[] in) A static method used to deserialize a String from a byte array.
static java.lang.String	deserialize(byte[] in, int start) A static method used to deserialize a String from a byte array.
java.lang.String	deserialize(java.nio.ByteBuffer buffer) Deserialize an element from a ByteBuffer
java.lang.String	fromBytes(byte[] in) A method used to deserialize a String from a byte array.
java.lang.String	fromBytes(byte[] in, int start) A method used to deserialize a String from a byte array.
static byte[]	serialize(byte[] buffer, int start, java.lang.String element) Serialize a String.
byte[]	serialize(java.lang.String element) Produce the byte[] representation of the element

Methods inherited from class org.apache.directory.mavibot.btree.serializer.AbstractElementSerializer

getComparator, getType

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static final StringSerializer INSTANCE

A static instance of a StringSerializer

Constructor Detail

StringSerializer

private StringSerializer()

Create a new instance of StringSerializer

StringSerializer

public StringSerializer(java.util.Comparator<java.lang.String> comparator)

Create a new instance of StringSerializer with custom comparator

Method Detail

deserialize

public static java.lang.String deserialize(byte[] in)

A static method used to deserialize a String from a byte array.

Parameters:

in - The byte array containing the String

Returns:

A String

deserialize

public static java.lang.String deserialize(byte[] in,
                                           int start)

A static method used to deserialize a String from a byte array.

Parameters:

in - The byte array containing the String

Returns:

A String

fromBytes

public java.lang.String fromBytes(byte[] in)

A method used to deserialize a String from a byte array.

Parameters:

in - The byte array containing the String

Returns:

A String

fromBytes

public java.lang.String fromBytes(byte[] in,
                                  int start)

A method used to deserialize a String from a byte array.

Parameters:

in - The byte array containing the String

Returns:

A String

serialize

public static byte[] serialize(byte[] buffer,
                               int start,
                               java.lang.String element)

Serialize a String. We store the length on 4 bytes, then the String

Parameters:

buffer - the Buffer that will contain the serialized value

start - the position in the buffer we will store the serialized String

value - the value to serialize

Returns:

The byte[] containing the serialized String

serialize

public byte[] serialize(java.lang.String element)

Produce the byte[] representation of the element

Parameters:

element - The element to serialize

Returns:

The byte[] containing the serialized element

deserialize

public java.lang.String 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

deserialize

public java.lang.String 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

compare

public int compare(java.lang.String type1,
                   java.lang.String type2)

Returns the comparison of two types.

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

Specified by:

compare in interface ElementSerializer<java.lang.String>

Overrides:

compare in class AbstractElementSerializer<java.lang.String>

Parameters:

type1 - The first type to compare

type2 - The second type to compare

Returns:

The comparison result