Package com.inductiveautomation.ignition.gateway.config

Class JsonResourceCodecWrapper<R>

java.lang.Object

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

Type Parameters:

R - the resource config type

All Implemented Interfaces:

JsonResourceCodec<R>, ResourceCodec<R>

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

Basic wrapper around a JsonResourceCodec

Constructor Summary

Constructors

Constructor	Description
JsonResourceCodecWrapper(JsonResourceCodec<R> codec)	Create a new instance of JsonResourceCodecWrapper

Method Summary

Modifier and Type	Method	Description
R	decodeFromJson(com.inductiveautomation.ignition.common.gson.JsonElement json)	Similar to JsonResourceCodec.decode(Resource), but decodes the resource's config from a JSON element.
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 config)	Converts a resource config object instance to a JSON representation.
JsonResourceCodec<R>	unwrap()

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, decodeFromJson

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

decodeIfValid

Constructor Details

JsonResourceCodecWrapper

public JsonResourceCodecWrapper(JsonResourceCodec<R> codec)

Create a new instance of JsonResourceCodecWrapper

Parameters:

codec - the JsonResourceCodec instance to wrap

Throws:

NullPointerException - if the codec argument is null

Method Details

unwrap

public JsonResourceCodec<R> unwrap()

Returns:

the wrapped JsonResourceCodec. never null.

encodeToJson

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

Description copied from interface: JsonResourceCodec

Converts a resource config object instance to a JSON representation.

Specified by:

encodeToJson in interface JsonResourceCodec<R>

Parameters:

config - The resource to convert.

Returns:

A JSON representation of the resource.

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

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>