File: C:/Ruby27-x64/share/doc/ruby/html/REXML/Elements.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class REXML::Elements - RDoc Documentation</title>
<script type="text/javascript">
var rdoc_rel_prefix = "../";
var index_rel_prefix = "../";
</script>
<script src="../js/navigation.js" defer></script>
<script src="../js/search.js" defer></script>
<script src="../js/search_index.js" defer></script>
<script src="../js/searcher.js" defer></script>
<script src="../js/darkfish.js" defer></script>
<link href="../css/fonts.css" rel="stylesheet">
<link href="../css/rdoc.css" rel="stylesheet">
<body id="top" role="document" class="class">
<nav role="navigation">
<div id="project-navigation">
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
<h2>
<a href="../index.html" rel="home">Home</a>
</h2>
<div id="table-of-contents-navigation">
<a href="../table_of_contents.html#pages">Pages</a>
<a href="../table_of_contents.html#classes">Classes</a>
<a href="../table_of_contents.html#methods">Methods</a>
</div>
</div>
<div id="search-section" role="search" class="project-section initially-hidden">
<form action="#" method="get" accept-charset="utf-8">
<div id="search-field-wrapper">
<input id="search-field" role="combobox" aria-label="Search"
aria-autocomplete="list" aria-controls="search-results"
type="text" name="search" placeholder="Search" spellcheck="false"
title="Type to search, Up and Down to navigate, Enter to load">
</div>
<ul id="search-results" aria-label="Search Results"
aria-busy="false" aria-expanded="false"
aria-atomic="false" class="initially-hidden"></ul>
</form>
</div>
</div>
<div id="class-metadata">
<div id="parent-class-section" class="nav-section">
<h3>Parent</h3>
<p class="link"><a href="../Object.html">Object</a>
</div>
<div id="includes-section" class="nav-section">
<h3>Included Modules</h3>
<ul class="link-list">
<li><a class="include" href="../Enumerable.html">Enumerable</a>
</ul>
</div>
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li ><a href="#method-c-new">::new</a>
<li ><a href="#method-i-3C-3C">#<<</a>
<li ><a href="#method-i-5B-5D">#[]</a>
<li ><a href="#method-i-5B-5D-3D">#[]=</a>
<li ><a href="#method-i-add">#add</a>
<li ><a href="#method-i-collect">#collect</a>
<li ><a href="#method-i-delete">#delete</a>
<li ><a href="#method-i-delete_all">#delete_all</a>
<li ><a href="#method-i-each">#each</a>
<li ><a href="#method-i-empty-3F">#empty?</a>
<li ><a href="#method-i-index">#index</a>
<li ><a href="#method-i-inject">#inject</a>
<li ><a href="#method-i-literalize">#literalize</a>
<li ><a href="#method-i-size">#size</a>
<li ><a href="#method-i-to_a">#to_a</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-REXML::Elements">
<h1 id="class-REXML::Elements" class="class">
class REXML::Elements
</h1>
<section class="description">
<p>A class which provides filtering of children for <a href="Elements.html"><code>Elements</code></a>, and <a href="XPath.html"><code>XPath</code></a> search support. You are expected to only encounter this class as the <code>element.elements</code> object. Therefore, you are <em>not</em> expected to instantiate this yourself.</p>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Class Methods</h3>
</header>
<div id="method-c-new" class="method-detail ">
<div class="method-heading">
<span class="method-name">new</span><span
class="method-args">(parent)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Constructor</p>
<dl class="rdoc-list note-list"><dt>parent
<dd>
<p>the parent <a href="Element.html"><code>Element</code></a></p>
</dd></dl>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/rexml/element.rb, line 765</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span> <span class="ruby-identifier">parent</span>
<span class="ruby-ivar">@element</span> = <span class="ruby-identifier">parent</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Instance Methods</h3>
</header>
<div id="method-i-3C-3C" class="method-detail method-alias">
<div class="method-heading">
<span class="method-name"><<</span><span
class="method-args">(element=nil)</span>
</div>
<div class="method-description">
</div>
<div class="aliases">
Alias for: <a href="Elements.html#method-i-add">add</a>
</div>
</div>
<div id="method-i-5B-5D" class="method-detail ">
<div class="method-heading">
<span class="method-name">[]</span><span
class="method-args">( index, name=nil)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Fetches a child element. Filters only <a href="Element.html"><code>Element</code></a> children, regardless of the <a href="XPath.html"><code>XPath</code></a> match.</p>
<dl class="rdoc-list note-list"><dt>index
<dd>
<p>the search parameter. This is either an <a href="../Integer.html"><code>Integer</code></a>, which will be used to find the index'th child <a href="Element.html"><code>Element</code></a>, or an <a href="XPath.html"><code>XPath</code></a>, which will be used to search for the <a href="Element.html"><code>Element</code></a>. <em>Because of the nature of <a href="XPath.html"><code>XPath</code></a> searches, any element in the connected <a href="../XML.html"><code>XML</code></a> document can be fetched through any other element.</em> <strong>The <a href="../Integer.html"><code>Integer</code></a> index is 1-based, not 0-based.</strong> This means that the first child element is at index 1, not 0, and the +n+th element is at index <code>n</code>, not <code>n-1</code>. This is because <a href="XPath.html"><code>XPath</code></a> indexes element children starting from 1, not 0, and the indexes should be the same.</p>
</dd><dt>name
<dd>
<p>optional, and only used in the first argument is an <a href="../Integer.html"><code>Integer</code></a>. In that case, the index'th child <a href="Element.html"><code>Element</code></a> that has the supplied name will be returned. Note again that the indexes start at 1.</p>
</dd><dt>Returns
<dd>
<p>the first matching <a href="Element.html"><code>Element</code></a>, or nil if no child matched</p>
</dd></dl>
<pre class="ruby"><span class="ruby-identifier">doc</span> = <span class="ruby-constant">Document</span>.<span class="ruby-identifier">new</span> <span class="ruby-string">'<a><b/><c id="1"/><c id="2"/><d/></a>'</span>
<span class="ruby-identifier">doc</span>.<span class="ruby-identifier">root</span>.<span class="ruby-identifier">elements</span>[<span class="ruby-value">1</span>] <span class="ruby-comment">#-> <b/></span>
<span class="ruby-identifier">doc</span>.<span class="ruby-identifier">root</span>.<span class="ruby-identifier">elements</span>[<span class="ruby-string">'c'</span>] <span class="ruby-comment">#-> <c id="1"/></span>
<span class="ruby-identifier">doc</span>.<span class="ruby-identifier">root</span>.<span class="ruby-identifier">elements</span>[<span class="ruby-value">2</span>,<span class="ruby-string">'c'</span>] <span class="ruby-comment">#-> <c id="2"/></span>
</pre>
<div class="method-source-code" id="5B-5D-source">
<pre><span class="ruby-comment"># File lib/rexml/element.rb, line 790</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">[]</span>( <span class="ruby-identifier">index</span>, <span class="ruby-identifier">name</span>=<span class="ruby-keyword">nil</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">index</span>.<span class="ruby-identifier">kind_of?</span> <span class="ruby-constant">Integer</span>
<span class="ruby-identifier">raise</span> <span class="ruby-node">"index (#{index}) must be >= 1"</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">index</span> <span class="ruby-operator"><</span> <span class="ruby-value">1</span>
<span class="ruby-identifier">name</span> = <span class="ruby-identifier">literalize</span>(<span class="ruby-identifier">name</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">name</span>
<span class="ruby-identifier">num</span> = <span class="ruby-value">0</span>
<span class="ruby-ivar">@element</span>.<span class="ruby-identifier">find</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">child</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">child</span>.<span class="ruby-identifier">kind_of?</span> <span class="ruby-constant">Element</span> <span class="ruby-keyword">and</span>
(<span class="ruby-identifier">name</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-operator">?</span> <span class="ruby-keyword">true</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">child</span>.<span class="ruby-identifier">has_name?</span>( <span class="ruby-identifier">name</span> )) <span class="ruby-keyword">and</span>
(<span class="ruby-identifier">num</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span>) <span class="ruby-operator">==</span> <span class="ruby-identifier">index</span>
}
<span class="ruby-keyword">else</span>
<span class="ruby-keyword">return</span> <span class="ruby-constant">XPath</span><span class="ruby-operator">::</span><span class="ruby-identifier">first</span>( <span class="ruby-ivar">@element</span>, <span class="ruby-identifier">index</span> )
<span class="ruby-comment">#{ |element|</span>
<span class="ruby-comment"># return element if element.kind_of? Element</span>
<span class="ruby-comment">#}</span>
<span class="ruby-comment">#return nil</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-5B-5D-3D" class="method-detail ">
<div class="method-heading">
<span class="method-name">[]=</span><span
class="method-args">( index, element )</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Sets an element, replacing any previous matching element. If no existing element is found ,the element is added.</p>
<dl class="rdoc-list note-list"><dt>index
<dd>
<p>Used to find a matching element to replace. See []().</p>
</dd><dt>element
<dd>
<p>The element to replace the existing element with the previous element</p>
</dd><dt>Returns
<dd>
<p>nil if no previous element was found.</p>
</dd></dl>
<pre class="ruby"><span class="ruby-identifier">doc</span> = <span class="ruby-constant">Document</span>.<span class="ruby-identifier">new</span> <span class="ruby-string">'<a/>'</span>
<span class="ruby-identifier">doc</span>.<span class="ruby-identifier">root</span>.<span class="ruby-identifier">elements</span>[<span class="ruby-value">10</span>] = <span class="ruby-constant">Element</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">'b'</span>) <span class="ruby-comment">#-> <a><b/></a></span>
<span class="ruby-identifier">doc</span>.<span class="ruby-identifier">root</span>.<span class="ruby-identifier">elements</span>[<span class="ruby-value">1</span>] <span class="ruby-comment">#-> <b/></span>
<span class="ruby-identifier">doc</span>.<span class="ruby-identifier">root</span>.<span class="ruby-identifier">elements</span>[<span class="ruby-value">1</span>] = <span class="ruby-constant">Element</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">'c'</span>) <span class="ruby-comment">#-> <a><c/></a></span>
<span class="ruby-identifier">doc</span>.<span class="ruby-identifier">root</span>.<span class="ruby-identifier">elements</span>[<span class="ruby-string">'c'</span>] = <span class="ruby-constant">Element</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">'d'</span>) <span class="ruby-comment">#-> <a><d/></a></span>
</pre>
<div class="method-source-code" id="5B-5D-3D-source">
<pre><span class="ruby-comment"># File lib/rexml/element.rb, line 822</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">[]=</span>( <span class="ruby-identifier">index</span>, <span class="ruby-identifier">element</span> )
<span class="ruby-identifier">previous</span> = <span class="ruby-keyword">self</span>[<span class="ruby-identifier">index</span>]
<span class="ruby-keyword">if</span> <span class="ruby-identifier">previous</span>.<span class="ruby-identifier">nil?</span>
<span class="ruby-ivar">@element</span>.<span class="ruby-identifier">add</span> <span class="ruby-identifier">element</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">previous</span>.<span class="ruby-identifier">replace_with</span> <span class="ruby-identifier">element</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">return</span> <span class="ruby-identifier">previous</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-add" class="method-detail ">
<div class="method-heading">
<span class="method-name">add</span><span
class="method-args">(element=nil)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Adds an element</p>
<dl class="rdoc-list note-list"><dt>element
<dd>
<p>if supplied, is either an <a href="Element.html"><code>Element</code></a>, <a href="../String.html"><code>String</code></a>, or <a href="Source.html"><code>Source</code></a> (see Element.initialize). If not supplied or nil, a new, default <a href="Element.html"><code>Element</code></a> will be constructed</p>
</dd><dt>Returns
<dd>
<p>the added <a href="Element.html"><code>Element</code></a></p>
</dd></dl>
<pre class="ruby"><span class="ruby-identifier">a</span> = <span class="ruby-constant">Element</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">'a'</span>)
<span class="ruby-identifier">a</span>.<span class="ruby-identifier">elements</span>.<span class="ruby-identifier">add</span>(<span class="ruby-constant">Element</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">'b'</span>)) <span class="ruby-comment">#-> <a><b/></a></span>
<span class="ruby-identifier">a</span>.<span class="ruby-identifier">elements</span>.<span class="ruby-identifier">add</span>(<span class="ruby-string">'c'</span>) <span class="ruby-comment">#-> <a><b/><c/></a></span>
</pre>
<div class="method-source-code" id="add-source">
<pre><span class="ruby-comment"># File lib/rexml/element.rb, line 898</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">add</span> <span class="ruby-identifier">element</span>=<span class="ruby-keyword">nil</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">element</span>.<span class="ruby-identifier">nil?</span>
<span class="ruby-constant">Element</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">""</span>, <span class="ruby-keyword">self</span>, <span class="ruby-ivar">@element</span>.<span class="ruby-identifier">context</span>)
<span class="ruby-keyword">elsif</span> <span class="ruby-keyword">not</span> <span class="ruby-identifier">element</span>.<span class="ruby-identifier">kind_of?</span>(<span class="ruby-constant">Element</span>)
<span class="ruby-constant">Element</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">element</span>, <span class="ruby-keyword">self</span>, <span class="ruby-ivar">@element</span>.<span class="ruby-identifier">context</span>)
<span class="ruby-keyword">else</span>
<span class="ruby-ivar">@element</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">element</span>
<span class="ruby-identifier">element</span>.<span class="ruby-identifier">context</span> = <span class="ruby-ivar">@element</span>.<span class="ruby-identifier">context</span>
<span class="ruby-identifier">element</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
<div class="aliases">
Also aliased as: <a href="Elements.html#method-i-3C-3C"><<</a>
</div>
</div>
<div id="method-i-collect" class="method-detail ">
<div class="method-heading">
<span class="method-name">collect</span><span
class="method-args">( xpath=nil ) { |e| ... }</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="collect-source">
<pre><span class="ruby-comment"># File lib/rexml/element.rb, line 930</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">collect</span>( <span class="ruby-identifier">xpath</span>=<span class="ruby-keyword">nil</span> )
<span class="ruby-identifier">collection</span> = []
<span class="ruby-constant">XPath</span><span class="ruby-operator">::</span><span class="ruby-identifier">each</span>( <span class="ruby-ivar">@element</span>, <span class="ruby-identifier">xpath</span> ) {<span class="ruby-operator">|</span><span class="ruby-identifier">e</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">collection</span> <span class="ruby-operator"><<</span> <span class="ruby-keyword">yield</span>(<span class="ruby-identifier">e</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">e</span>.<span class="ruby-identifier">kind_of?</span>(<span class="ruby-constant">Element</span>)
}
<span class="ruby-identifier">collection</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-delete" class="method-detail ">
<div class="method-heading">
<span class="method-name">delete</span><span
class="method-args">(element)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Deletes a child <a href="Element.html"><code>Element</code></a></p>
<dl class="rdoc-list note-list"><dt>element
<dd>
<p>Either an <a href="Element.html"><code>Element</code></a>, which is removed directly; an xpath, where the first matching child is removed; or an <a href="../Integer.html"><code>Integer</code></a>, where the n'th <a href="Element.html"><code>Element</code></a> is removed.</p>
</dd><dt>Returns
<dd>
<p>the removed child</p>
</dd></dl>
<pre class="ruby"><span class="ruby-identifier">doc</span> = <span class="ruby-constant">Document</span>.<span class="ruby-identifier">new</span> <span class="ruby-string">'<a><b/><c/><c id="1"/></a>'</span>
<span class="ruby-identifier">b</span> = <span class="ruby-identifier">doc</span>.<span class="ruby-identifier">root</span>.<span class="ruby-identifier">elements</span>[<span class="ruby-value">1</span>]
<span class="ruby-identifier">doc</span>.<span class="ruby-identifier">root</span>.<span class="ruby-identifier">elements</span>.<span class="ruby-identifier">delete</span> <span class="ruby-identifier">b</span> <span class="ruby-comment">#-> <a><c/><c id="1"/></a></span>
<span class="ruby-identifier">doc</span>.<span class="ruby-identifier">elements</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-string">"a/c[@id='1']"</span>) <span class="ruby-comment">#-> <a><c/></a></span>
<span class="ruby-identifier">doc</span>.<span class="ruby-identifier">root</span>.<span class="ruby-identifier">elements</span>.<span class="ruby-identifier">delete</span> <span class="ruby-value">1</span> <span class="ruby-comment">#-> <a/></span>
</pre>
<div class="method-source-code" id="delete-source">
<pre><span class="ruby-comment"># File lib/rexml/element.rb, line 862</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">delete</span> <span class="ruby-identifier">element</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">element</span>.<span class="ruby-identifier">kind_of?</span> <span class="ruby-constant">Element</span>
<span class="ruby-ivar">@element</span>.<span class="ruby-identifier">delete</span> <span class="ruby-identifier">element</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">el</span> = <span class="ruby-keyword">self</span>[<span class="ruby-identifier">element</span>]
<span class="ruby-identifier">el</span>.<span class="ruby-identifier">remove</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">el</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-delete_all" class="method-detail ">
<div class="method-heading">
<span class="method-name">delete_all</span><span
class="method-args">( xpath )</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Removes multiple elements. Filters for <a href="Element.html"><code>Element</code></a> children, regardless of <a href="XPath.html"><code>XPath</code></a> matching.</p>
<dl class="rdoc-list note-list"><dt>xpath
<dd>
<p>all elements matching this <a href="../String.html"><code>String</code></a> path are removed.</p>
</dd><dt>Returns
<dd>
<p>an <a href="../Array.html"><code>Array</code></a> of <a href="Elements.html"><code>Elements</code></a> that have been removed</p>
</dd></dl>
<pre class="ruby"><span class="ruby-identifier">doc</span> = <span class="ruby-constant">Document</span>.<span class="ruby-identifier">new</span> <span class="ruby-string">'<a><c/><c/><c/><c/></a>'</span>
<span class="ruby-identifier">deleted</span> = <span class="ruby-identifier">doc</span>.<span class="ruby-identifier">elements</span>.<span class="ruby-identifier">delete_all</span> <span class="ruby-string">'a/c'</span> <span class="ruby-comment">#-> [<c/>, <c/>, <c/>, <c/>]</span>
</pre>
<div class="method-source-code" id="delete_all-source">
<pre><span class="ruby-comment"># File lib/rexml/element.rb, line 877</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">delete_all</span>( <span class="ruby-identifier">xpath</span> )
<span class="ruby-identifier">rv</span> = []
<span class="ruby-constant">XPath</span><span class="ruby-operator">::</span><span class="ruby-identifier">each</span>( <span class="ruby-ivar">@element</span>, <span class="ruby-identifier">xpath</span>) {<span class="ruby-operator">|</span><span class="ruby-identifier">element</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">rv</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">element</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">element</span>.<span class="ruby-identifier">kind_of?</span> <span class="ruby-constant">Element</span>
}
<span class="ruby-identifier">rv</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">element</span><span class="ruby-operator">|</span>
<span class="ruby-ivar">@element</span>.<span class="ruby-identifier">delete</span> <span class="ruby-identifier">element</span>
<span class="ruby-identifier">element</span>.<span class="ruby-identifier">remove</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">return</span> <span class="ruby-identifier">rv</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-each" class="method-detail ">
<div class="method-heading">
<span class="method-name">each</span><span
class="method-args">( xpath=nil ) { |e| ... }</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Iterates through all of the child <a href="Elements.html"><code>Elements</code></a>, optionally filtering them by a given <a href="XPath.html"><code>XPath</code></a></p>
<dl class="rdoc-list note-list"><dt>xpath
<dd>
<p>optional. If supplied, this is a <a href="../String.html"><code>String</code></a> <a href="XPath.html"><code>XPath</code></a>, and is used to filter the children, so that only matching children are yielded. Note that XPaths are automatically filtered for <a href="Elements.html"><code>Elements</code></a>, so that non-Element children will not be yielded</p>
</dd></dl>
<pre class="ruby"><span class="ruby-identifier">doc</span> = <span class="ruby-constant">Document</span>.<span class="ruby-identifier">new</span> <span class="ruby-string">'<a><b/><c/><d/>sean<b/><c/><d/></a>'</span>
<span class="ruby-identifier">doc</span>.<span class="ruby-identifier">root</span>.<span class="ruby-identifier">elements</span>.<span class="ruby-identifier">each</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">e</span><span class="ruby-operator">|</span><span class="ruby-identifier">p</span> <span class="ruby-identifier">e</span>} <span class="ruby-comment">#-> Yields b, c, d, b, c, d elements</span>
<span class="ruby-identifier">doc</span>.<span class="ruby-identifier">root</span>.<span class="ruby-identifier">elements</span>.<span class="ruby-identifier">each</span>(<span class="ruby-string">'b'</span>) {<span class="ruby-operator">|</span><span class="ruby-identifier">e</span><span class="ruby-operator">|</span><span class="ruby-identifier">p</span> <span class="ruby-identifier">e</span>} <span class="ruby-comment">#-> Yields b, b elements</span>
<span class="ruby-identifier">doc</span>.<span class="ruby-identifier">root</span>.<span class="ruby-identifier">elements</span>.<span class="ruby-identifier">each</span>(<span class="ruby-string">'child::node()'</span>) {<span class="ruby-operator">|</span><span class="ruby-identifier">e</span><span class="ruby-operator">|</span><span class="ruby-identifier">p</span> <span class="ruby-identifier">e</span>}
<span class="ruby-comment">#-> Yields <b/>, <c/>, <d/>, <b/>, <c/>, <d/></span>
<span class="ruby-constant">XPath</span>.<span class="ruby-identifier">each</span>(<span class="ruby-identifier">doc</span>.<span class="ruby-identifier">root</span>, <span class="ruby-string">'child::node()'</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
<span class="ruby-comment">#-> Yields <b/>, <c/>, <d/>, sean, <b/>, <c/>, <d/></span>
</pre>
<div class="method-source-code" id="each-source">
<pre><span class="ruby-comment"># File lib/rexml/element.rb, line 926</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">each</span>( <span class="ruby-identifier">xpath</span>=<span class="ruby-keyword">nil</span> )
<span class="ruby-constant">XPath</span><span class="ruby-operator">::</span><span class="ruby-identifier">each</span>( <span class="ruby-ivar">@element</span>, <span class="ruby-identifier">xpath</span> ) {<span class="ruby-operator">|</span><span class="ruby-identifier">e</span><span class="ruby-operator">|</span> <span class="ruby-keyword">yield</span> <span class="ruby-identifier">e</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">e</span>.<span class="ruby-identifier">kind_of?</span> <span class="ruby-constant">Element</span> }
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-empty-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">empty?</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns <code>true</code> if there are no <code>Element</code> children, <code>false</code> otherwise</p>
<div class="method-source-code" id="empty-3F-source">
<pre><span class="ruby-comment"># File lib/rexml/element.rb, line 833</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">empty?</span>
<span class="ruby-ivar">@element</span>.<span class="ruby-identifier">find</span>{ <span class="ruby-operator">|</span><span class="ruby-identifier">child</span><span class="ruby-operator">|</span> <span class="ruby-identifier">child</span>.<span class="ruby-identifier">kind_of?</span> <span class="ruby-constant">Element</span>}.<span class="ruby-identifier">nil?</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-index" class="method-detail ">
<div class="method-heading">
<span class="method-name">index</span><span
class="method-args">(element)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns the index of the supplied child (starting at 1), or -1 if the element is not a child</p>
<dl class="rdoc-list note-list"><dt>element
<dd>
<p>an <code>Element</code> child</p>
</dd></dl>
<div class="method-source-code" id="index-source">
<pre><span class="ruby-comment"># File lib/rexml/element.rb, line 840</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">index</span> <span class="ruby-identifier">element</span>
<span class="ruby-identifier">rv</span> = <span class="ruby-value">0</span>
<span class="ruby-identifier">found</span> = <span class="ruby-ivar">@element</span>.<span class="ruby-identifier">find</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">child</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">child</span>.<span class="ruby-identifier">kind_of?</span> <span class="ruby-constant">Element</span> <span class="ruby-keyword">and</span>
(<span class="ruby-identifier">rv</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span>) <span class="ruby-keyword">and</span>
<span class="ruby-identifier">child</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">element</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">return</span> <span class="ruby-identifier">rv</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">found</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">element</span>
<span class="ruby-keyword">return</span> <span class="ruby-value">-1</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-inject" class="method-detail ">
<div class="method-heading">
<span class="method-name">inject</span><span
class="method-args">( xpath=nil, initial=nil ) { |initial, e| ... }</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="inject-source">
<pre><span class="ruby-comment"># File lib/rexml/element.rb, line 938</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">inject</span>( <span class="ruby-identifier">xpath</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-identifier">initial</span>=<span class="ruby-keyword">nil</span> )
<span class="ruby-identifier">first</span> = <span class="ruby-keyword">true</span>
<span class="ruby-constant">XPath</span><span class="ruby-operator">::</span><span class="ruby-identifier">each</span>( <span class="ruby-ivar">@element</span>, <span class="ruby-identifier">xpath</span> ) {<span class="ruby-operator">|</span><span class="ruby-identifier">e</span><span class="ruby-operator">|</span>
<span class="ruby-keyword">if</span> (<span class="ruby-identifier">e</span>.<span class="ruby-identifier">kind_of?</span> <span class="ruby-constant">Element</span>)
<span class="ruby-keyword">if</span> (<span class="ruby-identifier">first</span> <span class="ruby-keyword">and</span> <span class="ruby-identifier">initial</span> <span class="ruby-operator">==</span> <span class="ruby-keyword">nil</span>)
<span class="ruby-identifier">initial</span> = <span class="ruby-identifier">e</span>
<span class="ruby-identifier">first</span> = <span class="ruby-keyword">false</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">initial</span> = <span class="ruby-keyword">yield</span>( <span class="ruby-identifier">initial</span>, <span class="ruby-identifier">e</span> ) <span class="ruby-keyword">if</span> <span class="ruby-identifier">e</span>.<span class="ruby-identifier">kind_of?</span> <span class="ruby-constant">Element</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
}
<span class="ruby-identifier">initial</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-size" class="method-detail ">
<div class="method-heading">
<span class="method-name">size</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns the number of <code>Element</code> children of the parent object.</p>
<pre class="ruby"><span class="ruby-identifier">doc</span> = <span class="ruby-constant">Document</span>.<span class="ruby-identifier">new</span> <span class="ruby-string">'<a>sean<b/>elliott<b/>russell<b/></a>'</span>
<span class="ruby-identifier">doc</span>.<span class="ruby-identifier">root</span>.<span class="ruby-identifier">size</span> <span class="ruby-comment">#-> 6, 3 element and 3 text nodes</span>
<span class="ruby-identifier">doc</span>.<span class="ruby-identifier">root</span>.<span class="ruby-identifier">elements</span>.<span class="ruby-identifier">size</span> <span class="ruby-comment">#-> 3</span>
</pre>
<div class="method-source-code" id="size-source">
<pre><span class="ruby-comment"># File lib/rexml/element.rb, line 957</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">size</span>
<span class="ruby-identifier">count</span> = <span class="ruby-value">0</span>
<span class="ruby-ivar">@element</span>.<span class="ruby-identifier">each</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">child</span><span class="ruby-operator">|</span> <span class="ruby-identifier">count</span><span class="ruby-operator">+=</span><span class="ruby-value">1</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">child</span>.<span class="ruby-identifier">kind_of?</span> <span class="ruby-constant">Element</span> }
<span class="ruby-identifier">count</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-to_a" class="method-detail ">
<div class="method-heading">
<span class="method-name">to_a</span><span
class="method-args">( xpath=nil )</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns an <a href="../Array.html"><code>Array</code></a> of <a href="Element.html"><code>Element</code></a> children. An <a href="XPath.html"><code>XPath</code></a> may be supplied to filter the children. Only <a href="Element.html"><code>Element</code></a> children are returned, even if the supplied <a href="XPath.html"><code>XPath</code></a> matches non-Element children.</p>
<pre class="ruby"><span class="ruby-identifier">doc</span> = <span class="ruby-constant">Document</span>.<span class="ruby-identifier">new</span> <span class="ruby-string">'<a>sean<b/>elliott<c/></a>'</span>
<span class="ruby-identifier">doc</span>.<span class="ruby-identifier">root</span>.<span class="ruby-identifier">elements</span>.<span class="ruby-identifier">to_a</span> <span class="ruby-comment">#-> [ <b/>, <c/> ]</span>
<span class="ruby-identifier">doc</span>.<span class="ruby-identifier">root</span>.<span class="ruby-identifier">elements</span>.<span class="ruby-identifier">to_a</span>(<span class="ruby-string">"child::node()"</span>) <span class="ruby-comment">#-> [ <b/>, <c/> ]</span>
<span class="ruby-constant">XPath</span>.<span class="ruby-identifier">match</span>(<span class="ruby-identifier">doc</span>.<span class="ruby-identifier">root</span>, <span class="ruby-string">"child::node()"</span>) <span class="ruby-comment">#-> [ sean, <b/>, elliott, <c/> ]</span>
</pre>
<div class="method-source-code" id="to_a-source">
<pre><span class="ruby-comment"># File lib/rexml/element.rb, line 970</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">to_a</span>( <span class="ruby-identifier">xpath</span>=<span class="ruby-keyword">nil</span> )
<span class="ruby-identifier">rv</span> = <span class="ruby-constant">XPath</span>.<span class="ruby-identifier">match</span>( <span class="ruby-ivar">@element</span>, <span class="ruby-identifier">xpath</span> )
<span class="ruby-keyword">return</span> <span class="ruby-identifier">rv</span>.<span class="ruby-identifier">find_all</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">e</span><span class="ruby-operator">|</span> <span class="ruby-identifier">e</span>.<span class="ruby-identifier">kind_of?</span> <span class="ruby-constant">Element</span>} <span class="ruby-keyword">if</span> <span class="ruby-identifier">xpath</span>
<span class="ruby-identifier">rv</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
<section id="private-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Private Instance Methods</h3>
</header>
<div id="method-i-literalize" class="method-detail ">
<div class="method-heading">
<span class="method-name">literalize</span><span
class="method-args">(name)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Private helper class. Removes quotes from quoted strings</p>
<div class="method-source-code" id="literalize-source">
<pre><span class="ruby-comment"># File lib/rexml/element.rb, line 978</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">literalize</span> <span class="ruby-identifier">name</span>
<span class="ruby-identifier">name</span> = <span class="ruby-identifier">name</span>[<span class="ruby-value">1</span><span class="ruby-operator">..</span><span class="ruby-value">-2</span>] <span class="ruby-keyword">if</span> <span class="ruby-identifier">name</span>[<span class="ruby-value">0</span>] <span class="ruby-operator">==</span> <span class="ruby-value">?'</span> <span class="ruby-keyword">or</span> <span class="ruby-identifier">name</span>[<span class="ruby-value">0</span>] <span class="ruby-operator">==</span> <span class="ruby-value">?"</span> <span class="ruby-comment">#'</span>
<span class="ruby-identifier">name</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
</section>
</main>
<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.1.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>