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

Class AbstractBodyDecoderHandler

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

All Implemented Interfaces:

DeserializationHandler

Direct Known Subclasses:

BitSetHandler, ByteArrayHandler, ClassHandler, ColorHandler, ColorStateHandler, CursorHandler, DateHandler, DimensionHandler, Ellipse2DDoubleHandler, Ellipse2DFloatHandler, FontHandler, GeneralPathHandler, InsetsHandler, LayoutConstraintsHandler, MethodHandler, NumberHandler, Point2DDoubleHandler, Point2DFloatHandler, PointHandler, PrimitiveArrayHandler, QualityCodeHandler, Rectangle2DDoubleHandler, Rectangle2DFloatHandler, RectangleHandler, RoundRectangle2DDoubleHandler, RoundRectangle2DFloatHandler, StringHandler, UUIDHandler

public abstract class AbstractBodyDecoderHandler
extends AbstractReentrantDeserializationHandler

Field Summary

Fields

Modifier and Type	Field	Description
protected java.lang.String	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

Modifier	Constructor	Description
protected	AbstractBodyDecoderHandler(java.lang.String elementName)

Method Summary

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

Methods inherited from interface com.inductiveautomation.ignition.common.xmlserialization.deserialization.DeserializationHandler

getBodyDecoder

Field Detail

elementName

protected final java.lang.String elementName

Constructor Detail

AbstractBodyDecoderHandler

protected AbstractBodyDecoderHandler(java.lang.String elementName)

Method Detail

startElement

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

Description copied from interface: DeserializationHandler

Notifies the handler that their element has started.

Throws:

java.lang.Exception

endElement

public void endElement(DeserializationContext context)
                throws java.lang.Exception

Description copied from interface: DeserializationHandler

Notifies the handler that their element has ended.

Throws:

java.lang.Exception

onBody

public void onBody(java.lang.Object bodyObject)

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.

createNoBodyObject

protected java.lang.Object createNoBodyObject()

getElementName

public java.lang.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