Class AbstractDeserializationHandler
- java.lang.Object
-
- com.inductiveautomation.ignition.common.xmlserialization.deserialization.AbstractDeserializationHandler
-
- All Implemented Interfaces:
DeserializationHandler
- Direct Known Subclasses:
AbstractReentrantDeserializationHandler
,ArrayHandler
,ArrayListHandler
,EnumSetHandler
,ObjectDeserializationHandler
public abstract class AbstractDeserializationHandler extends java.lang.Object implements DeserializationHandler
-
-
Constructor Summary
Constructors Constructor Description AbstractDeserializationHandler()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract DeserializationHandler
clone()
Clones this handler.void
endObject(java.lang.Object obj)
Notifies the handler that an object tag was found and deserialized within their scopevoid
endSubElement(java.lang.String name, DeserializationContext context)
Notifies the handler that a sub-element has endedjava.lang.Object
getObject()
Returns the most recent object that this handler created.int
getRefId()
Returns the reference id that was in the start of this element, or -1 if there was noneprotected void
setObject(java.lang.Object object)
void
setRefId(int id)
Sets the ref-id that was found at the start of this element, if any.void
startSubElement(java.lang.String name, AttributesMap attributes, DeserializationContext context)
Notifies the handler that a sub-element has started.-
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
endElement, getBodyDecoder, getElementName, onBody, startElement, supportsNestedElements
-
-
-
-
Method Detail
-
startSubElement
public void startSubElement(java.lang.String name, AttributesMap attributes, DeserializationContext context) throws java.lang.Exception
Description copied from interface:DeserializationHandler
Notifies the handler that a sub-element has started.- Specified by:
startSubElement
in interfaceDeserializationHandler
- Throws:
java.lang.Exception
-
endSubElement
public void endSubElement(java.lang.String name, DeserializationContext context) throws java.lang.Exception
Description copied from interface:DeserializationHandler
Notifies the handler that a sub-element has ended- Specified by:
endSubElement
in interfaceDeserializationHandler
- Throws:
java.lang.Exception
-
endObject
public void endObject(java.lang.Object obj)
Description copied from interface:DeserializationHandler
Notifies the handler that an object tag was found and deserialized within their scope- Specified by:
endObject
in interfaceDeserializationHandler
-
getObject
public java.lang.Object getObject()
Description copied from interface:DeserializationHandler
Returns the most recent object that this handler created. Note that a handler needs to have this function return its object as early as possible, not just after endElement() has been called. This is used for populating the reference map.- Specified by:
getObject
in interfaceDeserializationHandler
-
setObject
protected void setObject(java.lang.Object object)
-
clone
public abstract 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 interfaceDeserializationHandler
- Overrides:
clone
in classjava.lang.Object
-
getRefId
public int getRefId()
Description copied from interface:DeserializationHandler
Returns the reference id that was in the start of this element, or -1 if there was none- Specified by:
getRefId
in interfaceDeserializationHandler
-
setRefId
public void setRefId(int id)
Description copied from interface:DeserializationHandler
Sets the ref-id that was found at the start of this element, if any.- Specified by:
setRefId
in interfaceDeserializationHandler
-
-