org.helidb.lang.serializer
Class ShortNullSerializer

java.lang.Object
  org.helidb.lang.serializer.ShortSerializer
      org.helidb.lang.serializer.ShortNullSerializer

All Implemented Interfaces:

Serializer<Short>

public class ShortNullSerializer
extends ShortSerializer

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

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

Since:

1.0

Author:

Karl Gustafsson

See Also:

ShortSerializer, Short

In_jar:

helidb-core

Field Summary

static ShortNullSerializer

INSTANCE The singleton instance.

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

DATA_SIZE

Constructor Summary

ShortNullSerializer(short nullValue)
Instantiate this class.

Method Summary

Short	interpret(byte[] barr) Interpret the data in the byte array to an object of the type handled by the Serializer implementation.
Short	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(Short value) Serialize the supplied object into a new byte array.
int	serialize(Short value, byte[] barr, int offset) Serialize the supplied object into the byte array.

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

encodeShort, getSerializedSize, getShort, read, read, readShort, readShort

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static final ShortNullSerializer INSTANCE

The singleton instance. May be used instead of instantiating this class. It uses Short.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

ShortNullSerializer

public ShortNullSerializer(short nullValue)

Instantiate this class.

Parameters:

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

Method Detail

interpret

public Short 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<Short>

Overrides:

interpret in class ShortSerializer

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 Short 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<Short>

Overrides:

interpret in class ShortSerializer

Parameters:

barr - The byte array containing the data.

Returns:

The interpreted object.

See Also:

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

serialize

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

Description copied from interface: Serializer

Serialize the supplied object into the byte array.

Specified by:

serialize in interface Serializer<Short>

Overrides:

serialize in class ShortSerializer

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(Short value)

Description copied from interface: Serializer

Serialize the supplied object into a new byte array.

Specified by:

serialize in interface Serializer<Short>

Overrides:

serialize in class ShortSerializer

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<Short>

Overrides:

isNullValuesPermitted in class ShortSerializer

Returns:

true, always.