fr.dyade.aaa.common.encoding

Interface Encodable

All Known Implementing Classes:

EncodableInteger, EncodedString, EncodedStringList, Properties, SerializableWrapper, StringPair

public interface Encodable

This interface has to be provided by every object that needs to be encoded according to the encoding framework.

Field Summary

Fields

Modifier and Type	Field and Description
static int	BOOLEAN_ENCODED_SIZE
static int	BYTE_ENCODED_SIZE
static int	DOUBLE_ENCODED_SIZE
static int	FLOAT_ENCODED_SIZE
static int	INT_ENCODED_SIZE
static int	LONG_ENCODED_SIZE
static int	SHORT_ENCODED_SIZE

Method Summary

Modifier and Type	Method and Description
void	decode(Decoder decoder) Decodes the content of this object
void	encode(Encoder encoder) Encodes the content of this object
int	getEncodableClassId() Returns a unique class identifier.
int	getEncodedSize() Returns the size of the byte array that results from the encoding of this object.

Field Detail

BOOLEAN_ENCODED_SIZE

static final int BOOLEAN_ENCODED_SIZE

See Also:

Constant Field Values

BYTE_ENCODED_SIZE

static final int BYTE_ENCODED_SIZE

See Also:

Constant Field Values

SHORT_ENCODED_SIZE

static final int SHORT_ENCODED_SIZE

See Also:

Constant Field Values

INT_ENCODED_SIZE

static final int INT_ENCODED_SIZE

See Also:

Constant Field Values

LONG_ENCODED_SIZE

static final int LONG_ENCODED_SIZE

See Also:

Constant Field Values

FLOAT_ENCODED_SIZE

static final int FLOAT_ENCODED_SIZE

See Also:

Constant Field Values

DOUBLE_ENCODED_SIZE

static final int DOUBLE_ENCODED_SIZE

See Also:

Constant Field Values

Method Detail

getEncodableClassId

int getEncodableClassId()

Returns a unique class identifier.

Returns:

a unique class identifier

getEncodedSize

int getEncodedSize()
            throws Exception

Returns the size of the byte array that results from the encoding of this object.

Returns:

the size of the encoded byte array

Throws:

Exception - if an error occurs

encode

void encode(Encoder encoder)
     throws Exception

Encodes the content of this object

Parameters:

encoder - the encoder to be used for the encoding

Throws:

Exception - if an error occurs

decode

void decode(Decoder decoder)
     throws Exception

Decodes the content of this object

Parameters:

decoder - the decoder to be used for the decoding

Throws:

Exception - if an error occurs