com.prosysopc.ua.stack.builtintypes

Class XmlElement

java.lang.Object

com.prosysopc.ua.stack.builtintypes.XmlElement

All Implemented Interfaces:

Cloneable

public final class XmlElement
extends Object
implements Cloneable

An XML element is a container for XML DOM documents.

Field Summary

Fields

Modifier and Type	Field and Description
static XmlElement[]	EMPTY_ARRAY
static NodeId	ID Deprecated. use Identifiers.XmlElement instead.
static String	UTF8_BOM

Constructor Summary

Constructors

Constructor and Description
XmlElement(byte[] encodedDocument) Create XML Element with UTF8 encoded XML document.
XmlElement(Node node) Create new XML Element from XML Node.
XmlElement(String document) Create new XML Element from XML document.

Method Summary

Modifier and Type	Method and Description
XmlElement	clone()
boolean	equals(Object obj)
byte[]	getData() Get the XmlElement as UTF8 encoded document.
Node	getNode() Returns the data as Node, assuming it was valid XML.
String	getValue() getValue.
int	hashCode()
String	toPrettyString(boolean includeXmlHeader, int indentationLevel) Returns a "pretty print" version of toString() with the chosen indentation level.
String	toString()

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ID

@Deprecated
public static final NodeId ID

Deprecated. use Identifiers.XmlElement instead.

The NodeId for the DataType node XmlElement in the UA AddressSpace.

EMPTY_ARRAY

public static final XmlElement[] EMPTY_ARRAY

UTF8_BOM

public static final String UTF8_BOM

See Also:

Constant Field Values

Constructor Detail

XmlElement

public XmlElement(byte[] encodedDocument)

Create XML Element with UTF8 encoded XML document.

Parameters:

encodedDocument - an array of byte.

XmlElement

public XmlElement(Node node)

Create new XML Element from XML Node.

Parameters:

node - xml node

XmlElement

public XmlElement(String document)

Create new XML Element from XML document.

Parameters:

document - a String object.

Method Detail

clone

public XmlElement clone()

Overrides:

clone in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getData

public byte[] getData()

Get the XmlElement as UTF8 encoded document.

Returns:

UTF8 encoded document

getNode

public Node getNode()
             throws IllegalStateException

Returns the data as Node, assuming it was valid XML. If it is not, an IllegalStateException is thrown instead.

Getter for the field node.

Returns:

a Node object.

Throws:

IllegalStateException

getValue

public String getValue()

getValue.

Returns:

a String object.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toPrettyString

public String toPrettyString(boolean includeXmlHeader,
                             int indentationLevel)

Returns a "pretty print" version of toString() with the chosen indentation level. If the 'includeXmlHeader is true, the xml header is included. Note that if the getValue() is not a valid XML document, this method returns it as-is.

toString

public String toString()

Overrides:

toString in class Object