Package com.inductiveautomation.eventstream.gateway.encoding

Class StringEncoder

java.lang.Object

com.inductiveautomation.eventstream.gateway.encoding.StringEncoder

All Implemented Interfaces:

EventStreamEncoder

public class StringEncoder
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 EncoderFactory	FACTORY

Constructor Summary

Constructors

Constructor	Description
StringEncoder(@Nullable String encoding)

Method Summary

Modifier and Type	Method	Description
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

Constructor Details

StringEncoder

public StringEncoder(@Nullable
 @Nullable String encoding)

Method Details

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.