File: C:/Ruby27-x64/share/doc/ruby/html/REXML/AttlistDecl.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class REXML::AttlistDecl - 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">Child
</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 class="calls-super" ><a href="#method-c-new">::new</a>
<li ><a href="#method-i-5B-5D">#[]</a>
<li ><a href="#method-i-each">#each</a>
<li ><a href="#method-i-include-3F">#include?</a>
<li ><a href="#method-i-node_type">#node_type</a>
<li ><a href="#method-i-write">#write</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-REXML::AttlistDecl">
<h1 id="class-REXML::AttlistDecl" class="class">
class REXML::AttlistDecl
</h1>
<section class="description">
<p>This class needs:</p>
<ul><li>
<p>Documentation</p>
</li><li>
<p>Work! Not all types of attlists are intelligently parsed, so we just</p>
</li></ul>
<p>spew back out what we get in. This works, but it would be better if we formatted the output ourselves.</p>
<p>AttlistDecls provide <strong>just</strong> enough support to allow namespace declarations. If you need some sort of generalized support, or have an interesting idea about how to map the hideous, terrible design of <a href="DTD.html"><code>DTD</code></a> AttlistDecls onto an intuitive Ruby interface, let me know. I'm desperate for anything to make DTDs more palateable.</p>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section class="attribute-method-details" class="method-section">
<header>
<h3>Attributes</h3>
</header>
<div id="attribute-i-element_name" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">element_name</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
<p>What is this? Got me.</p>
</div>
</div>
</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">(source)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Create an <a href="AttlistDecl.html"><code>AttlistDecl</code></a>, pulling the information from a <a href="Source.html"><code>Source</code></a>. Notice that this isn't very convenient; to create an <a href="AttlistDecl.html"><code>AttlistDecl</code></a>, you basically have to format it yourself, and then have the initializer parse it. Sorry, but for the foreseeable future, <a href="DTD.html"><code>DTD</code></a> support in <a href="../REXML.html"><code>REXML</code></a> is pretty weak on convenience. Have I mentioned how much I hate DTDs?</p>
<div class="method-calls-super">
Calls superclass method
</div>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/rexml/attlistdecl.rb, line 29</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">source</span>)
<span class="ruby-keyword">super</span>()
<span class="ruby-keyword">if</span> (<span class="ruby-identifier">source</span>.<span class="ruby-identifier">kind_of?</span> <span class="ruby-constant">Array</span>)
<span class="ruby-ivar">@element_name</span>, <span class="ruby-ivar">@pairs</span>, <span class="ruby-ivar">@contents</span> = <span class="ruby-operator">*</span><span class="ruby-identifier">source</span>
<span class="ruby-keyword">end</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">(key)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Access the attlist attribute/value pairs.</p>
<pre class="ruby"><span class="ruby-identifier">value</span> = <span class="ruby-identifier">attlist_decl</span>[ <span class="ruby-identifier">attribute_name</span> ]
</pre>
<div class="method-source-code" id="5B-5D-source">
<pre><span class="ruby-comment"># File lib/rexml/attlistdecl.rb, line 38</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">[]</span>(<span class="ruby-identifier">key</span>)
<span class="ruby-ivar">@pairs</span>[<span class="ruby-identifier">key</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">(&block)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Iterate over the key/value pairs:</p>
<pre>attlist_decl.each { |attribute_name, attribute_value| ... }</pre>
<div class="method-source-code" id="each-source">
<pre><span class="ruby-comment"># File lib/rexml/attlistdecl.rb, line 50</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">each</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
<span class="ruby-ivar">@pairs</span>.<span class="ruby-identifier">each</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-include-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">include?</span><span
class="method-args">(key)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Whether an attlist declaration includes the given attribute definition</p>
<pre>if attlist_decl.include? "xmlns:foobar"</pre>
<div class="method-source-code" id="include-3F-source">
<pre><span class="ruby-comment"># File lib/rexml/attlistdecl.rb, line 44</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">include?</span>(<span class="ruby-identifier">key</span>)
<span class="ruby-ivar">@pairs</span>.<span class="ruby-identifier">keys</span>.<span class="ruby-identifier">include?</span> <span class="ruby-identifier">key</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-node_type" class="method-detail ">
<div class="method-heading">
<span class="method-name">node_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="node_type-source">
<pre><span class="ruby-comment"># File lib/rexml/attlistdecl.rb, line 59</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">node_type</span>
<span class="ruby-value">:attlistdecl</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-write" class="method-detail ">
<div class="method-heading">
<span class="method-name">write</span><span
class="method-args">(out, indent=-1)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Write out exactly what we got in.</p>
<div class="method-source-code" id="write-source">
<pre><span class="ruby-comment"># File lib/rexml/attlistdecl.rb, line 55</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">write</span> <span class="ruby-identifier">out</span>, <span class="ruby-identifier">indent</span>=<span class="ruby-value">-1</span>
<span class="ruby-identifier">out</span> <span class="ruby-operator"><<</span> <span class="ruby-ivar">@contents</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>