org.helidb.lang.serializer
Class ConfigurableLengthIntegerSerializer

java.lang.Object
  org.helidb.lang.serializer.ConfigurableLengthIntegerSerializer

All Implemented Interfaces:

Serializer<Integer>

Direct Known Subclasses:

ConfigurableLengthIntegerNullSerializer

public class ConfigurableLengthIntegerSerializer
extends Object
implements Serializer<Integer>

This Serializer serializes Integer values to a big-endian byte array of configurable size. The length of the byte array determines how big the serialized Integer:s can be. For a byte array length of n bytes, the maximum Integer value is 2^(n*8), except if n has its maximum value of 4, then the maximum value is Integer.MAX_VALUE. Negative values are only supported if n == 4.

Since:

1.0

Author:

Karl Gustafsson

See Also:

IntegerSerializer, ConfigurableLengthIntegerNullSerializer, ConfigurableLengthLongSerializer, Integer

In_jar:

helidb-core

Constructor Summary

ConfigurableLengthIntegerSerializer(int dataSize)
Create a new Serializer.

Method Summary

int	getSerializedSize() If the serialized data produced by this serializer always is of the same size, return that size (in number of bytes).
Integer	interpret(byte[] barr) Interpret the data in the byte array to an object of the type handled by the Serializer implementation.
Integer	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?
Integer	read(InputStream is, int dataSize) Read a value from the InputStream.
Integer	read(RandomAccess ra, int dataSize) Read a value from the RandomAccess' current position.
Integer	readInteger(InputStream is) Read an Integer value from the current position of the InputStream.
Integer	readInteger(RandomAccess ra) Read an Integer value from the current position of the RandomAccess.
byte[]	serialize(Integer val) Serialize the supplied object into a new byte array.
int	serialize(Integer val, 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

Constructor Detail

ConfigurableLengthIntegerSerializer

public ConfigurableLengthIntegerSerializer(int dataSize)
                                    throws IllegalArgumentException

Create a new Serializer.

Parameters:

dataSize - The number of bytes used to represent the Integer :s.

Throws:

IllegalArgumentException - If the data size is not in the range 1 <= dataSize <= 4.

Method Detail

getSerializedSize

public final 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<Integer>

Returns:

The size of the serialized data in number of byte if it is always the same, or -1 if the size of the serialized data is variable.

isNullValuesPermitted

public boolean isNullValuesPermitted()

Description copied from interface: Serializer

Does this serializer permit null values?

Specified by:

isNullValuesPermitted in interface Serializer<Integer>

Returns:

false, always.

interpret

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

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

Parameters:

barr - The byte array containing the data.

Returns:

The interpreted object.

See Also:

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

serialize

public int serialize(Integer val,
                     byte[] barr,
                     int offset)

Description copied from interface: Serializer

Serialize the supplied object into the byte array.

Specified by:

serialize in interface Serializer<Integer>

Parameters:

val - 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(Integer val)

Description copied from interface: Serializer

Serialize the supplied object into a new byte array.

Specified by:

serialize in interface Serializer<Integer>

Parameters:

val - The object to serialize.

Returns:

The object serialized into a byte array.

readInteger

public Integer readInteger(RandomAccess ra)
                    throws NotEnoughDataException,
                           WrappedIOException

Read an Integer value from the current position of the RandomAccess.

Parameters:

ra - The RandomAccess to read from. The current position of this is incremented by the number of bytes that are used to represent the Integer value.

Returns:

The Integer value.

Throws:

NotEnoughDataException - If enough data cannot be read.

WrappedIOException - On I/O errors.

readInteger

public Integer readInteger(InputStream is)
                    throws NotEnoughDataException,
                           WrappedIOException

Read an Integer value from the current position of the InputStream.

Parameters:

is - The InputStream to read from. The current position of the stream is incremented by the number of bytes that are used to represent the Integer value.

Returns:

The Integer value.

Throws:

NotEnoughDataException - If enough data cannot be read.

WrappedIOException - If an IOException is encountered while reading data.

read

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

Parameters:

ra - The RandomAccess to read from.

dataSize - The size of the value.

Returns:

The value.

read

public Integer read(InputStream is,
                    int dataSize)

Description copied from interface: Serializer

Read a value from the InputStream.

Specified by:

read in interface Serializer<Integer>

Parameters:

is - The InputStream to read from.

dataSize - The size of the value.

Returns:

The value.