Package energy.eddie.cim.serde

Interface MessageSerde

All Known Implementing Classes:
JsonMessageSerde, XmlMessageSerde
public interface MessageSerde
A serde is a SERializer-DEserializer, which supports one or multiple formats to serialize and deserialize objects to and from.

  • Method Summary

    Modifier and Type
    Method
    Description
    default <T> T
    deserialize(byte[] message, MessageType messageType)
    Deserializes a message based on a MessageType.
    <T> T
    deserialize(byte[] message, Class<T> messageType)
    Deserializes a message to a given class.
    default <T> List<T>
    deserializeList(byte[] message, MessageType elementType)
    Deserializes a message to a list of elements based on a MessageType.
    <T> List<T>
    deserializeList(byte[] message, Class<T> elementType)
    Deserializes a message to a list of elements based on the given elementType.
    byte[]
    serialize(Object message)
    Serializes an object to a byte array.

  • Method Details

    • serialize

      byte[] serialize(Object message) throws SerializationException
      Serializes an object to a byte array.
      Parameters:
      message - the object to be serialized.
      Returns:
      a serialized byte array
      Throws:
      SerializationException - if the serialization failed

    • deserialize

      <T> T deserialize(byte[] message, Class<T> messageType) throws DeserializationException
      Deserializes a message to a given class.
      Type Parameters:
      T - the destination type.
      Parameters:
      message - the message that should be deserialized.
      messageType - the class of the destination type.
      Returns:
      the deserialized object.
      Throws:
      DeserializationException - if the deserialization fails.

    • deserialize

      default <T> T deserialize(byte[] message, MessageType messageType) throws DeserializationException
      Deserializes a message based on a MessageType.
      Type Parameters:
      T - the destination type.
      Parameters:
      message - the message that should be deserialized.
      messageType - the type of the destination message.
      Returns:
      the deserialized object.
      Throws:
      DeserializationException - if the deserialization fails.

    • deserializeList

      <T> List<T> deserializeList(byte[] message, Class<T> elementType) throws DeserializationException
      Deserializes a message to a list of elements based on the given elementType.
      Type Parameters:
      T - the element type.
      Parameters:
      message - the message that should be deserialized.
      elementType - the type of the elements of the destination list.
      Returns:
      the deserialized list.
      Throws:
      DeserializationException - if the deserialization fails.

    • deserializeList

      default <T> List<T> deserializeList(byte[] message, MessageType elementType) throws DeserializationException
      Deserializes a message to a list of elements based on a MessageType.
      Type Parameters:
      T - the element type.
      Parameters:
      message - the message that should be deserialized.
      elementType - the type of the elements of the destination list.
      Returns:
      the deserialized list.
      Throws:
      DeserializationException - if the deserialization fails.