Package com.inductiveautomation.ignition.common.resourcecollection.json

Class ResourceIdSerializer

java.lang.Object

com.inductiveautomation.ignition.common.resourcecollection.json.ResourceIdSerializer

All Implemented Interfaces:

com.inductiveautomation.ignition.common.gson.JsonDeserializer<ResourceId>, com.inductiveautomation.ignition.common.gson.JsonSerializer<ResourceId>

public class ResourceIdSerializer
extends Object
implements com.inductiveautomation.ignition.common.gson.JsonSerializer<ResourceId>, com.inductiveautomation.ignition.common.gson.JsonDeserializer<ResourceId>

Serializes/Deserializes a ResourceId from a JSON element. Example

 {
     ["collection" | "project"]: "myProjectOrModeName",
     "module": "com.example.mymodule",
     "type": "my-resource-type-id",
     "path": "my/resource/path"
 }
 

Method Summary

Modifier and Type	Method	Description
ResourceId	deserialize(com.inductiveautomation.ignition.common.gson.JsonElement e, Type reflectiveType, com.inductiveautomation.ignition.common.gson.JsonDeserializationContext context)
static ResourceIdSerializer	forCollection()
static ResourceIdSerializer	forProject()
com.inductiveautomation.ignition.common.gson.JsonElement	serialize(ResourceId id, Type type, com.inductiveautomation.ignition.common.gson.JsonSerializationContext context)

Methods inherited from class java.lang.Object

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

Method Details

forCollection

public static ResourceIdSerializer forCollection()

Returns:

A ResourceIdSerializer that serializes the resource collection name as "collection".

forProject

public static ResourceIdSerializer forProject()

Returns:

A ResourceIdSerializer that serializes the resource collection name as "project".

deserialize

public ResourceId deserialize(com.inductiveautomation.ignition.common.gson.JsonElement e,
 Type reflectiveType,
 com.inductiveautomation.ignition.common.gson.JsonDeserializationContext context)
                       throws com.inductiveautomation.ignition.common.gson.JsonParseException

Specified by:

deserialize in interface com.inductiveautomation.ignition.common.gson.JsonDeserializer<ResourceId>

Throws:

com.inductiveautomation.ignition.common.gson.JsonParseException

serialize

public com.inductiveautomation.ignition.common.gson.JsonElement serialize(ResourceId id,
 Type type,
 com.inductiveautomation.ignition.common.gson.JsonSerializationContext context)

Specified by:

serialize in interface com.inductiveautomation.ignition.common.gson.JsonSerializer<ResourceId>