com.cordys.xml.dom

Interface NOMNode

public interface NOMNode

It is recommended to use equivalent APIs from NOMUtil
This interface declares methods to convert DOM nodes to NOM nodes with/without memory management ownership. In addition to that it provides facility to delete DOM nodes.

Method Summary

Modifier and Type	Method and Description
void	deleteNode() Deletes underlying NOM memory.
int	getNOMNode() Retrieves the NOM node represented by this DOM Node.
int	unwrap() Convert the DOM tree into a NOM tree.

Method Detail

getNOMNode

int getNOMNode()
        throws XMLException

Retrieves the NOM node represented by this DOM Node. It doesn't affect the memory ownership of the underlying XML tree. The returned NOM Node can be altered by NOM API.

Returns:

- The NOM Node

Throws:

XMLException

unwrap

int unwrap()
    throws XMLException

Convert 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 cleanup responsibility lies with the user as the memory ownership is removed from the DOM-wrapper.Please note the difference between this method and 'getNOMNode'. 'getNOMNode' is returning a NOM node without changing the memory ownership

Returns:

the NOM tree.

Throws:

XMLException

deleteNode

void deleteNode()

Deletes underlying NOM memory. This can be used when immediate memory clean-up is required for the XML tree. DOM wrapper depends on the JVM's garbage collection mechanism to do the auto cleanup of 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).