Module dk.cloudcreate.essentials.components.foundation
Package dk.cloudcreate.essentials.components.foundation.json

Interface JSONSerializer

All Known Implementing Classes:
JacksonJSONSerializer
public interface JSONSerializer
JSON serializer and deserializer

  • Method Summary

    Modifier and Type
    Method
    Description
    <T> T
    deserialize(byte[] json, Class<T> javaType)
    Deserialize the payload in the json parameter into the Java type specified by the javaType parameter
    <T> T
    deserialize(byte[] json, String javaType)
    Deserialize the payload in the json parameter into the Java type specified by the Fully Qualified Class Name contained in the javaType parameter
    <T> T
    deserialize(String json, Class<T> javaType)
    Deserialize the payload in the json parameter into the Java type specified by the javaType parameter
    <T> T
    deserialize(String json, String javaType)
    Deserialize the payload in the json parameter into the Java type specified by the Fully Qualified Class Name contained in the javaType parameter
    ClassLoader
    getClassLoader()
    Get the ClassLoader used for serializing to JSON and deserializing from JSON
    Note: MUST not be null
    String
    serialize(Object obj)
    Serialize the object to JSON
    byte[]
    serializeAsBytes(Object obj)
    Serialize the object to JSON
    void
    setClassLoader(ClassLoader classLoader)
    Set the ClassLoader used for serializing to JSON and deserializing from JSON.

  • Method Details

    • serialize

      String serialize(Object obj)
      Serialize the object to JSON
      Parameters:
      obj - the object to serialize
      Returns:
      the serialized json payload as a String
      Throws:
      JSONSerializationException - in case the json couldn't be deserialized to the specified java type

    • serializeAsBytes

      byte[] serializeAsBytes(Object obj)
      Serialize the object to JSON
      Parameters:
      obj - the object to serialize
      Returns:
      the serialized json payload as a byte[]
      Throws:
      JSONSerializationException - in case the json couldn't be deserialized to the specified java type

    • deserialize

      <T> T deserialize(String json, String javaType)
      Deserialize the payload in the json parameter into the Java type specified by the Fully Qualified Class Name contained in the javaType parameter
      Type Parameters:
      T - the corresponding Java type
      Parameters:
      json - the json payload
      javaType - the Fully Qualified Class Name for the Java type that the json payload should be deserialized into
      Returns:
      the deserialized json payload
      Throws:
      JSONDeserializationException - in case the json couldn't be deserialized to the specified java type

    • deserialize

      <T> T deserialize(String json, Class<T> javaType)
      Deserialize the payload in the json parameter into the Java type specified by the javaType parameter
      Type Parameters:
      T - the corresponding Java type
      Parameters:
      json - the json payload
      javaType - the Java type that the json payload should be deserialized into
      Returns:
      the deserialized json payload
      Throws:
      JSONDeserializationException - in case the json couldn't be deserialized to the specified java type

    • deserialize

      <T> T deserialize(byte[] json, String javaType)
      Deserialize the payload in the json parameter into the Java type specified by the Fully Qualified Class Name contained in the javaType parameter
      Type Parameters:
      T - the corresponding Java type
      Parameters:
      json - the json payload
      javaType - the Fully Qualified Class Name for the Java type that the json payload should be deserialized into
      Returns:
      the deserialized json payload
      Throws:
      JSONDeserializationException - in case the json couldn't be deserialized to the specified java type

    • deserialize

      <T> T deserialize(byte[] json, Class<T> javaType)
      Deserialize the payload in the json parameter into the Java type specified by the javaType parameter
      Type Parameters:
      T - the corresponding Java type
      Parameters:
      json - the json payload
      javaType - the Java type that the json payload should be deserialized into
      Returns:
      the deserialized json payload
      Throws:
      JSONDeserializationException - in case the json couldn't be deserialized to the specified java type

    • getClassLoader

      ClassLoader getClassLoader()
      Get the ClassLoader used for serializing to JSON and deserializing from JSON
      Note: MUST not be null
      Returns:
      the ClassLoader used for serializing to JSON and deserializing from JSON

    • setClassLoader

      void setClassLoader(ClassLoader classLoader)
      Set the ClassLoader used for serializing to JSON and deserializing from JSON. This is e.g. required to support SpringBoot DevTools
      Parameters:
      classLoader - the ClassLoader used for serializing to JSON and deserializing from JSON