com.inscoper.api.XMLDocument¶

XMLDocument class represents an entire XML document. More...

Public Functions¶

	Name
synchronized void	delete()
	XMLDocument() Default constructor.
void	loadFile(String xmlFile) Load from file.
boolean	tryLoadingFile(String xmlFile) Try loading from file.
void	saveFile(String xmlFile) Save to file.
XMLNode	getChild(String name) Get child node by name.
XMLNode	toXMLNode() Convert to XML node.

Protected Functions¶

	Name
	XMLDocument(long cPtr, boolean cMemoryOwn)
void	finalize()
long	getCPtr(XMLDocument obj)
long	swigRelease(XMLDocument obj)

Protected Attributes¶

	Name
transient boolean	swigCMemOwn

Detailed Description¶

public class com.inscoper.api.XMLDocument;

XMLDocument class represents an entire XML document.

Note: This class is non-copyable and non-movable.

This class handles loading and saving of XML documents and access to the root node.

Public Functions Documentation¶

function delete¶

public synchronized void delete()

function XMLDocument¶

public XMLDocument()

Default constructor.

function loadFile¶

public void loadFile(
    String xmlFile
)

Load from file.

Parameters:

xmlFile : The path to the XML file

Exceptions:

InscoperException If an error occurs during loading

Loads the XML document from a file path.

function tryLoadingFile¶

public boolean tryLoadingFile(
    String xmlFile
)

Try loading from file.

Parameters:

xmlFile : The path to the XML file

Return: True if loading was successful, false otherwise

Attempts to load the XML document without throwing an exception.

function saveFile¶

public void saveFile(
    String xmlFile
)

Save to file.

Parameters:

xmlFile : The path where the XML file will be saved

Exceptions:

InscoperException If an error occurs during saving

Saves the current XML document to a file.

function getChild¶

public XMLNode getChild(
    String name
)

Get child node by name.

Parameters:

name : The name of the child node

Return: The child XML node

Retrieves a direct child node with the name.

function toXMLNode¶

public XMLNode toXMLNode()

Convert to XML node.

Return: The root XML node

Returns the root element of the document as an XML node.

Protected Functions Documentation¶

function XMLDocument¶

protected XMLDocument(
    long cPtr,
    boolean cMemoryOwn
)

function finalize¶

protected void finalize()

function getCPtr¶

protected static long getCPtr(
    XMLDocument obj
)

function swigRelease¶

protected static long swigRelease(
    XMLDocument obj
)

Protected Attributes Documentation¶

variable swigCMemOwn¶

transient boolean swigCMemOwn;

Updated on 2026-09-03 at 12:14:19 +0200