com.cordys.xml.dom

Class NOMHandle

java.lang.Object

com.cordys.xml.dom.NOMHandle

All Implemented Interfaces:

java.lang.AutoCloseable

public class NOMHandle
extends java.lang.Object
implements java.lang.AutoCloseable

Author:

sjeganathan It constructs a wrapper around a DOM node and provides a method to retrieve NOM node corresponding to the DOM with auto closeable functionality. Use this class when you need to retrieve the NOM node corresponding to a DOM node from DOM-over-NOM implementation. This stores a reference to the passed in DOM node. The reference will be cleared when the close method is invoked. It should be used with Try-with-Resources construct as shown below. The close method will be invoked automatically once the scope of Try-with-Resource block is over. So explicit invocation of close() method is not required. It is guaranteed that the DOM wrapper will not auto cleanup the DOM node until the Try-with-Resource block scope is over. Note: You may also use NOMUtil.getNOMHandle() to get a new instance.

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

Method Summary

Modifier and Type	Method and Description
void	close()
int	getNOMNode() Returns the NOM node corresponding to the DOM Node.

Methods inherited from class java.lang.Object

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

Method Detail

close

public void close()

Specified by:

close in interface java.lang.AutoCloseable

getNOMNode

public int getNOMNode()

Returns the NOM node corresponding to the DOM Node. This doesn't affect the cleanup responsibility of the corresponding DOM node. The returned NOM node should not be deleted.

Returns:

NOM node corresponding to the wrapped DOM node.