.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "XML::Stream::Node 3pm"
.TH XML::Stream::Node 3pm "2018-09-10" "perl v5.26.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
XML::Stream::Node \- Functions to make building and parsing the tree easier
to work with.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&  Just a collection of functions that do not need to be in memory if you
\&choose one of the other methods of data storage.
\&
\&  This creates a hierarchy of Perl objects and provides various methods
\&to manipulate the structure of the tree.  It is much like the C library
\&libxml.
.Ve
.SH "FORMAT"
.IX Header "FORMAT"
The result of parsing:
.PP
.Vb 1
\&  <foo><head id="a">Hello <em>there</em></head><bar>Howdy<ref/></bar>do</foo>
.Ve
.PP
would be:
.PP
.Vb 10
\&  [ tag:       foo
\&    att:       {}
\&    children:  [ tag:      head
\&                 att:      {id=>"a"}
\&                 children: [ tag:      "_\|_xmlstream_\|_:node:cdata"
\&                             children: "Hello "
\&                           ]
\&                           [ tag:      em
\&                             children: [ tag:      "_\|_xmlstream_\|_:node:cdata"
\&                                         children: "there"
\&                                       ]
\&                           ]
\&               ]
\&               [ tag:      bar
\&                 children: [ tag:      "_\|_xmlstream_\|_:node:cdata"
\&                             children: "Howdy "
\&                           ]
\&                           [ tag:      ref
\&                           ]
\&               ]
\&               [ tag:      "_\|_xmlstream_\|_:node:cdata"
\&                 children: "do"
\&               ]
\&  ]
.Ve
.SH "METHODS"
.IX Header "METHODS"
.Vb 3
\&  new()          \- creates a new node.  If you specify tag, then the root
\&  new(tag)         tag is set.  If you specify data, then cdata is added
\&  new(tag,cdata)   to the node as well.  Returns the created node.
\&
\&  get_tag() \- returns the root tag of the node.
\&
\&  set_tag(tag) \- set the root tag of the node to tag.
\&
\&  add_child(node)      \- adds the specified node as a child to the current
\&  add_child(tag)         node, or creates a new node with the specified tag
\&  add_child(tag,cdata)   as the root node.  Returns the node added.
\&
\&  remove_child(node) \- removes the child node from the current node.
\&  
\&  remove_cdata() \- removes all of the cdata children from the current node.
\&
\&  add_cdata(string) \- adds the string as cdata onto the current nodes
\&                      child list.
\&
\&  get_cdata() \- returns all of the cdata children concatenated together
\&                into one string.
\&
\&  get_attrib(attrib) \- returns the value of the attrib if it is valid,
\&                       or returns undef is attrib is not a real
\&                       attribute.
\&
\&  put_attrib(hash) \- for each key/value pair specified, create an
\&                     attribute in the node.
\&
\&  remove_attrib(attrib) \- remove the specified attribute from the node.
\&
\&  add_raw_xml(string,[string,...]) \- directly add a string into the XML
\&                                     packet as the last child, with no
\&                                     translation.
\&
\&  get_raw_xml() \- return all of the XML in a single string, undef if there
\&                  is no raw XML to include.
\&
\&  remove_raw_xml() \- remove all raw XML strings.
\&
\&  children() \- return all of the children of the node in a list.
\&
\&  attrib() \- returns a hash containing all of the attributes on this
\&             node.
\&
\&  copy() \- return a recursive copy of the node.
\&
\&  XPath(path) \- run XML::Stream::XPath on this node.
\&  
\&  XPathCheck(path) \- run XML::Stream::XPath on this node and return 1 or 0
\&                     to see if it matches or not.
\&
\&  GetXML() \- return the node in XML string form.
.Ve
.SH "AUTHOR"
.IX Header "AUTHOR"
By Ryan Eatmon in June 2002 for http://jabber.org/
.PP
Currently maintained by Darian Anthony Patrick.
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (C) 1998\-2004 Jabber Software Foundation http://jabber.org/
.PP
This module licensed under the \s-1LGPL,\s0 version 2.1.