Package com.inductiveautomation.ignition.gateway.history

Class AnnotationPersistentData.Serializer

java.lang.Object

com.inductiveautomation.ignition.gateway.history.AnnotationPersistentData.Serializer

All Implemented Interfaces:

PersistentSerializer<AnnotationPersistentData,HistoryDataProto.AnnotationsPB>

Enclosing class:

AnnotationPersistentData

public static class AnnotationPersistentData.Serializer
extends Object
implements PersistentSerializer<AnnotationPersistentData,HistoryDataProto.AnnotationsPB>

Constructor Summary

Constructors

Constructor	Description
Serializer()

Method Summary

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

Serializer

public Serializer()

Method Details

toBytes

public byte[] toBytes(AnnotationPersistentData data,
 @Nullable
 SerializationContext context)

Description copied from interface: PersistentSerializer

Serializes the given T PersistentData into a byte array.

Specified by:

toBytes in interface PersistentSerializer<AnnotationPersistentData,HistoryDataProto.AnnotationsPB>

Parameters:

data - The T PersistentData to serialize.

context - The serialization context to use for serialization.

Returns:

The serialized data as a byte array.

toJson

public String toJson(AnnotationPersistentData 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<AnnotationPersistentData,HistoryDataProto.AnnotationsPB>

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(AnnotationPersistentData 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<AnnotationPersistentData,HistoryDataProto.AnnotationsPB>

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 HistoryDataProto.AnnotationsPB toProtoMessage(AnnotationPersistentData data,
 @Nullable
 SerializationContext context)

Description copied from interface: PersistentSerializer

Serializes the given T PersistentData into a Protobuf Message.

Specified by:

toProtoMessage in interface PersistentSerializer<AnnotationPersistentData,HistoryDataProto.AnnotationsPB>

Parameters:

data - The T PersistentData to serialize.

context - The serialization context to use for serialization.

Returns:

The serialized data as an S Message.

fromBytes

public AnnotationPersistentData 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<AnnotationPersistentData,HistoryDataProto.AnnotationsPB>

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 AnnotationPersistentData 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<AnnotationPersistentData,HistoryDataProto.AnnotationsPB>

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 AnnotationPersistentData 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<AnnotationPersistentData,HistoryDataProto.AnnotationsPB>

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 AnnotationPersistentData fromProtoMessage(HistoryDataProto.AnnotationsPB message,
 @Nullable
 DeserializationContext context)

Description copied from interface: PersistentSerializer

Deserializes the given Protobuf Message into a T PersistentData object.

Specified by:

fromProtoMessage in interface PersistentSerializer<AnnotationPersistentData,HistoryDataProto.AnnotationsPB>

Parameters:

message - The S Protobuf Message to deserialize.

context - The deserialization context to use for deserialization.

Returns:

The deserialized persistent data object.

getCompatibleClass

@Nonnull
public Class<AnnotationPersistentData> getCompatibleClass()

Description copied from interface: PersistentSerializer

The T PersistentData class that is compatible with this serializer.

Specified by:

getCompatibleClass in interface PersistentSerializer<AnnotationPersistentData,HistoryDataProto.AnnotationsPB>

Returns:

The T PersistentData class.