Package com.inductiveautomation.eventstream.encoder

Interface EventStreamEncoder

All Known Implementing Classes:

ByteArrayEncoder, JsonObjectEncoder, PassThroughEncoder, PyDictionaryEncoder, SparkplugBEncoder, StringEncoder

public interface EventStreamEncoder

Converts between data types.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final record	EventStreamEncoder.Config
static final record	EventStreamEncoder.Descriptor

Method Summary

Modifier and Type	Method	Description
Object	encode(Object data)	Converts data to another type defined by the EventStreamEncoder.

Method Details

encode

Object encode(Object data)
       throws EncoderException

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.

Parameters:

data - Data to encode.

Returns:

Encoded data

Throws:

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