Package com.inductiveautomation.eventstream.gateway.encoding

Class ByteArrayEncoder

java.lang.Object

com.inductiveautomation.eventstream.gateway.encoding.ByteArrayEncoder

All Implemented Interfaces:

EventStreamEncoder

public class ByteArrayEncoder
extends Object
implements EventStreamEncoder

Encodes an Object to byte[]. Encoders are used during GatewayEventStreamExpression evaluation, so ByteArrayEncoder must be as complete as possible. Byte[] is a common encoding for Handlers to transmit data.

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 String	BASE_64_ENCODING
static final EncoderFactory	FACTORY

Constructor Summary

Constructors

Constructor	Description
ByteArrayEncoder(@Nullable String encoding)

Method Summary

Modifier and Type	Method	Description
static com.inductiveautomation.ignition.common.gson.JsonObject	config(String encoding)
static EventStreamEncoder.Config	createConfig(@Nullable 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

BASE_64_ENCODING

public static final String BASE_64_ENCODING

See Also:

• Constant Field Values

Constructor Details

ByteArrayEncoder

public ByteArrayEncoder(@Nullable
 @Nullable String encoding)

Method Details

config

public static com.inductiveautomation.ignition.common.gson.JsonObject config(String encoding)

createConfig

public static EventStreamEncoder.Config createConfig(@Nullable
 @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.