Package com.inductiveautomation.ignition.common.xmlserialization.deserialization.handlers

Class ByteArrayHandler

java.lang.Object

com.inductiveautomation.ignition.common.xmlserialization.deserialization.AbstractDeserializationHandler

com.inductiveautomation.ignition.common.xmlserialization.deserialization.AbstractReentrantDeserializationHandler

com.inductiveautomation.ignition.common.xmlserialization.deserialization.handlers.AbstractBodyDecoderHandler

com.inductiveautomation.ignition.common.xmlserialization.deserialization.handlers.ByteArrayHandler

All Implemented Interfaces:

DeserializationHandler

public class ByteArrayHandler
extends AbstractBodyDecoderHandler

Field Summary

Fields

Modifier and Type	Field	Description
static final Decoder<byte[]>	DECODER

Fields inherited from class com.inductiveautomation.ignition.common.xmlserialization.deserialization.handlers.AbstractBodyDecoderHandler

elementName

Fields inherited from class com.inductiveautomation.ignition.common.xmlserialization.deserialization.AbstractReentrantDeserializationHandler

objectTL, refTL

Fields inherited from class com.inductiveautomation.ignition.common.xmlserialization.deserialization.AbstractDeserializationHandler

object, refId

Constructor Summary

Constructors

Constructor	Description
ByteArrayHandler()

Method Summary

Modifier and Type	Method	Description
DeserializationHandler	clone()	Clones this handler.
Decoder<?>	getBodyDecoder()	Called when body data is encountered in this tag or a sub-tag.
boolean	supportsNestedElements()	Return true if the element type that you're parsing can have nested elements, or false if you're a singleton element.

Methods inherited from class com.inductiveautomation.ignition.common.xmlserialization.deserialization.handlers.AbstractBodyDecoderHandler

createNoBodyObject, endElement, getElementName, onBody, startElement

Methods inherited from class com.inductiveautomation.ignition.common.xmlserialization.deserialization.AbstractReentrantDeserializationHandler

getObject, getRefId, setObject, setRefId

Methods inherited from class com.inductiveautomation.ignition.common.xmlserialization.deserialization.AbstractDeserializationHandler

endObject, endSubElement, startSubElement

Methods inherited from class java.lang.Object

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

Field Details

DECODER

public static final Decoder<byte[]> DECODER

Constructor Details

ByteArrayHandler

public ByteArrayHandler()

Method Details

getBodyDecoder

public Decoder<?> getBodyDecoder()

Description copied from interface: DeserializationHandler

Called when body data is encountered in this tag or a sub-tag. Used to decode the body into an object, which is then passed to DeserializationHandler.onBody(Object)

supportsNestedElements

public boolean supportsNestedElements()

Description copied from interface: DeserializationHandler

Return true if the element type that you're parsing can have nested elements, or false if you're a singleton element. If you return true, you need to implement clone().

Note As of Ignition 7.6.5 with support for multi-deserialization, you should also return true from this and implement clone() if your return object is mutable, otherwise instances may be shared amongst multi-deserialized objects.

Specified by:

supportsNestedElements in interface DeserializationHandler

Overrides:

supportsNestedElements in class AbstractBodyDecoderHandler

clone

public DeserializationHandler clone()

Description copied from interface: DeserializationHandler

Clones this handler. Only handlers that support nested elements will be cloned, all others can throw an unsupported operation exception instead.

Specified by:

clone in interface DeserializationHandler

Overrides:

clone in class AbstractBodyDecoderHandler