node.md

title
xmlua.Node

xmlua.Node class

Summary

It's a class that provides a common method for each node.

Normally, you can not get an object.

Class methods

content() -> string {#content}

It returns content of the each nodes as string.

For example, in a case of a comment node, it becomes as below.

Example:

local xmlua = require("xmlua")

local document = xmlua.XML.build({"root"})
local comment_node =
  document:create_comment("This is comment")
print(comment_node:content())
--This is comment

set_content(countent) -> void {#set-content}

You can set content of each nodes with this method.

For example, in a case of a comment node, it becomes as below.

Example:

local xmlua = require("xmlua")

local document = xmlua.XML.build({"root"})
local comment_node =
  document:create_comment("This is comment")
print(comment_node:content())
--This is comment
comment_node:set_content("Seted comment")
print(comment_node:content())
--Seted comment

replace(replace_node) -> void {#replace}

You can replace receiver node to specify node.

Example:

local document = xmlua.XML.build({"root"})

local comment_node =
  document:create_comment("This is comment")
local replace_node =
  document:create_cdata_section("This is <CDATASetion>")
root = document:root()
root:add_child(comment_node)
print(document:to_xml())
--<?xml version="1.0" encoding="UTF-8"?>
--<root>
--  <!--This is Comment-->
--</root>
comment_node:replace(replace_node)
print(document:to_xml())
--<?xml version="1.0" encoding="UTF-8"?>
--<root><!--[CDATA[This is <CDATA>]]></root>

text() -> nil {#text}

It's returns nil. It is a method for nodes that don't have child elements.

path() -> string {#path}

It returns XPath of the each node as string.

For example, in a case of a comment node, it becomes as below.

Example:

local document = xmlua.XML.build({"root"})

local comment_node =
  document:create_comment("This is comment")
root = document:root()
root:add_child(comment_node)
print(comment_node:path())
--/root/comment()

unlink() -> xmlua.Element {#unlink}

It remove receiver from document tree.

Example:

local document = xmlua.XML.build({"root"})

local comment_node =
  document:create_comment("This is comment")
root = document:root()
root:add_child(comment_node)
print(document:to_xml())
--<?xml version="1.0" encoding="UTF-8"?>
--<root>
--  <!--This is comment-->
--</root>
comment_node:unlink()
print(document:to_xml())
--<?xml version="1.0" encoding="UTF-8"?>
--<root/>