Package com.inductiveautomation.ignition.gateway.config

Class GsonResourceCodec<R>

java.lang.Object

com.inductiveautomation.ignition.gateway.config.GsonResourceCodec<R>

All Implemented Interfaces:

JsonResourceCodec<R>, ResourceCodec<R>

public class GsonResourceCodec<R>
extends Object
implements JsonResourceCodec<R>

A ResourceCodec that uses a Gson instance to directly encode and decode resources.

Field Summary

Fields

Modifier and Type	Field	Description
protected final com.inductiveautomation.ignition.common.gson.Gson	gson
protected final Class<R>	recordType
protected final ResourceValidator<R>	validator

Constructor Summary

Constructors

Constructor	Description
GsonResourceCodec(Class<R> recordType, com.inductiveautomation.ignition.common.gson.Gson gson)
GsonResourceCodec(Class<R> recordType, com.inductiveautomation.ignition.common.gson.Gson gson, ResourceValidator<R> validator)

Method Summary

Modifier and Type	Method	Description
static <R> GsonResourceCodec<R>	create(Class<R> recordType, Consumer<com.inductiveautomation.ignition.common.gson.GsonBuilder> gsonBuilderCustomizer)
R	decodeFromJson(com.inductiveautomation.ignition.common.gson.JsonElement json)	Similar to JsonResourceCodec.decode(Resource), but decodes the resource's config from a JSON element.
R	decodeFromJson(Reader reader)	Similar to JsonResourceCodec.decode(Resource), but reads the resource's config from a reader which will contain the JSON data of the encoded config object.
void	encode(R config, ResourceBuilder builder)	Encodes a resource's config object, and stores it in the resource in the appropriate location.
com.inductiveautomation.ignition.common.gson.JsonElement	encodeToJson(R resource)	Converts a resource config object instance to a JSON representation.
protected R	validate(R resource)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.inductiveautomation.ignition.gateway.config.JsonResourceCodec

decode

Methods inherited from interface com.inductiveautomation.ignition.gateway.config.ResourceCodec

decodeIfValid

Field Details

recordType

protected final Class<R> recordType

gson

protected final com.inductiveautomation.ignition.common.gson.Gson gson

validator

@Nullable
protected final ResourceValidator<R> validator

Constructor Details

GsonResourceCodec

public GsonResourceCodec(Class<R> recordType,
 com.inductiveautomation.ignition.common.gson.Gson gson)

GsonResourceCodec

public GsonResourceCodec(Class<R> recordType,
 com.inductiveautomation.ignition.common.gson.Gson gson,
 @Nullable
 ResourceValidator<R> validator)

Method Details

encode

public void encode(R config,
 ResourceBuilder builder)

Description copied from interface: ResourceCodec

Encodes a resource's config object, and stores it in the resource in the appropriate location.

Specified by:

encode in interface ResourceCodec<R>

encodeToJson

public com.inductiveautomation.ignition.common.gson.JsonElement encodeToJson(R resource)

Description copied from interface: JsonResourceCodec

Converts a resource config object instance to a JSON representation.

Specified by:

encodeToJson in interface JsonResourceCodec<R>

Parameters:

resource - The resource to convert.

Returns:

A JSON representation of the resource.

decodeFromJson

public R decodeFromJson(Reader reader)
                 throws DecodingException

Description copied from interface: JsonResourceCodec

Similar to JsonResourceCodec.decode(Resource), but reads the resource's config from a reader which will contain the JSON data of the encoded config object.

Specified by:

decodeFromJson in interface JsonResourceCodec<R>

Throws:

DecodingException

decodeFromJson

public R decodeFromJson(com.inductiveautomation.ignition.common.gson.JsonElement json)
                 throws DecodingException

Description copied from interface: JsonResourceCodec

Similar to JsonResourceCodec.decode(Resource), but decodes the resource's config from a JSON element.

Specified by:

decodeFromJson in interface JsonResourceCodec<R>

Throws:

DecodingException

validate

protected R validate(R resource)
              throws ValidationException

Throws:

ValidationException

create

public static <R> GsonResourceCodec<R> create(Class<R> recordType,
 @Nullable
 Consumer<com.inductiveautomation.ignition.common.gson.GsonBuilder> gsonBuilderCustomizer)