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

Interface SerializationContext

public interface SerializationContext

Context for serialization used when serializing data with a PersistentSerializer.

Method Summary

Modifier and Type	Method	Description
default byte[]	toBytes(PersistentData data)	Serializes the given PersistentData object to a byte array.
default String	toJson(PersistentData data)	Serializes the given PersistentData object to a JSON string.
default com.inductiveautomation.ignition.common.gson.JsonElement	toJsonElement(PersistentData data)	Serializes the given PersistentData object to a JsonElement.
default com.google.protobuf.Message	toProtoMessage(PersistentData data)	Serializes the given PersistentData object to a Protobuf Message.

Method Details

toBytes

default byte[] toBytes(PersistentData data)
                throws SerializeException

Serializes the given PersistentData object to a byte array.

Parameters:

data - the PersistentData object to serialize

Returns:

the serialized bytes

Throws:

SerializeException - if there is an error during serialization

toJson

default String toJson(PersistentData data)
               throws SerializeException

Serializes the given PersistentData object to a JSON string.

Parameters:

data - the PersistentData object to serialize

Returns:

the serialized JSON string

Throws:

SerializeException - if there is an error during serialization

toJsonElement

default com.inductiveautomation.ignition.common.gson.JsonElement toJsonElement(PersistentData data)
                                                                        throws SerializeException

Serializes the given PersistentData object to a JsonElement.

Parameters:

data - the PersistentData object to serialize

Returns:

the serialized JsonElement

Throws:

SerializeException - if there is an error during serialization

toProtoMessage

default com.google.protobuf.Message toProtoMessage(PersistentData data)
                                            throws SerializeException

Serializes the given PersistentData object to a Protobuf Message.

Parameters:

data - the PersistentData object to serialize

Returns:

the serialized Protobuf Message

Throws:

SerializeException - if there is an error during serialization