com.orientechnologies.common.serialization.types

Class OStringSerializer

java.lang.Object

com.orientechnologies.common.serialization.types.OStringSerializer

All Implemented Interfaces:

OBinarySerializer<String>

public class OStringSerializer
extends Object
implements OBinarySerializer<String>

Serializer for String type.

Since:

18.01.12

Author:

Ilya Bershadskiy (ibersh20-at-gmail.com)

Field Summary

Fields

Modifier and Type	Field and Description
static byte	ID
static OStringSerializer	INSTANCE

Constructor Summary

Constructors

Constructor and Description
OStringSerializer()

Method Summary

Modifier and Type	Method and Description
String	deserialize(byte[] stream, int startPosition) Reads object from the stream starting from the startPosition
String	deserializeFromByteBufferObject(ByteBuffer buffer) Converts binary presentation of object to object instance.
String	deserializeFromByteBufferObject(ByteBuffer buffer, OWALChanges walChanges, int offset) Converts binary presentation of object to object instance taking in account changes which are done inside of atomic operation OAtomicOperation.
String	deserializeNativeObject(byte[] stream, int startPosition) Reads object from the stream starting from the startPosition, in case there were serialized using #serializeNativeObject(T, byte[], int, Object...) method.
int	getFixedLength()
byte	getId()
int	getObjectSize(byte[] stream, int startPosition) Return size serialized presentation of given object.
int	getObjectSize(String object, Object... hints) Obtain size of the serialized object Size is the amount of bites that required for storing object (for example: for storing integer we need 4 bytes)
int	getObjectSizeInByteBuffer(ByteBuffer buffer) Returns amount of bytes which is consumed by object which is already serialized in buffer.
int	getObjectSizeInByteBuffer(ByteBuffer buffer, OWALChanges walChanges, int offset) Returns amount of bytes which is consumed by object which is already serialized in buffer taking in account changes which are done inside of atomic operation OAtomicOperation.
int	getObjectSizeNative(byte[] stream, int startPosition) Return size serialized presentation of given object, if it was serialized using #serializeNativeObject(T, byte[], int, Object...) method.
boolean	isFixedLength()
String	preprocess(String value, Object... hints)
void	serialize(String object, byte[] stream, int startPosition, Object... hints) Writes object to the stream starting from the startPosition
void	serializeInByteBufferObject(String object, ByteBuffer buffer, Object... hints) Serializes binary presentation of object to ByteBuffer.
void	serializeNativeObject(String object, byte[] stream, int startPosition, Object... hints) Writes object to the stream starting from the startPosition using native acceleration.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.orientechnologies.common.serialization.types.OBinarySerializer

serializeNativeAsWhole

Field Detail

INSTANCE

public static final OStringSerializer INSTANCE

ID

public static final byte ID

See Also:

Constant Field Values

Constructor Detail

OStringSerializer

public OStringSerializer()

Method Detail

getObjectSize

public int getObjectSize(String object,
                         Object... hints)

Description copied from interface: OBinarySerializer

Obtain size of the serialized object Size is the amount of bites that required for storing object (for example: for storing integer we need 4 bytes)

Specified by:

getObjectSize in interface OBinarySerializer<String>

Parameters:

object - is the object to measure its size

hints - List of parameters which may be used to choose appropriate serialization approach.

Returns:

size of the serialized object

serialize

public void serialize(String object,
                      byte[] stream,
                      int startPosition,
                      Object... hints)

Description copied from interface: OBinarySerializer

Writes object to the stream starting from the startPosition

Specified by:

serialize in interface OBinarySerializer<String>

Parameters:

object - is the object to serialize

stream - is the stream where object will be written

hints - List of parameters which may be used to choose appropriate serialization approach.

deserialize

public String deserialize(byte[] stream,
                          int startPosition)

Description copied from interface: OBinarySerializer

Reads object from the stream starting from the startPosition

Specified by:

deserialize in interface OBinarySerializer<String>

Parameters:

stream - is the stream from object will be read

startPosition - is the position to start reading from

Returns:

instance of the deserialized object

getObjectSize

public int getObjectSize(byte[] stream,
                         int startPosition)

Description copied from interface: OBinarySerializer

Return size serialized presentation of given object.

Specified by:

getObjectSize in interface OBinarySerializer<String>

Parameters:

stream - Serialized content.

startPosition - Position from which serialized presentation of given object is stored.

Returns:

Size serialized presentation of given object in bytes.

getId

public byte getId()

Specified by:

getId in interface OBinarySerializer<String>

Returns:

Identifier of given serializer.

getObjectSizeNative

public int getObjectSizeNative(byte[] stream,
                               int startPosition)

Description copied from interface: OBinarySerializer

Return size serialized presentation of given object, if it was serialized using #serializeNativeObject(T, byte[], int, Object...) method.

Specified by:

getObjectSizeNative in interface OBinarySerializer<String>

Parameters:

stream - Serialized content.

startPosition - Position from which serialized presentation of given object is stored.

Returns:

Size serialized presentation of given object in bytes.

serializeNativeObject

public void serializeNativeObject(String object,
                                  byte[] stream,
                                  int startPosition,
                                  Object... hints)

Description copied from interface: OBinarySerializer

Writes object to the stream starting from the startPosition using native acceleration. Serialized object presentation is platform dependant.

Specified by:

serializeNativeObject in interface OBinarySerializer<String>

Parameters:

object - is the object to serialize

stream - is the stream where object will be written

hints - List of parameters which may be used to choose appropriate serialization approach.

deserializeNativeObject

public String deserializeNativeObject(byte[] stream,
                                      int startPosition)

Description copied from interface: OBinarySerializer

Reads object from the stream starting from the startPosition, in case there were serialized using #serializeNativeObject(T, byte[], int, Object...) method.

Specified by:

deserializeNativeObject in interface OBinarySerializer<String>

Parameters:

stream - is the stream from object will be read

startPosition - is the position to start reading from

Returns:

instance of the deserialized object

isFixedLength

public boolean isFixedLength()

Specified by:

isFixedLength in interface OBinarySerializer<String>

Returns:

true if binary presentation of object always has the same length.

getFixedLength

public int getFixedLength()

Specified by:

getFixedLength in interface OBinarySerializer<String>

Returns:

Length of serialized data if OBinarySerializer.isFixedLength() method returns true. If OBinarySerializer.isFixedLength() method return false returned value is undefined.

preprocess

public String preprocess(String value,
                         Object... hints)

Specified by:

preprocess in interface OBinarySerializer<String>

serializeInByteBufferObject

public void serializeInByteBufferObject(String object,
                                        ByteBuffer buffer,
                                        Object... hints)

Serializes binary presentation of object to ByteBuffer. Position of buffer should be set before calling of given method. Serialization result is compatible with result of call of OBinarySerializer.serializeNativeObject(Object, byte[], int, Object...) method. So if we call: buffer.position(10); binarySerializer.serializeInByteBufferObject(object, buffer); and then byte[] stream = new byte[serializedSize + 10]; buffer.position(10); buffer.get(stream); following assert should pass assert object.equals(binarySerializer.deserializeNativeObject(stream, 10)) Final position of ByteBuffer will be changed and will be equal to sum of buffer start position and value returned by method OBinarySerializer.getObjectSize(Object, Object...)

Specified by:

serializeInByteBufferObject in interface OBinarySerializer<String>

Parameters:

object - Object to serialize.

buffer - Buffer which will contain serialized presentation of buffer.

hints - Type (types in case of composite object) of object.

deserializeFromByteBufferObject

public String deserializeFromByteBufferObject(ByteBuffer buffer)

Converts binary presentation of object to object instance. Position of buffer should be set before call of this method. Binary format of method is expected to be the same as binary format of OBinarySerializer.serializeNativeObject(Object, byte[], int, Object...) So if we call byte[] stream = new byte[serializedSize]; binarySerializer.serializeNativeObject(object, stream, 0); following assert should pass byteBuffer.position(10); byteBuffer.put(stream); byteBuffer.position(10); assert object.equals(binarySerializer.deserializeFromByteBufferObject(buffer)) Final position of ByteBuffer will be changed and will be equal to sum of buffer start position and value returned by method OBinarySerializer.getObjectSize(Object, Object...)

Specified by:

deserializeFromByteBufferObject in interface OBinarySerializer<String>

Parameters:

buffer - Buffer which contains serialized presentation of object

Returns:

Instance of object serialized in buffer.

getObjectSizeInByteBuffer

public int getObjectSizeInByteBuffer(ByteBuffer buffer)

Returns amount of bytes which is consumed by object which is already serialized in buffer. Position of buffer should be set before call of this method. Result of call should be the same as result of call of OBinarySerializer.getObjectSize(Object, Object...) on deserialized object.

Specified by:

getObjectSizeInByteBuffer in interface OBinarySerializer<String>

Parameters:

buffer - Buffer which contains serialized version of object

Returns:

Size of serialized object.

deserializeFromByteBufferObject

public String deserializeFromByteBufferObject(ByteBuffer buffer,
                                              OWALChanges walChanges,
                                              int offset)

Converts binary presentation of object to object instance taking in account changes which are done inside of atomic operation OAtomicOperation. Binary format of method is expected to be the same as binary format of method OBinarySerializer.serializeNativeObject(Object, byte[], int, Object...). So if we call: byte[] stream = new byte[serializedSize]; binarySerializer.serializeNativeObject(object, stream, 0); walChanges.setBinaryValue(buffer, stream, 10); Then following assert should pass assert object.equals(binarySerializer.deserializeFromByteBufferObject(buffer, walChanges, 10));

Specified by:

deserializeFromByteBufferObject in interface OBinarySerializer<String>

Parameters:

buffer - Buffer which will contain serialized changes.

walChanges - Changes are done during atomic operation.

offset - Offset of binary presentation of object inside of byte buffer/atomic operations changes.

Returns:

Instance of object serialized in buffer.

getObjectSizeInByteBuffer

public int getObjectSizeInByteBuffer(ByteBuffer buffer,
                                     OWALChanges walChanges,
                                     int offset)

Returns amount of bytes which is consumed by object which is already serialized in buffer taking in account changes which are done inside of atomic operation OAtomicOperation. Result of call should be the same as result of call of OBinarySerializer.getObjectSize(Object, Object...) on deserialized object.

Specified by:

getObjectSizeInByteBuffer in interface OBinarySerializer<String>

Parameters:

buffer - Buffer which will contain serialized changes.

walChanges - Changes are done during atomic operation.

offset - Offset of binary presentation of object inside of byte buffer/atomic operations changes.

Returns:

Size of serialized object.