Package com.inductiveautomation.eventstream.gateway.encoding

Class JsonObjectEncoder

java.lang.Object

com.inductiveautomation.eventstream.gateway.encoding.JsonObjectEncoder

All Implemented Interfaces:

EventStreamEncoder

public class JsonObjectEncoder
extends Object
implements EventStreamEncoder

Nested Class Summary

Nested classes/interfaces inherited from interface com.inductiveautomation.eventstream.encoder.EventStreamEncoder

EventStreamEncoder.Config, EventStreamEncoder.Descriptor

Field Summary

Fields

Modifier and Type	Field	Description
static final EventStreamEncoder	DEFAULT
static final EncoderFactory	FACTORY

Constructor Summary

Constructors

Constructor	Description
JsonObjectEncoder(String encoding)

Method Summary

Modifier and Type	Method	Description
static EventStreamEncoder.Config	config(String encoding)
Object	encode(Object data)	Converts data to another type defined by the EventStreamEncoder.

Methods inherited from class java.lang.Object

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

Field Details

FACTORY

public static final EncoderFactory FACTORY

DEFAULT

public static final EventStreamEncoder DEFAULT

Constructor Details

JsonObjectEncoder

public JsonObjectEncoder(@Nullable
 String encoding)

Method Details

config

public static EventStreamEncoder.Config config(@Nullable
 String encoding)

encode

public Object encode(Object data)
              throws EncoderException

Description copied from interface: EventStreamEncoder

Converts data to another type defined by the EventStreamEncoder. Supported input types should always include the PyObject equivalent where possible, since Filter and Transforms will generally be outputting PyObjects.

Specified by:

encode in interface EventStreamEncoder

Parameters:

data - Data to encode.

Returns:

Encoded data

Throws:

EncoderException - when it's not possible to encode data to the EventStreamEncoder type.