com.cordys.xml.dom

Class NOMUtil

java.lang.Object

com.cordys.xml.dom.NOMUtil

public final class NOMUtil
extends java.lang.Object

Author:

sjeganathan This provides NOM related utility functions for Cordys' implementation(DOM-over-NOM) of DOM specification.

Method Summary

Modifier and Type	Method and Description
static void	deleteNode(org.w3c.dom.Node node) Removes the cleanup responsibility from DOM wrapper and explicitly frees the underlying NOM memory of the XML tree.
static NOMHandle	getNOMHandle(org.w3c.dom.Node node) It returns a NOMHandle corresponding to the given DOM Node
static int	getNOMNode(org.w3c.dom.Node node) Deprecated. in BOP4.3. instead use getNOMHandle(Node node)
static int	unwrap(org.w3c.dom.Node node) It Converts the DOM tree into a NOM tree.

Methods inherited from class java.lang.Object

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

Method Detail

deleteNode

public static void deleteNode(org.w3c.dom.Node node)

Removes the cleanup responsibility from DOM wrapper and explicitly frees the underlying NOM memory of the XML tree. DOM wrapper depends on the JVM's garbage collection mechanism to cleanup unused Node's memory. This API can be used to release the NOM memory immediately, instead of depending on the auto cleanup facility of DOM wrapper. It can throw XMLException from Native layer, when an attempt is made to delete an invalid node(Node that is deleted already).

Parameters:

node -

getNOMNode

@Deprecated
public static int getNOMNode(org.w3c.dom.Node node)

Deprecated. in BOP4.3. instead use getNOMHandle(Node node)

Retrieves the NOM node represented by the given DOM Node. It doesn't affect the memory ownership of the underlying XML tree. The returned NOM Node can be altered by NOM API. It returns 0 for DOM Node from other implementations.

Returns:

- The NOM Node

Throws:

IlleagalStateException - when the NOM node corresponding to this DOM node is invalid(It is deleted already).

LocalizableUnsupportedOperationException - when the node is an Attr.

unwrap

public static int unwrap(org.w3c.dom.Node node)

It Converts the DOM tree into a NOM tree. The returned tree is a full blown NOM tree. Thus , once it is converted to NOM tree, the tree is meant to be deleted. It should be deleted by com.eibus.xml.nom.Node.delete() API.Please note the difference between this method and 'getNOMNode'. 'getNOMNode' is returning a NOM node without changing memory ownership. It returns 0 for DOM Node from other implementations.

Returns:

the NOM tree.

Throws:

IlleagalStateException - when the NOM node corresponding to this DOM node is invalid(It is deleted already)

LocalizableUnsupportedOperationException - when the node is an Attr.

getNOMHandle

public static NOMHandle getNOMHandle(org.w3c.dom.Node node)

It returns a NOMHandle corresponding to the given DOM Node

Parameters:

node, - the DOM node to which NOMHandle is to be created. This method should be used only in Try-With-Resource construct. Refer Documentation of NOMHandle for more information

Returns:

NOMHandle corresponding to the DOM Node

 Node domNode = constructDOMNode();//constructDOMNode() returns a DOM node from DOM-over-NOM implementation
 try(NOMHandle handle = NOMUtil.getNOMHandle(domNode)){
                oldAPIStillDemandingNOMNode(handle.getNOMNode());
 }