Package com.inductiveautomation.ignition.common.xmlserialization.encoding

Interface AttributeEncoder

All Superinterfaces:
Encoder
All Known Implementing Classes:
Encoders, Encoders.BoolEncoder, Encoders.ByteEncoder, Encoders.ClassEncoder, Encoders.ColorEncoder, Encoders.DateEncoder, Encoders.DoubleEncoder, Encoders.FloatEncoder, Encoders.IntEncoder, Encoders.LongEncoder, Encoders.QualityCodeEncoder, Encoders.ShortEncoder, Encoders.SignatureEncoder, Encoders.StringEncoder, Encoders.UUIDEncoder
public interface AttributeEncoder extends Encoder

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getCodecType()
    Return the unique code for the type that this encoder encodes.

    Methods inherited from interface com.inductiveautomation.ignition.common.xmlserialization.encoding.Encoder

    getBinaryLength, objectToBinary, objectToString

  • Method Details

    • getCodecType

      int getCodecType()

      Return the unique code for the type that this encoder encodes. This must be the ordinal() of the corresponding CodecType enum value.

      This is only used on Encoders for element attributes, because attributes need to be read in with no intervention, so this ID is used to look up the correct decoder. For element bodies, the handler has the chance to instantiate the correct decoder before parsing, so no type code is needed.