File: C:/Ruby27-x64/share/doc/ruby/html/REXML/Parsers/PullEvent.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class REXML::Parsers::PullEvent - 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>
<!-- 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-5B-5D">#[]</a>
<li ><a href="#method-i-attlistdecl-3F">#attlistdecl?</a>
<li ><a href="#method-i-cdata-3F">#cdata?</a>
<li ><a href="#method-i-comment-3F">#comment?</a>
<li ><a href="#method-i-doctype-3F">#doctype?</a>
<li ><a href="#method-i-elementdecl-3F">#elementdecl?</a>
<li ><a href="#method-i-end_element-3F">#end_element?</a>
<li ><a href="#method-i-entity-3F">#entity?</a>
<li ><a href="#method-i-entitydecl-3F">#entitydecl?</a>
<li ><a href="#method-i-error-3F">#error?</a>
<li ><a href="#method-i-event_type">#event_type</a>
<li ><a href="#method-i-inspect">#inspect</a>
<li ><a href="#method-i-instruction-3F">#instruction?</a>
<li ><a href="#method-i-notationdecl-3F">#notationdecl?</a>
<li ><a href="#method-i-start_element-3F">#start_element?</a>
<li ><a href="#method-i-text-3F">#text?</a>
<li ><a href="#method-i-xmldecl-3F">#xmldecl?</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-REXML::Parsers::PullEvent">
<h1 id="class-REXML::Parsers::PullEvent" class="class">
class REXML::Parsers::PullEvent
</h1>
<section class="description">
<p>A parsing event. The contents of the event are accessed as an +Array?, and the type is given either by the …? methods, or by accessing the <code>type</code> accessor. The contents of this object vary from event to event, but are identical to the arguments passed to +StreamListener+s for each event.</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">(arg)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>The type of this event. Will be one of :tag_start, :tag_end, :text, :processing_instruction, :comment, :doctype, :attlistdecl, :entitydecl, :notationdecl, :entity, :cdata, :xmldecl, or :error.</p>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/rexml/parsers/pullparser.rb, line 95</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">arg</span>)
<span class="ruby-ivar">@contents</span> = <span class="ruby-identifier">arg</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-5B-5D" class="method-detail ">
<div class="method-heading">
<span class="method-name">[]</span><span
class="method-args">( start, endd=nil)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="5B-5D-source">
<pre><span class="ruby-comment"># File lib/rexml/parsers/pullparser.rb, line 99</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">[]</span>( <span class="ruby-identifier">start</span>, <span class="ruby-identifier">endd</span>=<span class="ruby-keyword">nil</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">start</span>.<span class="ruby-identifier">kind_of?</span> <span class="ruby-constant">Range</span>
<span class="ruby-ivar">@contents</span>.<span class="ruby-identifier">slice</span>( <span class="ruby-identifier">start</span>.<span class="ruby-identifier">begin</span><span class="ruby-value">+1</span> <span class="ruby-operator">..</span> <span class="ruby-identifier">start</span>.<span class="ruby-identifier">end</span> )
<span class="ruby-keyword">elsif</span> <span class="ruby-identifier">start</span>.<span class="ruby-identifier">kind_of?</span> <span class="ruby-constant">Numeric</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">endd</span>.<span class="ruby-identifier">nil?</span>
<span class="ruby-ivar">@contents</span>.<span class="ruby-identifier">slice</span>( <span class="ruby-identifier">start</span><span class="ruby-value">+1</span> )
<span class="ruby-keyword">else</span>
<span class="ruby-ivar">@contents</span>.<span class="ruby-identifier">slice</span>( <span class="ruby-identifier">start</span><span class="ruby-value">+1</span>, <span class="ruby-identifier">endd</span> )
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">raise</span> <span class="ruby-node">"Illegal argument #{start.inspect} (#{start.class})"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-attlistdecl-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">attlistdecl?</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Content: [ <a href="../../String.html"><code>String</code></a> text ]</p>
<div class="method-source-code" id="attlistdecl-3F-source">
<pre><span class="ruby-comment"># File lib/rexml/parsers/pullparser.rb, line 148</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">attlistdecl?</span>
<span class="ruby-ivar">@contents</span>[<span class="ruby-value">0</span>] <span class="ruby-operator">==</span> <span class="ruby-value">:attlistdecl</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-cdata-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">cdata?</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Content: [ <a href="../../String.html"><code>String</code></a> text ]</p>
<div class="method-source-code" id="cdata-3F-source">
<pre><span class="ruby-comment"># File lib/rexml/parsers/pullparser.rb, line 179</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">cdata?</span>
<span class="ruby-ivar">@contents</span>[<span class="ruby-value">0</span>] <span class="ruby-operator">==</span> <span class="ruby-value">:cdata</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-comment-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">comment?</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Content: [ <a href="../../String.html"><code>String</code></a> text ]</p>
<div class="method-source-code" id="comment-3F-source">
<pre><span class="ruby-comment"># File lib/rexml/parsers/pullparser.rb, line 138</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">comment?</span>
<span class="ruby-ivar">@contents</span>[<span class="ruby-value">0</span>] <span class="ruby-operator">==</span> <span class="ruby-value">:comment</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-doctype-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">doctype?</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Content: [ <a href="../../String.html"><code>String</code></a> name, <a href="../../String.html"><code>String</code></a> pub_sys, <a href="../../String.html"><code>String</code></a> long_name, <a href="../../String.html"><code>String</code></a> uri ]</p>
<div class="method-source-code" id="doctype-3F-source">
<pre><span class="ruby-comment"># File lib/rexml/parsers/pullparser.rb, line 143</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">doctype?</span>
<span class="ruby-ivar">@contents</span>[<span class="ruby-value">0</span>] <span class="ruby-operator">==</span> <span class="ruby-value">:start_doctype</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-elementdecl-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">elementdecl?</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Content: [ <a href="../../String.html"><code>String</code></a> text ]</p>
<div class="method-source-code" id="elementdecl-3F-source">
<pre><span class="ruby-comment"># File lib/rexml/parsers/pullparser.rb, line 153</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">elementdecl?</span>
<span class="ruby-ivar">@contents</span>[<span class="ruby-value">0</span>] <span class="ruby-operator">==</span> <span class="ruby-value">:elementdecl</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-end_element-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">end_element?</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Content: [ <a href="../../String.html"><code>String</code></a> tag_name ]</p>
<div class="method-source-code" id="end_element-3F-source">
<pre><span class="ruby-comment"># File lib/rexml/parsers/pullparser.rb, line 123</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">end_element?</span>
<span class="ruby-ivar">@contents</span>[<span class="ruby-value">0</span>] <span class="ruby-operator">==</span> <span class="ruby-value">:end_element</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-entity-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">entity?</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Content: [ <a href="../../String.html"><code>String</code></a> text ]</p>
<div class="method-source-code" id="entity-3F-source">
<pre><span class="ruby-comment"># File lib/rexml/parsers/pullparser.rb, line 174</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">entity?</span>
<span class="ruby-ivar">@contents</span>[<span class="ruby-value">0</span>] <span class="ruby-operator">==</span> <span class="ruby-value">:entity</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-entitydecl-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">entitydecl?</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Due to the wonders of DTDs, an entity declaration can be just about anything. There's no way to normalize it; you'll have to interpret the content yourself. However, the following is true:</p>
<ul><li>
<p>If the entity declaration is an internal entity:</p>
<dl class="rdoc-list label-list"><dt> <a href="../../String.html"><code>String</code></a> name, <a href="../../String.html"><code>String</code></a> value
<dd></dd></dl>
</li></ul>
<p>Content: [ <a href="../../String.html"><code>String</code></a> text ]</p>
<div class="method-source-code" id="entitydecl-3F-source">
<pre><span class="ruby-comment"># File lib/rexml/parsers/pullparser.rb, line 164</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">entitydecl?</span>
<span class="ruby-ivar">@contents</span>[<span class="ruby-value">0</span>] <span class="ruby-operator">==</span> <span class="ruby-value">:entitydecl</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-error-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">error?</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="error-3F-source">
<pre><span class="ruby-comment"># File lib/rexml/parsers/pullparser.rb, line 188</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">error?</span>
<span class="ruby-ivar">@contents</span>[<span class="ruby-value">0</span>] <span class="ruby-operator">==</span> <span class="ruby-value">:error</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-event_type" class="method-detail ">
<div class="method-heading">
<span class="method-name">event_type</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="event_type-source">
<pre><span class="ruby-comment"># File lib/rexml/parsers/pullparser.rb, line 113</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">event_type</span>
<span class="ruby-ivar">@contents</span>[<span class="ruby-value">0</span>]
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-inspect" class="method-detail ">
<div class="method-heading">
<span class="method-name">inspect</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="inspect-source">
<pre><span class="ruby-comment"># File lib/rexml/parsers/pullparser.rb, line 192</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">inspect</span>
<span class="ruby-ivar">@contents</span>[<span class="ruby-value">0</span>].<span class="ruby-identifier">to_s</span> <span class="ruby-operator">+</span> <span class="ruby-string">": "</span> <span class="ruby-operator">+</span> <span class="ruby-ivar">@contents</span>[<span class="ruby-value">1</span><span class="ruby-operator">..</span><span class="ruby-value">-1</span>].<span class="ruby-identifier">inspect</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-instruction-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">instruction?</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Content: [ <a href="../../String.html"><code>String</code></a> text ]</p>
<div class="method-source-code" id="instruction-3F-source">
<pre><span class="ruby-comment"># File lib/rexml/parsers/pullparser.rb, line 133</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">instruction?</span>
<span class="ruby-ivar">@contents</span>[<span class="ruby-value">0</span>] <span class="ruby-operator">==</span> <span class="ruby-value">:processing_instruction</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-notationdecl-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">notationdecl?</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Content: [ <a href="../../String.html"><code>String</code></a> text ]</p>
<div class="method-source-code" id="notationdecl-3F-source">
<pre><span class="ruby-comment"># File lib/rexml/parsers/pullparser.rb, line 169</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">notationdecl?</span>
<span class="ruby-ivar">@contents</span>[<span class="ruby-value">0</span>] <span class="ruby-operator">==</span> <span class="ruby-value">:notationdecl</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-start_element-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">start_element?</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Content: [ <a href="../../String.html"><code>String</code></a> tag_name, <a href="../../Hash.html"><code>Hash</code></a> attributes ]</p>
<div class="method-source-code" id="start_element-3F-source">
<pre><span class="ruby-comment"># File lib/rexml/parsers/pullparser.rb, line 118</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">start_element?</span>
<span class="ruby-ivar">@contents</span>[<span class="ruby-value">0</span>] <span class="ruby-operator">==</span> <span class="ruby-value">:start_element</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-text-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">text?</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Content: [ <a href="../../String.html"><code>String</code></a> raw_text, <a href="../../String.html"><code>String</code></a> unnormalized_text ]</p>
<div class="method-source-code" id="text-3F-source">
<pre><span class="ruby-comment"># File lib/rexml/parsers/pullparser.rb, line 128</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">text?</span>
<span class="ruby-ivar">@contents</span>[<span class="ruby-value">0</span>] <span class="ruby-operator">==</span> <span class="ruby-value">:text</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-xmldecl-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">xmldecl?</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Content: [ <a href="../../String.html"><code>String</code></a> version, <a href="../../String.html"><code>String</code></a> encoding, <a href="../../String.html"><code>String</code></a> standalone ]</p>
<div class="method-source-code" id="xmldecl-3F-source">
<pre><span class="ruby-comment"># File lib/rexml/parsers/pullparser.rb, line 184</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">xmldecl?</span>
<span class="ruby-ivar">@contents</span>[<span class="ruby-value">0</span>] <span class="ruby-operator">==</span> <span class="ruby-value">:xmldecl</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>