org.djutils.serialization

Class ItemName

java.lang.Object

org.djutils.serialization.ItemName

All Implemented Interfaces:

Serializer<String>

public class ItemName
extends Object
implements Serializer<String>

Serializable name for the next item in the stream, data, whatever. This serializer serializes strings that are no longer than 255 characters and contain only one-byte ASCII characters.

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.

$LastChangedDate: 2015-07-24 02:58:59 +0200 (Fri, 24 Jul 2015) $, @version $Revision: 1147 $, by $Author: averbraeck $, initial version Jun 18, 2019

Author:

Alexander Verbraeck, Peter Knoppers

Constructor Summary

Constructors

Constructor and Description
ItemName(byte[] buffer, Pointer pointer) Construct a new ItemName from serialized data.
ItemName(String string) Construct a new ItemName.

Method Summary

Modifier and Type	Method and Description
String	dataClassName() Return a description of the type of data that this serializer handles.
String	deSerialize(byte[] buffer, Pointer pointer, EndianUtil endianUtil) Deserialize an object of type T.
byte	fieldType() Return the byte representation of the field type.
int	getNumberOfDimensions() Return the number of dimensions of the stored data.
void	serialize(String object, byte[] buffer, Pointer pointer, EndianUtil endianUtil) Serialize an object of type T; not including the prefix byte(s).
void	serializeWithPrefix(String object, byte[] buffer, Pointer pointer, EndianUtil endianUtil) Serialize an object of type T including the prefix byte(s).
int	size(String object) Compute the number of bytes needed to serialize an object of type T (excluding the byte(s) that indicate that an object of type T is next in the data stream).
int	sizeWithPrefix(String 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 java.lang.Object

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

Constructor Detail

ItemName

public ItemName(String string)
         throws SerializationException

Construct a new ItemName.

Parameters:

string - String; name of the item

Throws:

SerializationException - when the string is too long, or contains illegal characters

ItemName

public ItemName(byte[] buffer,
                Pointer pointer)

Construct a new ItemName from serialized data.

Parameters:

buffer - byte[]; the data

pointer - Pointer; position in the data

Method Detail

size

public int size(String object)
         throws SerializationException

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

Specified by:

size in interface Serializer<String>

Parameters:

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

Returns:

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

Throws:

SerializationException - when the object cannot be serialized

sizeWithPrefix

public int sizeWithPrefix(String object)
                   throws SerializationException

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).

Specified by:

sizeWithPrefix in interface Serializer<String>

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

fieldType

public byte fieldType()

Return the byte representation of the field type.

Specified by:

fieldType in interface Serializer<String>

Returns:

byte

serialize

public void serialize(String object,
                      byte[] buffer,
                      Pointer pointer,
                      EndianUtil endianUtil)
               throws SerializationException

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

Specified by:

serialize in interface Serializer<String>

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

serializeWithPrefix

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

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

Specified by:

serializeWithPrefix in interface Serializer<String>

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

deSerialize

public String deSerialize(byte[] buffer,
                          Pointer pointer,
                          EndianUtil endianUtil)

Deserialize an object of type T. The pointer should be on the first byte of the object; i.e. just after the prefix byte.

Specified by:

deSerialize in interface Serializer<String>

Parameters:

buffer - byte[]; the bytes with serialized data that must be reconstructed into a T

pointer - Pointer; position in the buffer where the first byte of the serialized T is located

endianUtil - EndianUtil; selects bigEndian or littleEndian encoding

Returns:

T; a T object constructed from the data in the buffer

dataClassName

public String dataClassName()

Return a description of the type of data that this serializer handles.

Specified by:

dataClassName in interface Serializer<String>

Returns:

String; description of the type of data that this serializer handles

getNumberOfDimensions

public final int getNumberOfDimensions()

Description copied from interface: Serializer

Return the number of dimensions of the stored data.

Specified by:

getNumberOfDimensions in interface Serializer<String>

Returns:

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