org.djutils.serialization

Class DjunitsArrayOrMatrixSerializer<T>

java.lang.Object

org.djutils.serialization.BasicSerializer<T>

org.djutils.serialization.DjunitsArrayOrMatrixSerializer<T>

Type Parameters:

T - Either Double of Float

All Implemented Interfaces:

Serializer<T>

public abstract class DjunitsArrayOrMatrixSerializer<T>
extends BasicSerializer<T>

Serializer for Djunits arrays and matrices.

Copyright (c) 2019-2019 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See OpenTrafficSim License.

Version:

$Revision$, $LastChangedDate$, by $Author$,

Author:

Alexander Verbraeck, Peter Knoppers, Wouter Schakel

Constructor Summary

Constructors

Constructor and Description
DjunitsArrayOrMatrixSerializer(byte type, String dataClassName, int numberOfDimensions) Construct a new serializer for Djunits arrays or matrices.

Method Summary

Modifier and Type	Method and Description
int	getNumberOfDimensions() Return the number of dimensions of the stored data.
void	serializeWithPrefix(T object, byte[] buffer, Pointer pointer, EndianUtil endianUtil) Serialize an object of type T including the prefix byte(s).
int	sizeWithPrefix(T object) Compute the number of bytes needed to serialize an object of type T (including the byte(s) that indicate that an object of type T is next in the data stream).

Methods inherited from class org.djutils.serialization.BasicSerializer

dataClassName, fieldType, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.djutils.serialization.Serializer

deSerialize, serialize, size

Constructor Detail

DjunitsArrayOrMatrixSerializer

public DjunitsArrayOrMatrixSerializer(byte type,
                                      String dataClassName,
                                      int numberOfDimensions)

Construct a new serializer for Djunits arrays or matrices.

Parameters:

type - byte; the field type (returned by the fieldType method)

dataClassName - String; returned by the dataClassName method

numberOfDimensions - int; should be 1 for array serializer and 2 for matrix serializer

Method Detail

sizeWithPrefix

public final int sizeWithPrefix(T object)
                         throws SerializationException

Description copied from interface: Serializer

Compute the number of bytes needed to serialize an object of type T (including the byte(s) that indicate that an object of type T is next in the data stream).

Parameters:

object - Instance of the object (should be instance of T)

Returns:

int; the number of bytes needed to serialize an object of type T

Throws:

SerializationException - when the object cannot be serialized

serializeWithPrefix

public final void serializeWithPrefix(T object,
                                      byte[] buffer,
                                      Pointer pointer,
                                      EndianUtil endianUtil)
                               throws SerializationException

Description copied from interface: Serializer

Serialize an object of type T including the prefix byte(s).

Parameters:

object - Object; the object to serialize (should be of type T)

buffer - byte[]; buffer for the serialized T

pointer - Pointer; position in buffer where the first byte of the serialized T will be stored

endianUtil - EndianUtil; selects bigEndian or littleEndian encoding

Throws:

SerializationException - when a matrix has size zero or is jagged

getNumberOfDimensions

public final int getNumberOfDimensions()

Description copied from interface: Serializer

Return the number of dimensions of the stored data.

Returns:

int; 0 for plain data, 1 for array, 2 for matrix