Package com.inductiveautomation.ignition.gateway.storeforward.serialization

Class DelegatingPersistentSerializer<T extends PersistentData,S extends com.google.protobuf.Message>

java.lang.Object

com.inductiveautomation.ignition.gateway.storeforward.serialization.DelegatingPersistentSerializer<T,S>

Type Parameters:

T - the type of persistent data

S - the type of proto message that relates to T

All Implemented Interfaces:

PersistentSerializer<T,S>

public class DelegatingPersistentSerializer<T extends PersistentData,S extends com.google.protobuf.Message>
extends Object
implements PersistentSerializer<T,S>

A delegating persistent serializer that uses a map of flavors to serialize and deserialize PersistentData

Constructor Summary

Constructors

Constructor	Description
DelegatingPersistentSerializer(Class<T> type, PersistentFlavor<? extends T>... flavors)	Constructs a delegating persistent serializer with the given type and flavors.

Method Summary

Modifier and Type	Method	Description
T	fromBytes(byte[] bytes, DeserializationContext context)	Deserializes the given byte array into a T PersistentData object.
T	fromJson(String json, DeserializationContext context)	Deserializes the given JSON string into a T PersistentData object.
T	fromJsonElement(com.inductiveautomation.ignition.common.gson.JsonElement jsonElement, DeserializationContext context)	Deserializes the given JsonElement into a T PersistentData object.
T	fromProtoMessage(S message, DeserializationContext context)	Deserializes the given Protobuf Message into a T PersistentData object.
Class<T>	getCompatibleClass()	The T PersistentData class that is compatible with this serializer.
byte[]	toBytes(T data, SerializationContext context)	Serializes the given T PersistentData into a byte array.
String	toJson(T data, SerializationContext context)	Serializes the given T PersistentData into a JSON string.
com.inductiveautomation.ignition.common.gson.JsonElement	toJsonElement(T data, SerializationContext context)	Serializes the given T PersistentData into a JsonElement.
S	toProtoMessage(T data, SerializationContext context)	Serializes the given T PersistentData into a Protobuf Message.

Methods inherited from class java.lang.Object

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

Constructor Details

DelegatingPersistentSerializer

@SafeVarargs
public DelegatingPersistentSerializer(Class<T> type,
 PersistentFlavor<? extends T>... flavors)

Constructs a delegating persistent serializer with the given type and flavors.

Parameters:

type - the type of persistent data to be serialized and deserialized

flavors - the flavors to use for serialization and deserialization

Method Details

toBytes

public byte[] toBytes(T data,
 @Nullable
 SerializationContext context)
               throws SerializeException

Description copied from interface: PersistentSerializer

Serializes the given T PersistentData into a byte array.

Specified by:

toBytes in interface PersistentSerializer<T extends PersistentData,S extends com.google.protobuf.Message>

Parameters:

data - The T PersistentData to serialize.

context - The serialization context to use for serialization.

Returns:

The serialized data as a byte array.

Throws:

SerializeException - If an error occurs during serialization.

toJson

public String toJson(T data,
 @Nullable
 SerializationContext context)
              throws SerializeException

Description copied from interface: PersistentSerializer

Serializes the given T PersistentData into a JSON string.

Specified by:

toJson in interface PersistentSerializer<T extends PersistentData,S extends com.google.protobuf.Message>

Parameters:

data - The T PersistentData to serialize.

context - The serialization context to use for serialization.

Returns:

The serialized data as a JSON string.

Throws:

SerializeException - If an error occurs during serialization.

toJsonElement

public com.inductiveautomation.ignition.common.gson.JsonElement toJsonElement(T data,
 @Nullable
 SerializationContext context)
                                                                       throws SerializeException

Description copied from interface: PersistentSerializer

Serializes the given T PersistentData into a JsonElement.

Specified by:

toJsonElement in interface PersistentSerializer<T extends PersistentData,S extends com.google.protobuf.Message>

Parameters:

data - The T PersistentData to serialize.

context - The serialization context to use for serialization.

Returns:

The serialized data as a JsonElement.

Throws:

SerializeException - If an error occurs during serialization.

toProtoMessage

public S toProtoMessage(T data,
 @Nullable
 SerializationContext context)
                 throws SerializeException

Description copied from interface: PersistentSerializer

Serializes the given T PersistentData into a Protobuf Message.

Specified by:

toProtoMessage in interface PersistentSerializer<T extends PersistentData,S extends com.google.protobuf.Message>

Parameters:

data - The T PersistentData to serialize.

context - The serialization context to use for serialization.

Returns:

The serialized data as an S Message.

Throws:

SerializeException - If an error occurs during serialization.

fromBytes

public T fromBytes(byte[] bytes,
 @Nullable
 DeserializationContext context)
            throws DeserializeException

Description copied from interface: PersistentSerializer

Deserializes the given byte array into a T PersistentData object.

Specified by:

fromBytes in interface PersistentSerializer<T extends PersistentData,S extends com.google.protobuf.Message>

Parameters:

bytes - The byte array to deserialize.

context - The deserialization context to use for deserialization.

Returns:

The deserialized persistent data object.

Throws:

DeserializeException - If an error occurs during deserialization.

fromJson

public T fromJson(String json,
 @Nullable
 DeserializationContext context)
           throws DeserializeException

Description copied from interface: PersistentSerializer

Deserializes the given JSON string into a T PersistentData object.

Specified by:

fromJson in interface PersistentSerializer<T extends PersistentData,S extends com.google.protobuf.Message>

Parameters:

json - The JSON string to deserialize.

context - The deserialization context to use for deserialization.

Returns:

The deserialized persistent data object.

Throws:

DeserializeException - If an error occurs during deserialization.

fromJsonElement

public T fromJsonElement(com.inductiveautomation.ignition.common.gson.JsonElement jsonElement,
 @Nullable
 DeserializationContext context)
                  throws DeserializeException

Description copied from interface: PersistentSerializer

Deserializes the given JsonElement into a T PersistentData object.

Specified by:

fromJsonElement in interface PersistentSerializer<T extends PersistentData,S extends com.google.protobuf.Message>

Parameters:

jsonElement - The JsonElement to deserialize.

context - The deserialization context to use for deserialization.

Returns:

The deserialized persistent data object.

Throws:

DeserializeException - If an error occurs during deserialization.

fromProtoMessage

public T fromProtoMessage(S message,
 @Nullable
 DeserializationContext context)
                   throws DeserializeException

Description copied from interface: PersistentSerializer

Deserializes the given Protobuf Message into a T PersistentData object.

Specified by:

fromProtoMessage in interface PersistentSerializer<T extends PersistentData,S extends com.google.protobuf.Message>

Parameters:

message - The S Protobuf Message to deserialize.

context - The deserialization context to use for deserialization.

Returns:

The deserialized persistent data object.

Throws:

DeserializeException - If an error occurs during deserialization.

getCompatibleClass

@Nonnull
public Class<T> getCompatibleClass()

Description copied from interface: PersistentSerializer

The T PersistentData class that is compatible with this serializer.

Specified by:

getCompatibleClass in interface PersistentSerializer<T extends PersistentData,S extends com.google.protobuf.Message>

Returns:

The T PersistentData class.