Class EnumHandler
- java.lang.Object
 - 
- com.inductiveautomation.ignition.common.xmlserialization.deserialization.AbstractDeserializationHandler
 - 
- com.inductiveautomation.ignition.common.xmlserialization.deserialization.AbstractReentrantDeserializationHandler
 - 
- com.inductiveautomation.ignition.common.xmlserialization.deserialization.handlers.EnumHandler
 
 
 
 
- 
- All Implemented Interfaces:
 DeserializationHandler
- Direct Known Subclasses:
 TagQualityHandler
public class EnumHandler 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 EnumHandler() 
- 
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DeserializationHandlerclone()Clones this handler.voidendElement(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.java.lang.StringgetElementName()Returns the name of the element type that this handler ...voidonBody(java.lang.Object body)Called when body data is encountered in this tag or a sub-tag.voidstartElement(java.lang.String name, AttributesMap attributes, DeserializationContext context)Notifies the handler that their element has started.booleansupportsNestedElements()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 
 - 
 
 - 
 
- 
- 
Method Detail
- 
onBody
public void onBody(java.lang.Object body)
Description copied from interface:DeserializationHandlerCalled when body data is encountered in this tag or a sub-tag. This data is first interpreted by the handler-provided decoder (seeDeserializationHandler.getBodyDecoder()), and then this function will be called. 
- 
getBodyDecoder
public Decoder<?> getBodyDecoder()
Description copied from interface:DeserializationHandlerCalled when body data is encountered in this tag or a sub-tag. Used to decode the body into an object, which is then passed toDeserializationHandler.onBody(Object) 
- 
endElement
public void endElement(DeserializationContext context) throws java.lang.Exception
Description copied from interface:DeserializationHandlerNotifies the handler that their element has ended.- Throws:
 java.lang.Exception
 
- 
getElementName
public java.lang.String getElementName()
Description copied from interface:DeserializationHandlerReturns the name of the element type that this handler ... handles. 
- 
startElement
public void startElement(java.lang.String name, AttributesMap attributes, DeserializationContext context) throws java.lang.ExceptionDescription copied from interface:DeserializationHandlerNotifies the handler that their element has started.- Throws:
 java.lang.Exception
 
- 
supportsNestedElements
public boolean supportsNestedElements()
Description copied from interface:DeserializationHandlerReturn 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:DeserializationHandlerClones this handler. Only handlers that support nested elements will be cloned, all others can throw an unsupported operation exception instead.- Specified by:
 clonein interfaceDeserializationHandler- Specified by:
 clonein classAbstractDeserializationHandler
 
 - 
 
 -