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

Class Encoder

java.lang.Object

com.inductiveautomation.ignition.common.resourcecollection.json.Encoder

Direct Known Subclasses:

ConfigModeEncoder, ProjectEncoder

public abstract class Encoder
extends Object

Encodes and decodes project and resource collection objects to and from JSON. Use the concrete subclasses to choose which encoding strategy to use: "project" based or "resource collection" based.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Encoder(String collectionManifestFilename)

Method Summary

Modifier and Type	Method	Description
com.inductiveautomation.ignition.common.gson.GsonBuilder	configure(com.inductiveautomation.ignition.common.gson.GsonBuilder builder)	Adds type adapters for ImmutableResource, LastModification, ResourceSignature, and byte[].
String	getCollectionManifestFilename()
com.inductiveautomation.ignition.common.gson.Gson	getGson()
LastModification	lastModificationFromGson(com.inductiveautomation.ignition.common.gson.JsonElement json)
LastModification	lastModificationFromJson(String json)
com.inductiveautomation.ignition.common.gson.JsonElement	lastModificationToGson(LastModification lastModification)
RuntimeResourceCollection	resourceCollectionFromJson(InputStream stream)
RuntimeResourceCollection	resourceCollectionFromJson(Reader reader)
RuntimeResourceCollection	resourceCollectionFromJson(String json)
ResourceCollectionManifest	resourceCollectionManifestFromJson(Reader reader)
ResourceCollectionManifest	resourceCollectionManifestFromJson(String json)
String	resourceCollectionManifestToJson(ResourceCollectionManifest manifest)
void	resourceCollectionManifestToStream(ResourceCollectionManifest manifest, OutputStream stream)	Writes the manifest as JSON to the given output stream in UTF_8 encoding .
String	resourceCollectionToJson(RuntimeResourceCollection project)
void	resourceCollectionToStream(RuntimeResourceCollection project, OutputStream stream)	Writes the project as JSON to the given output stream in UTF_8 encoding .
ResourceManifest	resourceManifestFromJson(Reader reader)
ResourceManifest	resourceManifestFromJson(String json)
com.inductiveautomation.ignition.common.gson.JsonElement	resourceManifestToGson(ResourceManifest manifest)
String	resourceManifestToJson(ResourceManifest manifest)
void	resourceManifestToStream(ResourceManifest manifest, OutputStream stream)

Methods inherited from class java.lang.Object

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

Constructor Details

Encoder

protected Encoder(String collectionManifestFilename)

Method Details

configure

public com.inductiveautomation.ignition.common.gson.GsonBuilder configure(com.inductiveautomation.ignition.common.gson.GsonBuilder builder)

Adds type adapters for ImmutableResource, LastModification, ResourceSignature, and byte[].

getGson

public com.inductiveautomation.ignition.common.gson.Gson getGson()

getCollectionManifestFilename

public String getCollectionManifestFilename()

resourceCollectionFromJson

public RuntimeResourceCollection resourceCollectionFromJson(String json)

resourceCollectionFromJson

public RuntimeResourceCollection resourceCollectionFromJson(InputStream stream)

resourceCollectionFromJson

public RuntimeResourceCollection resourceCollectionFromJson(Reader reader)

resourceCollectionToJson

public String resourceCollectionToJson(RuntimeResourceCollection project)

resourceCollectionManifestFromJson

public ResourceCollectionManifest resourceCollectionManifestFromJson(String json)

resourceCollectionManifestFromJson

public ResourceCollectionManifest resourceCollectionManifestFromJson(Reader reader)

resourceCollectionManifestToJson

public String resourceCollectionManifestToJson(ResourceCollectionManifest manifest)

resourceManifestFromJson

public ResourceManifest resourceManifestFromJson(String json)

resourceManifestFromJson

public ResourceManifest resourceManifestFromJson(Reader reader)

resourceManifestToJson

public String resourceManifestToJson(ResourceManifest manifest)

resourceManifestToGson

public com.inductiveautomation.ignition.common.gson.JsonElement resourceManifestToGson(ResourceManifest manifest)

lastModificationFromJson

public LastModification lastModificationFromJson(String json)

lastModificationFromGson

public LastModification lastModificationFromGson(com.inductiveautomation.ignition.common.gson.JsonElement json)

lastModificationToGson

public com.inductiveautomation.ignition.common.gson.JsonElement lastModificationToGson(LastModification lastModification)

resourceCollectionManifestToStream

public void resourceCollectionManifestToStream(ResourceCollectionManifest manifest,
 OutputStream stream)
                                        throws IOException

Writes the manifest as JSON to the given output stream in UTF_8 encoding . Does not close the stream.

Throws:

IOException

resourceCollectionToStream

public void resourceCollectionToStream(RuntimeResourceCollection project,
 OutputStream stream)
                                throws IOException

Writes the project as JSON to the given output stream in UTF_8 encoding . Does not close the stream.

Throws:

IOException

resourceManifestToStream

public void resourceManifestToStream(ResourceManifest manifest,
 OutputStream stream)
                              throws IOException

Throws:

IOException