Package org.djutils.serialization.serializers

Class ArrayOrMatrixWithUnitSerializer<U extends org.djunits.unit.Unit<U>,T>

java.lang.Object
org.djutils.serialization.serializers.BasicSerializer<T>
org.djutils.serialization.serializers.ArrayOrMatrixWithUnitSerializer<U,T>
Type Parameters:
U - the unit type
T - The object type to (de)serialize
All Implemented Interfaces:
Serializer<T>
Direct Known Subclasses:
DoubleMatrixSerializer, DoubleVectorSerializer, FloatMatrixSerializer, FloatVectorSerializer
public abstract class ArrayOrMatrixWithUnitSerializer<U extends org.djunits.unit.Unit<U>,T> extends BasicSerializer<T>
Serializer for Djunits arrays and matrices.

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

Author:
Alexander Verbraeck, Peter Knoppers

  • Constructor Details

    • ArrayOrMatrixWithUnitSerializer

      public ArrayOrMatrixWithUnitSerializer(byte type, String dataClassName, int numberOfDimensions)
      Construct a new serializer for Djunits arrays or matrices.
      Parameters:
      type - the field type (returned by the fieldType method)
      dataClassName - returned by the dataClassName method
      numberOfDimensions - should be 1 for array serializer and 2 for matrix serializer

  • Method Details

    • 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
      Returns:
      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 - the object to serialize
      buffer - buffer for the serialized T
      pointer - position in buffer where the first byte of the serialized T will be stored
      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:
      0 for plain data, 1 for array, 2 for matrix

    • getElementSize

      public abstract int getElementSize()
      Return the size of an element in the djunits vector or array.
      Returns:
      the size of one element in number of bytes

    • hasUnit

      public boolean hasUnit()
      Description copied from interface: Serializer
      Return whether the serializer uses a single unit type or not.
      Returns:
      whether the serializer uses a single unit type or not

    • encodeUnit

      protected void encodeUnit(U unit, byte[] message, Pointer pointer, EndianUtil endianUtil)
      Code a unit.
      Parameters:
      unit - the unit to code in the byte array
      message - the byte array
      pointer - the start pointer in the byte array
      endianUtil - encoder to use for multi-byte values

    • getUnit

      protected U getUnit(byte[] buffer, Pointer pointer, EndianUtil endianUtil)
      Retrieve and decode a DJUNITS unit.
      Parameters:
      buffer - the encoded data
      pointer - position in the encoded data where the unit is to be decoded from
      endianUtil - decoder for multi-byte values
      Returns:
      Unit