class XML::Node

• XML::Node
• Reference
• Object

Defined in:

Constant Summary

LOOKS_LIKE_XPATH = /^(\.\/|\/|\.\.|\.$)/

Constructors

• .new(node : Pointer(LibXML::Attr))

  Creates a new node.

• .new(node : Pointer(LibXML::Doc), errors : Array(XML::Error) | Nil = nil)

  Creates a new node.

• .new(node : Pointer(LibXML::Node))

  Creates a new node.

Instance Method Summary

• #==(other : Node)

  Compares with other.

• #[](attribute : String) : String

  Gets the attribute content for the attribute given by name.

• #[]=(name : String, value)

  Sets attribute of this node to value.

• #[]?(attribute : String) : String | Nil

  Gets the attribute content for the attribute given by name.

• #attribute? : Bool

  Returns true if this is an attribute node.

• #attributes : XML::Attributes

  Returns attributes of this node as an XML::Attributes.

• #cdata? : Bool

  Returns true if this is a CDATA section node.

• #children : XML::NodeSet

  Gets the list of children for this node as a XML::NodeSet.

• #comment?

  Returns true if this is a comment node.

• #content : String

  Returns the content for this Node.

• #content=(content)

  Sets the Node's content to a Text node containing string.

• #delete(name : String) : String | Nil

  Deletes attribute given by name.

• #document : XML::Node

  Gets the document for this Node as a XML::Node.

• #document? : Bool

  Returns true if this is a Document or HTML Document node.

• #element? : Bool

  Returns true if this is an Element node.

• #encoding : String | Nil

  Returns the encoding of this node's document.

• #errors : Array(XML::Error) | Nil

  Returns the list of XML::Error found when parsing this document.

• #first_element_child : XML::Node | Nil

  Returns the first child node of this node that is an element.

• #fragment? : Bool

  Returns true if this is a DocumentFragment.

• #hash(hasher)

  See Object#hash(hasher)

• #inner_text : String

  Returns the content for this Node.

• #inspect(io : IO) : Nil

  Returns detailed information for this node including node type, name, attributes and children.

• #name : String

  Returns the name for this Node.

• #name=(name)

  Sets the name for this Node.

• #namespace : Namespace | Nil

  Returns the namespace for this node or nil if not found.

• #namespace_definitions : Array(Namespace)

  Returns namespaces defined on this node directly.

• #namespace_scopes : Array(Namespace)

  Returns namespaces in scope for this node – those defined on this node directly or any ancestor node – as an Array of XML::Namespace objects.

• #namespaces : Hash(String, String | Nil)

  Returns a Hash(String, String?) of prefix => href for all namespaces on this node and its ancestors.

• #next : XML::Node | Nil

  Returns the next sibling node or nil if not found.

• #next_element : XML::Node | Nil

  Returns the next element node sibling or nil if not found.

• #next_sibling : XML::Node | Nil

  Returns the next sibling node or nil if not found.

• #object_id : UInt64

  Returns the address of underlying LibXML::Node* in memory.

• #parent : XML::Node | Nil

  Returns the parent node or nil if not found.

• #previous : XML::Node | Nil

  Returns the previous sibling node or nil if not found.

• #previous_element : XML::Node | Nil

  Returns the previous sibling node that is an element or nil if not found.

• #previous_sibling : XML::Node | Nil

  Returns the previous sibling node or nil if not found.

• #processing_instruction?

  Returns true if this is a Processing Instruction node.

• #root : XML::Node | Nil

  Returns the root node for this document or nil.

• #text : String

  Same as #content.

• #text=(text)

  Same as #content=.

• #text? : Bool

  Returns true if this is a Text node.

• #to_s(io : IO) : Nil

  Serialize this Node as XML to io using default options.

• #to_unsafe : Pointer(LibXML::Node)

  Returns underlying LibXML::Node* instance.

• #to_xml(indent : Int = 2, indent_text = " ", options : SaveOptions = SaveOptions.xml_default) : String

  Serialize this Node as XML and return a String using default options.

• #to_xml(io : IO, indent = 2, indent_text = " ", options : SaveOptions = SaveOptions.xml_default)

  Serialize this Node as XML to io using default options.

• #type : XML::Node::Type

  Returns the type for this Node as XML::Node::Type.

• #unlink : Nil

  Removes the node from the XML document.

• #version : String | Nil

  Returns the version of this node's document.

• #xml?

  Returns true if this is an xml Document node.

• #xpath(path, namespaces = nil, variables = nil)

  Searches this node for XPath path.

• #xpath_bool(path, namespaces = nil, variables = nil)

  Searches this node for XPath path and restricts the return type to Bool.

• #xpath_float(path, namespaces = nil, variables = nil)

  Searches this node for XPath path and restricts the return type to Float64.

• #xpath_node(path, namespaces = nil, variables = nil)

  Searches this node for XPath path for nodes and returns the first one.

• #xpath_nodes(path, namespaces = nil, variables = nil)

  Searches this node for XPath path and restricts the return type to NodeSet.

• #xpath_string(path, namespaces = nil, variables = nil)

  Searches this node for XPath path and restricts the return type to String.

Constructor Detail

Instance Method Detail

require "xml"

doc = XML.parse("<person></person>")

doc.xpath_bool("count(//person) > 0") # => true

require "xml"

doc = XML.parse("<person></person>")

doc.xpath_float("count(//person)") # => 1.0

require "xml"

doc = XML.parse("<person></person>")

doc.xpath_node("//person")  # => #<XML::Node:0x2013e80 name="person">
doc.xpath_node("//invalid") # => nil

require "xml"

doc = XML.parse("<person></person>")

nodes = doc.xpath_nodes("//person")
nodes.class       # => XML::NodeSet
nodes.map(&.name) # => ["person"]

require "xml"

doc = XML.parse("<person></person>")

doc.xpath_string("string(/persons/person[1])")