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

Class XMLSerializer

java.lang.Object

com.inductiveautomation.ignition.common.xmlserialization.serialization.XMLSerializer

public class XMLSerializer
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_ENCODING

Constructor Summary

Constructors

Constructor	Description
XMLSerializer()

Method Summary

Modifier and Type	Method	Description
void	addObject(Object obj)	Add another object to serialize
void	addRootAttribute(String key, String value)	Merges the given attribute for the root element into the existing attributes (if any).
void	addSerializationDelegate(Class clazz, SerializationDelegate<?> delegate)
void	addSupertypeDelegate(Class clazz, SerializationDelegate<?> delegate)
protected Element	createTopElement(List<Element> elements)
ClassNameResolver	getClassNameMap()
XMLSerializer	initDefaults()	Calls getClassNameMap().addDefaults() in a chaining invocation style.
void	registerEqualityDelegate(Class<?> clazz, EqualityDelegate<?> delegate)
String	serialize()	Deprecated. Use serializeXML() instead.
void	serialize(SerializationWriter writer)	Serializes the object graph to the given serialization writer.
void	serialize(OutputStream out)	Deprecated. use serializeXML(OutputStream, String) instead.
void	serialize(OutputStream out, String encoding)	Deprecated. use serializeXML(OutputStream, String) instead.
void	serialize(Writer out)	Deprecated. use serializeXML(Writer, String) instead.
void	serialize(Writer out, String encoding)	Deprecated. use serializeXML(Writer, String) instead.
byte[]	serializeAndGZip()	Deprecated. use serializeXMLAndGZip() instead.
byte[]	serializeAndGZip(Object obj)	Deprecated. use serializeXMLAndGZip(Object) instead.
byte[]	serializeBinary(boolean gzip)	Serialize using the binary format.
void	serializeBinary(OutputStream stream)	Serializes the added object(s) to the stream, and closes the stream.
byte[]	serializeBinary(Object object, boolean gzip)	Serialize the given object using binary format.
String	serializeXML()	Serialize to non-compressed XML using the default encoding (UTF-8)
void	serializeXML(OutputStream out, String encoding)	Serialize to XML format using the specified encoding.
void	serializeXML(Writer out, String encoding)	Serialize to XML format using the specified encoding.
byte[]	serializeXMLAndGZip()	Serializes and gzips using UTF-8 encoding
byte[]	serializeXMLAndGZip(Object obj)	Convenience shortcut for:
static void	setCleanCopy(Class type, Object obj)

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_ENCODING

public static final String DEFAULT_ENCODING

Constructor Details

XMLSerializer

public XMLSerializer()

Method Details

initDefaults

public XMLSerializer initDefaults()

Calls getClassNameMap().addDefaults() in a chaining invocation style.

addRootAttribute

public void addRootAttribute(String key,
 String value)

Merges the given attribute for the root element into the existing attributes (if any). These attributes can be read on the deserialization side without needing to deserialize the entire structure.

addSerializationDelegate

public void addSerializationDelegate(Class clazz,
 SerializationDelegate<?> delegate)

addSupertypeDelegate

public void addSupertypeDelegate(Class clazz,
 SerializationDelegate<?> delegate)

addObject

public void addObject(Object obj)

Add another object to serialize

serializeAndGZip

@Deprecated
public byte[] serializeAndGZip(Object obj)
                        throws SerializationException

Deprecated.

use serializeXMLAndGZip(Object) instead.

Throws:

SerializationException

serializeAndGZip

@Deprecated
public byte[] serializeAndGZip()
                        throws SerializationException

Deprecated.

use serializeXMLAndGZip() instead.

Throws:

SerializationException

serializeXMLAndGZip

public byte[] serializeXMLAndGZip(Object obj)
                           throws SerializationException

Convenience shortcut for:

 serializer.addObject(obj);
 return serializer.serializeXMLAndGZip();
 

Throws:

SerializationException

serializeXMLAndGZip

public byte[] serializeXMLAndGZip()
                           throws SerializationException

Serializes and gzips using UTF-8 encoding

Throws:

SerializationException

serialize

@Deprecated
public String serialize()
                 throws SerializationException

Deprecated.

Use serializeXML() instead.

Throws:

SerializationException

serialize

@Deprecated
public void serialize(OutputStream out)
               throws SerializationException

Deprecated.

use serializeXML(OutputStream, String) instead.

Throws:

SerializationException

serialize

@Deprecated
public void serialize(OutputStream out,
 String encoding)
               throws SerializationException

Deprecated.

use serializeXML(OutputStream, String) instead.

Throws:

SerializationException

serialize

@Deprecated
public void serialize(Writer out)
               throws SerializationException

Deprecated.

use serializeXML(Writer, String) instead.

Throws:

SerializationException

serialize

@Deprecated
public void serialize(Writer out,
 String encoding)
               throws SerializationException

Deprecated.

use serializeXML(Writer, String) instead.

Throws:

SerializationException

serializeXML

public String serializeXML()
                    throws SerializationException

Serialize to non-compressed XML using the default encoding (UTF-8)

Throws:

SerializationException

serializeXML

public void serializeXML(OutputStream out,
 String encoding)
                  throws SerializationException

Serialize to XML format using the specified encoding.

Throws:

SerializationException

serializeXML

public void serializeXML(Writer out,
 String encoding)
                  throws SerializationException

Serialize to XML format using the specified encoding.

Throws:

SerializationException

serializeBinary

public byte[] serializeBinary(Object object,
 boolean gzip)
                       throws SerializationException

Serialize the given object using binary format. Shortcut for:

 serializer.addObject(object);
 serializer.serializeBinary(gzipFlag);
 

Throws:

SerializationException

serializeBinary

public byte[] serializeBinary(boolean gzip)
                       throws SerializationException

Serialize using the binary format. Optional gzip compression.

Throws:

SerializationException

serializeBinary

public void serializeBinary(OutputStream stream)
                     throws SerializationException

Serializes the added object(s) to the stream, and closes the stream.

Throws:

SerializationException

serialize

public void serialize(SerializationWriter writer)
               throws SerializationException

Serializes the object graph to the given serialization writer.

Throws:

SerializationException

createTopElement

protected Element createTopElement(List<Element> elements)

setCleanCopy

public static void setCleanCopy(Class type,
 Object obj)

getClassNameMap

public ClassNameResolver getClassNameMap()

registerEqualityDelegate

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