org.helidb.lang.serializer
Class LongNullSerializer

java.lang.Object
  org.helidb.lang.serializer.LongSerializer
      org.helidb.lang.serializer.LongNullSerializer

All Implemented Interfaces:

Serializer<Long>

public class LongNullSerializer
extends LongSerializer

A Serializer for Long values that may be null. Long values are serialized to a eight bytes long, big-endian byte array. A special, configurable value is used to represent null.

The singleton instance INSTANCE uses Long.MIN_VALUE to represent null values. It may be used instead of instantiating this class.

Since:

1.0

Author:

Karl Gustafsson

See Also:

LongSerializer, ConfigurableLengthLongNullSerializer, Long

In_jar:

helidb-core

Field Summary

static LongNullSerializer

INSTANCE The singleton instance.

Fields inherited from class org.helidb.lang.serializer.LongSerializer

DATA_SIZE

Constructor Summary

LongNullSerializer(long nullValue)
Instantiate this class.

Method Summary

Long	interpret(byte[] barr) Interpret the data in the byte array to an object of the type handled by the Serializer implementation.
Long	interpret(byte[] barr, int offset, int length) Interpret the data in the byte array to an object of the type handled by the Serializer implementation.
boolean	isNullValuesPermitted() Does this serializer permit null values?
byte[]	serialize(Long value) Serialize the supplied object into a new byte array.
int	serialize(Long value, byte[] barr, int offset) Serialize the supplied object into the byte array.

Methods inherited from class org.helidb.lang.serializer.LongSerializer

encodeLong, getLong, getSerializedSize, read, read, readLong, readLong

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static final LongNullSerializer INSTANCE

The singleton instance. May be used instead of instantiating this class. It uses Long.MIN_VALUE to represent null values. That null value has the most significant bit of the most significant byte set, which may be important to know when working with Hasher:s.

Constructor Detail

LongNullSerializer

public LongNullSerializer(long nullValue)

Instantiate this class.

Parameters:

nullValue - The value used to represent null Long:s.

Method Detail

interpret

public Long interpret(byte[] barr,
                      int offset,
                      int length)

Description copied from interface: Serializer

Interpret the data in the byte array to an object of the type handled by the Serializer implementation.

Specified by:

interpret in interface Serializer<Long>

Overrides:

interpret in class LongSerializer

Parameters:

barr - The byte array containing the data.

offset - The start position of the data.

length - The length of the data.

Returns:

The interpreted object.

See Also:

Serializer.interpret(byte[])

interpret

public Long interpret(byte[] barr)

Description copied from interface: Serializer

Interpret the data in the byte array to an object of the type handled by the Serializer implementation.

Specified by:

interpret in interface Serializer<Long>

Overrides:

interpret in class LongSerializer

Parameters:

barr - The byte array containing the data.

Returns:

The interpreted object.

See Also:

Serializer.interpret(byte[], int, int)

serialize

public int serialize(Long value,
                     byte[] barr,
                     int offset)

Description copied from interface: Serializer

Serialize the supplied object into the byte array.

Specified by:

serialize in interface Serializer<Long>

Overrides:

serialize in class LongSerializer

Parameters:

value - The object to serialize.

barr - The byte array to serialize it to.

offset - The start position to write data at in the byte array.

Returns:

The number of bytes written to the array.

serialize

public byte[] serialize(Long value)

Description copied from interface: Serializer

Serialize the supplied object into a new byte array.

Specified by:

serialize in interface Serializer<Long>

Overrides:

serialize in class LongSerializer

Parameters:

value - The object to serialize.

Returns:

The object serialized into a byte array.

isNullValuesPermitted

public boolean isNullValuesPermitted()

Description copied from interface: Serializer

Does this serializer permit null values?

Specified by:

isNullValuesPermitted in interface Serializer<Long>

Overrides:

isNullValuesPermitted in class LongSerializer

Returns:

true, always.