zserio.runtime.io

Class SerializeUtil

java.lang.Object

zserio.runtime.io.SerializeUtil

public final class SerializeUtil
extends java.lang.Object

Provides help methods for serialization and deserialization of generated objects.

These utilities are not used by generated code and they are provided only for user convenience.

Constructor Summary

Constructors

Constructor and Description
SerializeUtil()

Method Summary

Modifier and Type	Method and Description
static <T> T	deserialize(java.lang.Class<T> clazz, BitBuffer bitBuffer, java.lang.Object... arguments) Deserializes bit buffer to the generated object.
static <T> T	deserializeFromBytes(java.lang.Class<T> clazz, byte[] buffer, java.lang.Object... arguments) Deserializes byte array to the generated object.
static <T> T	deserializeFromFile(java.lang.Class<T> clazz, java.io.File file, java.lang.Object... arguments) Deserializes file to the generated object.
static <T> T	deserializeFromFile(java.lang.Class<T> clazz, java.lang.String fileName, java.lang.Object... arguments) Deserializes file to the generated object using file name.
static <T extends Writer> BitBuffer	serialize(T object) Serializes generated object to the bit buffer.
static <T extends Writer> byte[]	serializeToBytes(T object) Serializes generated object to the byte array.
static <T extends Writer> void	serializeToFile(T object, java.io.File file) Serializes generated object to the file.
static <T extends Writer> void	serializeToFile(T object, java.lang.String fileName) Serializes generated object to the file using file name.

Methods inherited from class java.lang.Object

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

Constructor Detail

SerializeUtil

public SerializeUtil()

Method Detail

serialize

public static <T extends Writer> BitBuffer serialize(T object)

Serializes generated object to the bit buffer.

Before serialization, the method calls initializeOffsets() on the given zserio object.

Example:

 import zserio.runtime.io.SerializeUtil;

 final SomeZserioObject object = new SomeZserioObject();
 final BitBuffer bitBuffer = SerializeUtil.serialize(object);
 

Type Parameters:

T - Type of generated object.

Parameters:

object - Generated object to serialize.

Returns:

Bit buffer which represents generated object in binary format.

deserialize

public static <T> T deserialize(java.lang.Class<T> clazz,
                                BitBuffer bitBuffer,
                                java.lang.Object... arguments)

Deserializes bit buffer to the generated object.

Example:

 import zserio.runtime.io.SerializeUtil;

 final SomeZserioObject object = new SomeZserioObject();
 final BitBuffer bitBuffer = SerializeUtil.serialize(object);
 final SomeZserioObject readObject = SerializeUtil.deserialize(SomeZserioObject.class, bitBuffer);
 

Type Parameters:

T - Type of generated object.

Parameters:

clazz - Class instance of the generated object to deserialize.

bitBuffer - Bit buffer which represents generated object in binary format.

arguments - Additional arguments needed for reader constructor (optional).

Returns:

Generated object created from given bit buffer.

serializeToBytes

public static <T extends Writer> byte[] serializeToBytes(T object)

Serializes generated object to the byte array.

Before serialization, the method calls initializeOffsets() on the given zserio object.

This is a convenient method for users which do not need exact number of bits to which the given object will be serialized.

However, it's still possible that not all bits of the last byte are used. In this case, only most significant bits of the corresponding size are used.

Example:

 import zserio.runtime.io.SerializeUtil;

 final SomeZserioObject object = new SomeZserioObject();
 final byte[] buffer = SerializeUtil.serializeToBytes(object);
 

Type Parameters:

T - Type of generated object.

Parameters:

object - Generated object to serialize.

Returns:

Byte array which represents generated object in binary format.

deserializeFromBytes

public static <T> T deserializeFromBytes(java.lang.Class<T> clazz,
                                         byte[] buffer,
                                         java.lang.Object... arguments)

Deserializes byte array to the generated object.

This method can potentially use all bits of the last byte even if not all of them were written during serialization (because there is no way how to specify exact number of bits). Thus, it could allow reading behind stream (possibly in case of damaged data).

Example:

 import zserio.runtime.io.SerializeUtil;

 final SomeZserioObject object = new SomeZserioObject();
 final byte[] buffer = SerializeUtil.serializeToBytes(object);
 final SomeZserioObject readObject = SerializeUtil.deserializeFromBytes(SomeZserioObject.class, buffer);
 

Type Parameters:

T - Type of generated object.

Parameters:

clazz - Class instance of the generated object to deserialize.

buffer - Byte array which represents generated object in binary format.

arguments - Additional arguments needed for reader constructor (optional).

Returns:

Generated object created from given byte array.

serializeToFile

public static <T extends Writer> void serializeToFile(T object,
                                                      java.lang.String fileName)

Serializes generated object to the file using file name.

Before serialization, the method calls initializeOffsets() on the given zserio object.

This is a convenient method for users to easily write given generated object to file.

Example:

 import zserio.runtime.io.SerializeUtil;

 final SomeZserioObject object = new SomeZserioObject();
 SerializeUtil.serializeToFile(object, "FileName.bin");
 

Type Parameters:

T - Type of generated object.

Parameters:

object - Generated object to serialize.

fileName - Name of the file to write.

serializeToFile

public static <T extends Writer> void serializeToFile(T object,
                                                      java.io.File file)

Serializes generated object to the file.

Before serialization, the method calls initializeOffsets() on the given zserio object.

This is a convenient method for users to easily write given generated object to file.

Example:

 import zserio.runtime.io.SerializeUtil;

 final SomeZserioObject object = new SomeZserioObject();
 SerializeUtil.serializeToFile(object, "FileName.bin");
 

Type Parameters:

T - Type of generated object.

Parameters:

object - Generated object to serialize.

file - File to write.

deserializeFromFile

public static <T> T deserializeFromFile(java.lang.Class<T> clazz,
                                        java.lang.String fileName,
                                        java.lang.Object... arguments)

Deserializes file to the generated object using file name.

This is a convenient method for users to easily read given generated object from file.

Example:

 import zserio.runtime.io.SerializeUtil;

 final String fileName = "FileName.bin";
 final SomeZserioObject object = new SomeZserioObject();
 SerializeUtil.serializeToFile(object, fileName);
 final SomeZserioObject readObject = SerializeUtil.deserializeFromFile(SomeZserioObject.class, fileName);
 

Type Parameters:

T - Type of generated object.

Parameters:

clazz - Class instance of the generated object to deserialize.

fileName - Name of the file which represents generated object in binary format.

arguments - Additional arguments needed for reader constructor (optional).

Returns:

Generated object created from given file contents.

deserializeFromFile

public static <T> T deserializeFromFile(java.lang.Class<T> clazz,
                                        java.io.File file,
                                        java.lang.Object... arguments)

Deserializes file to the generated object.

This is a convenient method for users to easily read given generated object from file.

Example:

 import zserio.runtime.io.SerializeUtil;

 final String fileName = "FileName.bin";
 final SomeZserioObject object = new SomeZserioObject();
 SerializeUtil.serializeToFile(object, fileName);
 final SomeZserioObject readObject = SerializeUtil.deserializeFromFile(SomeZserioObject.class, fileName);
 

Type Parameters:

T - Type of generated object.

Parameters:

clazz - Class instance of the generated object to deserialize.

file - File which represents generated object in binary format.

arguments - Additional arguments needed for reader constructor (optional).

Returns:

Generated object created from given file contents.