org.helidb.lang.serializer
Class BooleanSerializer

java.lang.Object
  org.helidb.lang.serializer.BooleanSerializer

All Implemented Interfaces:

Serializer<Boolean>

public class BooleanSerializer
extends Object
implements Serializer<Boolean>

This is a Serializer for Boolean values. Every boolean value serialized by this object will be represented by 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:

Boolean

In_jar:

helidb-core

Field Summary

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

Constructor Summary

BooleanSerializer()

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

BooleanSerializer

public BooleanSerializer()

Method Detail

interpret

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

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

Parameters:

barr - The byte array containing the data.

Returns:

The interpreted object.

See Also:

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

serialize

public byte[] serialize(Boolean value)

Description copied from interface: Serializer

Serialize the supplied object into a new byte array.

Specified by:

serialize in interface Serializer<Boolean>

Parameters:

value - The object to serialize.

Returns:

The object serialized into a byte array.

serialize

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

Description copied from interface: Serializer

Serialize the supplied object into the byte array.

Specified by:

serialize in interface Serializer<Boolean>

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.

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

Returns:

1, always.

isNullValuesPermitted

public boolean isNullValuesPermitted()

Description copied from interface: Serializer

Does this serializer permit null values?

Specified by:

isNullValuesPermitted in interface Serializer<Boolean>

Returns:

false, always.

readBoolean

public Boolean readBoolean(RandomAccess ra)
                    throws NotEnoughDataException,
                           WrappedIOException

Read a Boolean 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 Boolean value.

Throws:

NotEnoughDataException - If 1 bytes cannot be read.

WrappedIOException - On I/O errors

readBoolean

public Boolean readBoolean(InputStream is)
                    throws WrappedIOException,
                           NotEnoughDataException

Read a Boolean 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 Boolean value.

Throws:

NotEnoughDataException - If 1 bytes cannot be read.

WrappedIOException - If an IOException is encountered while reading data.

read

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

Parameters:

ra - The RandomAccess to read from.

dataSize - The size of the value.

Returns:

The value.

read

public Boolean read(InputStream is,
                    int dataSize)

Description copied from interface: Serializer

Read a value from the InputStream.

Specified by:

read in interface Serializer<Boolean>

Parameters:

is - The InputStream to read from.

dataSize - The size of the value.

Returns:

The value.