File: C:/Ruby27-x64/share/doc/ruby/html/Gem/Resolver/RequirementList.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Gem::Resolver::RequirementList - 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-add">#add</a>
<li ><a href="#method-i-empty-3F">#empty?</a>
<li ><a href="#method-i-next5">#next5</a>
<li ><a href="#method-i-remove">#remove</a>
<li ><a href="#method-i-size">#size</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Gem::Resolver::RequirementList">
<h1 id="class-Gem::Resolver::RequirementList" class="class">
class Gem::Resolver::RequirementList
</h1>
<section class="description">
<p>The <a href="RequirementList.html"><code>RequirementList</code></a> is used to hold the requirements being considered while resolving a set of gems.</p>
<p>The <a href="RequirementList.html"><code>RequirementList</code></a> acts like a queue where the oldest items are removed first.</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">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Creates a new <a href="RequirementList.html"><code>RequirementList</code></a>.</p>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/rubygems/resolver/requirement_list.rb, line 16</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>
<span class="ruby-ivar">@exact</span> = []
<span class="ruby-ivar">@list</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-add" class="method-detail ">
<div class="method-heading">
<span class="method-name">add</span><span
class="method-args">(req)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Adds Resolver::DependencyRequest <code>req</code> to this requirements list.</p>
<div class="method-source-code" id="add-source">
<pre><span class="ruby-comment"># File lib/rubygems/resolver/requirement_list.rb, line 29</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">add</span>(<span class="ruby-identifier">req</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">req</span>.<span class="ruby-identifier">requirement</span>.<span class="ruby-identifier">exact?</span>
<span class="ruby-ivar">@exact</span>.<span class="ruby-identifier">push</span> <span class="ruby-identifier">req</span>
<span class="ruby-keyword">else</span>
<span class="ruby-ivar">@list</span>.<span class="ruby-identifier">push</span> <span class="ruby-identifier">req</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">req</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>Is the list empty?</p>
<div class="method-source-code" id="empty-3F-source">
<pre><span class="ruby-comment"># File lib/rubygems/resolver/requirement_list.rb, line 63</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">empty?</span>
<span class="ruby-ivar">@exact</span>.<span class="ruby-identifier">empty?</span> <span class="ruby-operator">&&</span> <span class="ruby-ivar">@list</span>.<span class="ruby-identifier">empty?</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-next5" class="method-detail ">
<div class="method-heading">
<span class="method-name">next5</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns the oldest five entries from the list.</p>
<div class="method-source-code" id="next5-source">
<pre><span class="ruby-comment"># File lib/rubygems/resolver/requirement_list.rb, line 78</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">next5</span>
<span class="ruby-identifier">x</span> = <span class="ruby-ivar">@exact</span>[<span class="ruby-value">0</span>,<span class="ruby-value">5</span>]
<span class="ruby-identifier">x</span> <span class="ruby-operator">+</span> <span class="ruby-ivar">@list</span>[<span class="ruby-value">0</span>,<span class="ruby-value">5</span> <span class="ruby-operator">-</span> <span class="ruby-identifier">x</span>.<span class="ruby-identifier">size</span>]
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-remove" class="method-detail ">
<div class="method-heading">
<span class="method-name">remove</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Remove the oldest DependencyRequest from the list.</p>
<div class="method-source-code" id="remove-source">
<pre><span class="ruby-comment"># File lib/rubygems/resolver/requirement_list.rb, line 70</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">remove</span>
<span class="ruby-keyword">return</span> <span class="ruby-ivar">@exact</span>.<span class="ruby-identifier">shift</span> <span class="ruby-keyword">unless</span> <span class="ruby-ivar">@exact</span>.<span class="ruby-identifier">empty?</span>
<span class="ruby-ivar">@list</span>.<span class="ruby-identifier">shift</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>How many elements are in the list</p>
<div class="method-source-code" id="size-source">
<pre><span class="ruby-comment"># File lib/rubygems/resolver/requirement_list.rb, line 56</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">size</span>
<span class="ruby-ivar">@exact</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">+</span> <span class="ruby-ivar">@list</span>.<span class="ruby-identifier">size</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>