org.helidb.lang.serializer
Class ShortSerializer

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

All Implemented Interfaces:

Serializer<Short>

Direct Known Subclasses:

ShortNullSerializer

public class ShortSerializer
extends Object
implements Serializer<Short>

A Serializer for Short values. Short values are serialized to two bytes long, big-endian byte arrays.

This serializer does not handle null values.

The singleton instance INSTANCE may be used instead of creating a new object of this class.

Since:

1.0

Author:

Karl Gustafsson

See Also:

ShortNullSerializer, Short

In_jar:

helidb-core

Field Summary

static int	DATA_SIZE Two bytes.
static ShortSerializer	INSTANCE The singleton instance.

Constructor Summary

ShortSerializer()

Method Summary

static byte[]	encodeShort(short s) Encode a short value to a two bytes long, big-endian byte array.
int	getSerializedSize() If the serialized data produced by this serializer always is of the same size, return that size (in number of bytes).
static short	getShort(byte[] barr) Get the short value encoded in the byte array.
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?
Short	read(InputStream is, int dataSize) Read a value from the InputStream.
Short	read(RandomAccess ra, int dataSize) Read a value from the RandomAccess' current position.
Short	readShort(InputStream is) Read a Short value from the current position of the InputStream.
Short	readShort(RandomAccess ra) Read a Short value from the current position of the RandomAccess.
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 java.lang.Object

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

Field Detail

INSTANCE

public static final ShortSerializer INSTANCE

The singleton instance. May be used instead of instantiating this class.

DATA_SIZE

public static final int DATA_SIZE

Two bytes.

See Also:

Constant Field Values

Constructor Detail

ShortSerializer

public ShortSerializer()

Method Detail

getShort

public static short getShort(byte[] barr)
                      throws SerializationException,
                             NullPointerException

Get the short value encoded in the byte array.

Parameters:

barr - The byte array. It must be two bytes long and big-endian.

Returns:

The short value encoded in the array.

Throws:

SerializationException - If the array length is different from two bytes.

NullPointerException - If barr is null

See Also:

encodeShort(short)

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>

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>

Parameters:

barr - The byte array containing the data.

Returns:

The interpreted object.

See Also:

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

encodeShort

public static byte[] encodeShort(short s)

Encode a short value to a two bytes long, big-endian byte array.

Parameters:

s - The short to encode.

Returns:

A two bytes long byte array.

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>

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>

Parameters:

value - The object to serialize.

Returns:

The object serialized into a byte array.

getSerializedSize

public int getSerializedSize()

Description copied from interface: Serializer

If the serialized data produced by this serializer always is of the same size, return that size (in number of bytes). Otherwise -1 is returned.

Specified by:

getSerializedSize in interface Serializer<Short>

Returns:

2, always.

isNullValuesPermitted

public boolean isNullValuesPermitted()

Description copied from interface: Serializer

Does this serializer permit null values?

Specified by:

isNullValuesPermitted in interface Serializer<Short>

Returns:

false, always.

readShort

public Short readShort(RandomAccess ra)
                throws NotEnoughDataException,
                       WrappedIOException

Read a Short value from the current position of the RandomAccess.

Parameters:

ra - The RandomAccess to read from. The current position of this is incremented by 2 bytes.

Returns:

The Short value.

Throws:

NotEnoughDataException - If 2 bytes cannot be read.

WrappedIOException - On I/O errors.

readShort

public Short readShort(InputStream is)
                throws NotEnoughDataException,
                       WrappedIOException

Read a Short value from the current position of the InputStream.

Parameters:

is - The InputStream to read from. The current position of the stream is incremented by 2 bytes.

Returns:

The Short value.

Throws:

NotEnoughDataException - If 2 bytes cannot be read.

WrappedIOException - If an IOException is encountered while reading data.

read

public Short read(RandomAccess ra,
                  int dataSize)

Description copied from interface: Serializer

Read a value from the RandomAccess' current position. The position in the RandomAccess is incremented by size bytes.

Specified by:

read in interface Serializer<Short>

Parameters:

ra - The RandomAccess to read from.

dataSize - The size of the value.

Returns:

The value.

read

public Short read(InputStream is,
                  int dataSize)

Description copied from interface: Serializer

Read a value from the InputStream.

Specified by:

read in interface Serializer<Short>

Parameters:

is - The InputStream to read from.

dataSize - The size of the value.

Returns:

The value.