Package com.casper.sdk.model.transaction.field

Class CalltableSerializationEnvelopeBuilder

java.lang.Object

com.casper.sdk.model.transaction.field.CalltableSerializationEnvelopeBuilder

All Implemented Interfaces:

CasperSerializableObject, DeserializableObject, SerializableObject

public class CalltableSerializationEnvelopeBuilder
extends java.lang.Object
implements CasperSerializableObject, DeserializableObject

The call table serialization envelope builder used to serialize and deserialize transaction fields

Constructor Summary

Constructors

Constructor	Description
CalltableSerializationEnvelopeBuilder(Target target)

Method Summary

Modifier and Type	Method	Description
<T> CalltableSerializationEnvelopeBuilder	addField(int index, T value)	Add a mandatory field to the envelope.
CalltableSerializationEnvelopeBuilder	addField(Field field)	Adds a field to the envelope.
CalltableSerializationEnvelopeBuilder	addFieldBytes(int index, byte[] value)	Add a field to the envelope.
<T> CasperSerializableObject	addOptionField(int index, T value)	Add an optional field to the envelope.
void	deserialize(DeserializerBuffer deserializerBuffer)	Called when the object's values must be deserialized
byte[]	getFieldBytes(int index)	Obtains the field's value bytes.
<T> T	getFieldValue(int index, java.lang.Class<T> clazz)	Obtains the fields and converts its byte value to the specified type.
void	serialize(SerializerBuffer ser, Target target)	Called when the object's values must be serialized
void	setCurrentFieldIndex(long currentFieldIndex)	The current field index
void	setFields(java.util.List<Field> fields)	The fields to serialize
void	setOffset(long offset)	The offset of the current field om the serialized bytes
void	setSize(long size)	The total size of all field values when serialized
void	setTarget(Target target)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.casper.sdk.model.clvalue.serde.CasperSerializableObject

serialize

Constructor Detail

CalltableSerializationEnvelopeBuilder

public CalltableSerializationEnvelopeBuilder(Target target)

Method Detail

addField

public <T> CalltableSerializationEnvelopeBuilder addField(int index,
                                                          T value)
                                                   throws ValueSerializationException,
                                                          NoSuchTypeException

Add a mandatory field to the envelope.

Parameters:

index - the zero based index

value - the value to be serialized to value bytes of the field

Throws:

ValueSerializationException

NoSuchTypeException

addOptionField

public <T> CasperSerializableObject addOptionField(int index,
                                                   T value)
                                            throws ValueSerializationException,
                                                   NoSuchTypeException

Add an optional field to the envelope.

Parameters:

index - the zero based index

value - the value to be serialized to value bytes of the field

Throws:

ValueSerializationException

NoSuchTypeException

addFieldBytes

public CalltableSerializationEnvelopeBuilder addFieldBytes(int index,
                                                           byte[] value)

Add a field to the envelope.

Parameters:

index - the zero based index

value - the bytes of the value to add

addField

public CalltableSerializationEnvelopeBuilder addField(Field field)

Adds a field to the envelope.

Parameters:

field - the field to add

getFieldValue

public <T> T getFieldValue(int index,
                           java.lang.Class<T> clazz)
                    throws ValueDeserializationException

Obtains the fields and converts its byte value to the specified type.

Type Parameters:

T - the type to convert the field value to

Parameters:

index - the index of the field

clazz - the tye to convert the field value to

Returns:

the field value as the specified type

Throws:

ValueDeserializationException - if the field value cannot be converted to the specified type

getFieldBytes

public byte[] getFieldBytes(int index)

Obtains the field's value bytes.

Parameters:

index - the index of the field

Returns:

the fields value bytes

serialize

public void serialize(SerializerBuffer ser,
                      Target target)
               throws ValueSerializationException

Description copied from interface: CasperSerializableObject

Called when the object's values must be serialized

Specified by:

serialize in interface CasperSerializableObject

Parameters:

ser - the serializer to be used

target - target serialization standard

Throws:

ValueSerializationException - exception holding information of failure to serialize a value

deserialize

public void deserialize(DeserializerBuffer deserializerBuffer)
                 throws ValueDeserializationException

Description copied from interface: DeserializableObject

Called when the object's values must be deserialized

Specified by:

deserialize in interface DeserializableObject

Parameters:

deserializerBuffer - the deserializer buffer to be used

Throws:

ValueDeserializationException - exception holding information of failure to deserialize a value

setFields

public void setFields(java.util.List<Field> fields)

The fields to serialize

setCurrentFieldIndex

public void setCurrentFieldIndex(long currentFieldIndex)

The current field index

setOffset

public void setOffset(long offset)

The offset of the current field om the serialized bytes

setSize

public void setSize(long size)

The total size of all field values when serialized

setTarget

public void setTarget(Target target)