org.helidb.lang.serializer
Class ByteSerializer

java.lang.Object
  org.helidb.lang.serializer.ByteSerializer

All Implemented Interfaces:

Serializer<Byte>

public class ByteSerializer
extends Object
implements Serializer<Byte>

A Serializer for Byte values. Every Byte value serialized by this object is represented as a byte array of length one.

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:

Byte, UnsignedByteSerializer

In_jar:

helidb-core

Field Summary

static int	DATA_SIZE One byte.
static ByteSerializer	INSTANCE The singleton instance.

Constructor Summary

ByteSerializer()

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).
Byte	interpret(byte[] barr) Interpret the data in the byte array to an object of the type handled by the Serializer implementation.
Byte	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	read(InputStream is, int dataSize) Read a value from the InputStream.
Byte	read(RandomAccess ra, int dataSize) Read a value from the RandomAccess' current position.
Byte	readByte(InputStream is) Read a Byte value from the current position of the InputStream.
Byte	readByte(RandomAccess ra) Read a Byte value from the current position of the RandomAccess.
byte[]	serialize(Byte value) Serialize the supplied object into a new byte array.
int	serialize(Byte value, byte[] arr, 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 ByteSerializer INSTANCE

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

DATA_SIZE

public static final int DATA_SIZE

One byte.

See Also:

Constant Field Values

Constructor Detail

ByteSerializer

public ByteSerializer()

Method Detail

interpret

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

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

Parameters:

barr - The byte array containing the data.

Returns:

The interpreted object.

See Also:

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

serialize

public int serialize(Byte value,
                     byte[] arr,
                     int offset)

Description copied from interface: Serializer

Serialize the supplied object into the byte array.

Specified by:

serialize in interface Serializer<Byte>

Parameters:

value - The object to serialize.

arr - 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(Byte value)

Description copied from interface: Serializer

Serialize the supplied object into a new byte array.

Specified by:

serialize in interface Serializer<Byte>

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

Returns:

1, always.

isNullValuesPermitted

public boolean isNullValuesPermitted()

Description copied from interface: Serializer

Does this serializer permit null values?

Specified by:

isNullValuesPermitted in interface Serializer<Byte>

Returns:

false, always.

readByte

public Byte readByte(RandomAccess ra)
              throws NotEnoughDataException,
                     WrappedIOException

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

Parameters:

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

Returns:

The Byte value.

Throws:

DatabaseException - If 1 bytes cannot be read.

WrappedIOException - On I/O errors.

NotEnoughDataException

readByte

public Byte readByte(InputStream is)
              throws NotEnoughDataException,
                     WrappedIOException

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

Parameters:

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

Returns:

The Byte value.

Throws:

NotEnoughDataException - If 1 bytes cannot be read.

WrappedIOException - If an IOException is encountered while reading data.

read

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

Parameters:

ra - The RandomAccess to read from.

dataSize - The size of the value.

Returns:

The value.

read

public Byte read(InputStream is,
                 int dataSize)

Description copied from interface: Serializer

Read a value from the InputStream.

Specified by:

read in interface Serializer<Byte>

Parameters:

is - The InputStream to read from.

dataSize - The size of the value.

Returns:

The value.