Package com.inductiveautomation.ignition.common.xmlserialization.serialization

Class XMLSerializationContext

java.lang.Object

com.inductiveautomation.ignition.common.xmlserialization.serialization.XMLSerializationContext

public class XMLSerializationContext
extends Object

Used while serializing to keep track of references and indentation.

Field Summary

Fields

Modifier and Type	Field	Description
protected XMLSerializer	serializer

Constructor Summary

Constructors

Constructor	Description
XMLSerializationContext(XMLSerializer serializer)

Method Summary

Modifier and Type	Method	Description
ClassNameResolver	getClassNameMap()
Object	getCleanCopy(Class type)
int	getRefForElement(Element elm)	Looks up the reference ID for the object within the Element, as long as the element doesn't have reference tracking turned off.
void	registerEqualityDelegate(Class<?> clazz, EqualityDelegate<?> delegate)	Registers additional EqualityDelegates not already defined in the defaults for this class.
boolean	safeEquals(Object foo, Object bar)
Element	serialize(Object obj)	Uses the SerializationDelegate registered for this type of object to serialize the object into an Element.

Methods inherited from class java.lang.Object

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

Field Details

serializer

protected XMLSerializer serializer

Constructor Details

XMLSerializationContext

public XMLSerializationContext(XMLSerializer serializer)

Method Details

serialize

public Element serialize(Object obj)
                  throws SerializationException

Uses the SerializationDelegate registered for this type of object to serialize the object into an Element. If the delegate is flagged for reference tracking and this object is equal to one already serialized earlier, a <ref> object will be returned instead.

Throws:

SerializationException

getRefForElement

public int getRefForElement(Element elm)

Looks up the reference ID for the object within the Element, as long as the element doesn't have reference tracking turned off.

getCleanCopy

public Object getCleanCopy(Class type)
                    throws SerializationException

Throws:

SerializationException

getClassNameMap

public ClassNameResolver getClassNameMap()

safeEquals

public boolean safeEquals(Object foo,
 Object bar)

registerEqualityDelegate

public void registerEqualityDelegate(Class<?> clazz,
 EqualityDelegate<?> delegate)

Registers additional EqualityDelegates not already defined in the defaults for this class.