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

Class DocumentElementHandler

java.lang.Object

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

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

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

All Implemented Interfaces:

DeserializationHandler

public class DocumentElementHandler
extends AbstractReentrantDeserializationHandler

Field Summary

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
DocumentElementHandler()

Method Summary

Modifier and Type	Method	Description
DeserializationHandler	clone()	Clones this handler.
void	endElement(DeserializationContext context)	Notifies the handler that their element has ended.
Decoder<?>	getBodyDecoder()	Called when body data is encountered in this tag or a sub-tag.
String	getElementName()	Returns the name of the element type that this handler ...
void	onBody(Object body)	Called when body data is encountered in this tag or a sub-tag.
void	startElement(String name, AttributesMap attributes, DeserializationContext context)	Notifies the handler that their element has started.
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.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

Constructor Details

DocumentElementHandler

public DocumentElementHandler()

Method Details

startElement

public void startElement(String name,
 AttributesMap attributes,
 DeserializationContext context)
                  throws Exception

Description copied from interface: DeserializationHandler

Notifies the handler that their element has started.

Throws:

Exception

endElement

public void endElement(DeserializationContext context)
                throws Exception

Description copied from interface: DeserializationHandler

Notifies the handler that their element has ended.

Throws:

Exception

onBody

public void onBody(Object body)

Description copied from interface: DeserializationHandler

Called when body data is encountered in this tag or a sub-tag. This data is first interpreted by the handler-provided decoder (see DeserializationHandler.getBodyDecoder()), and then this function will be called.

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)

getElementName

public String getElementName()

Description copied from interface: DeserializationHandler

Returns the name of the element type that this handler ... handles.

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.

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

Specified by:

clone in class AbstractDeserializationHandler