File: C:/Ruby27-x64/share/doc/ruby/html/REXML/Namespace.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>module REXML::Namespace - 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="module">
<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="includes-section" class="nav-section">
<h3>Included Modules</h3>
<ul class="link-list">
<li><a class="include" href="XMLTokens.html">REXML::XMLTokens</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-i-fully_expanded_name">#fully_expanded_name</a>
<li ><a href="#method-i-has_name-3F">#has_name?</a>
<li ><a href="#method-i-name-3D">#name=</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="module-REXML::Namespace">
<h1 id="module-REXML::Namespace" class="module">
module REXML::Namespace
</h1>
<section class="description">
<p>Adds named attributes to an object.</p>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section class="constants-list">
<header>
<h3>Constants</h3>
</header>
<dl>
<dt id="NAMESPLIT">NAMESPLIT
<dd>
</dl>
</section>
<section class="attribute-method-details" class="method-section">
<header>
<h3>Attributes</h3>
</header>
<div id="attribute-i-expanded_name" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">expanded_name</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
<p>The name of the object, valid if set</p>
</div>
</div>
<div id="attribute-i-local_name" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">local_name</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
<p>The name of the object, valid if set</p>
</div>
</div>
<div id="attribute-i-name" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">name</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
<p>The name of the object, valid if set</p>
</div>
</div>
<div id="attribute-i-prefix" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">prefix</span><span
class="attribute-access-type">[RW]</span>
</div>
<div class="method-description">
<p>The expanded name of the object, valid if name is set</p>
</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-fully_expanded_name" class="method-detail ">
<div class="method-heading">
<span class="method-name">fully_expanded_name</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Fully expand the name, even if the prefix wasn't specified in the source file.</p>
<div class="method-source-code" id="fully_expanded_name-source">
<pre><span class="ruby-comment"># File lib/rexml/namespace.rb, line 53</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">fully_expanded_name</span>
<span class="ruby-identifier">ns</span> = <span class="ruby-identifier">prefix</span>
<span class="ruby-keyword">return</span> <span class="ruby-node">"#{ns}:#@name"</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">ns</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span>
<span class="ruby-keyword">return</span> <span class="ruby-ivar">@name</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-has_name-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">has_name?</span><span
class="method-args">( other, ns=nil )</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Compares names optionally WITH namespaces</p>
<div class="method-source-code" id="has_name-3F-source">
<pre><span class="ruby-comment"># File lib/rexml/namespace.rb, line 39</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">has_name?</span>( <span class="ruby-identifier">other</span>, <span class="ruby-identifier">ns</span>=<span class="ruby-keyword">nil</span> )
<span class="ruby-keyword">if</span> <span class="ruby-identifier">ns</span>
<span class="ruby-keyword">return</span> (<span class="ruby-identifier">namespace</span>() <span class="ruby-operator">==</span> <span class="ruby-identifier">ns</span> <span class="ruby-keyword">and</span> <span class="ruby-identifier">name</span>() <span class="ruby-operator">==</span> <span class="ruby-identifier">other</span>)
<span class="ruby-keyword">elsif</span> <span class="ruby-identifier">other</span>.<span class="ruby-identifier">include?</span> <span class="ruby-string">":"</span>
<span class="ruby-keyword">return</span> <span class="ruby-identifier">fully_expanded_name</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">other</span>
<span class="ruby-keyword">else</span>
<span class="ruby-keyword">return</span> <span class="ruby-identifier">name</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">other</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-name-3D" class="method-detail ">
<div class="method-heading">
<span class="method-name">name=</span><span
class="method-args">( name )</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Sets the name and the expanded name</p>
<div class="method-source-code" id="name-3D-source">
<pre><span class="ruby-comment"># File lib/rexml/namespace.rb, line 16</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">name=</span>( <span class="ruby-identifier">name</span> )
<span class="ruby-ivar">@expanded_name</span> = <span class="ruby-identifier">name</span>
<span class="ruby-keyword">case</span> <span class="ruby-identifier">name</span>
<span class="ruby-keyword">when</span> <span class="ruby-constant">NAMESPLIT</span>
<span class="ruby-keyword">if</span> <span class="ruby-node">$1</span>
<span class="ruby-ivar">@prefix</span> = <span class="ruby-node">$1</span>
<span class="ruby-keyword">else</span>
<span class="ruby-ivar">@prefix</span> = <span class="ruby-string">""</span>
<span class="ruby-ivar">@namespace</span> = <span class="ruby-string">""</span>
<span class="ruby-keyword">end</span>
<span class="ruby-ivar">@name</span> = <span class="ruby-node">$2</span>
<span class="ruby-keyword">when</span> <span class="ruby-string">""</span>
<span class="ruby-ivar">@prefix</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-ivar">@namespace</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-ivar">@name</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">message</span> = <span class="ruby-string">"name must be \#{PREFIX}:\#{LOCAL_NAME} or \#{LOCAL_NAME}: "</span>
<span class="ruby-identifier">message</span> <span class="ruby-operator">+=</span> <span class="ruby-node">"<#{name.inspect}>"</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-identifier">message</span>
<span class="ruby-keyword">end</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>