doc/classes/Git/Branches.html

   1 <?xml version="1.0" encoding="iso-8859-1"?>
   2 <!DOCTYPE html
   3      PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
   4      "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   5
   6 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   7 <head>
   8   <title>Class: Git::Branches</title>
   9   <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
  10   <meta http-equiv="Content-Script-Type" content="text/javascript" />
  11   <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
  12   <script type="text/javascript">
  13   // <![CDATA[
  14
  15   function popupCode( url ) {
  16     window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
  17   }
  18
  19   function toggleCode( id ) {
  20     if ( document.getElementById )
  21       elem = document.getElementById( id );
  22     else if ( document.all )
  23       elem = eval( "document.all." + id );
  24     else
  25       return false;
  26
  27     elemStyle = elem.style;
  28
  29     if ( elemStyle.display != "block" ) {
  30       elemStyle.display = "block"
  31     } else {
  32       elemStyle.display = "none"
  33     }
  34
  35     return true;
  36   }
  37
  38   // Make codeblocks hidden by default
  39   document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
  40
  41   // ]]>
  42   </script>
  43
  44 </head>
  45 <body>
  46
  47
  48
  49     <div id="classHeader">
  50         <table class="header-table">
  51         <tr class="top-aligned-row">
  52           <td><strong>Class</strong></td>
  53           <td class="class-name-in-header">Git::Branches</td>
  54         </tr>
  55         <tr class="top-aligned-row">
  56             <td><strong>In:</strong></td>
  57             <td>
  58                 <a href="../../files/lib/git/branches_rb.html">
  59                 lib/git/branches.rb
  60                 </a>
  61         <br />
  62             </td>
  63         </tr>
  64
  65         <tr class="top-aligned-row">
  66             <td><strong>Parent:</strong></td>
  67             <td>
  68                 <a href="Object.html">
  69                 Object
  70                </a>
  71             </td>
  72         </tr>
  73         </table>
  74     </div>
  75   <!-- banner header -->
  76
  77   <div id="bodyContent">
  78
  79
  80
  81   <div id="contextContent">
  82
  83     <div id="description">
  84       <p>
  85 object that holds all the available branches
  86 </p>
  87
  88     </div>
  89
  90
  91    </div>
  92
  93     <div id="method-list">
  94       <h3 class="section-bar">Methods</h3>
  95
  96       <div class="name-list">
  97       <a href="#M000076">[]</a>&nbsp;&nbsp;
  98       <a href="#M000075">each</a>&nbsp;&nbsp;
  99       <a href="#M000072">local</a>&nbsp;&nbsp;
 100       <a href="#M000071">new</a>&nbsp;&nbsp;
 101       <a href="#M000073">remote</a>&nbsp;&nbsp;
 102       <a href="#M000074">size</a>&nbsp;&nbsp;
 103       </div>
 104     </div>
 105
 106   </div>
 107
 108
 109     <!-- if includes -->
 110     <div id="includes">
 111       <h3 class="section-bar">Included Modules</h3>
 112
 113       <div id="includes-list">
 114         <span class="include-name">Enumerable</span>
 115       </div>
 116     </div>
 117
 118     <div id="section">
 119
 120
 121
 122
 123
 124
 125
 126
 127     <!-- if method_list -->
 128     <div id="methods">
 129       <h3 class="section-bar">Public Class methods</h3>
 130
 131       <div id="method-M000071" class="method-detail">
 132         <a name="M000071"></a>
 133
 134         <div class="method-heading">
 135           <a href="#M000071" class="method-signature">
 136           <span class="method-name">new</span><span class="method-args">(base)</span>
 137           </a>
 138         </div>
 139
 140         <div class="method-description">
 141           <p><a class="source-toggle" href="#"
 142             onclick="toggleCode('M000071-source');return false;">[Source]</a></p>
 143           <div class="method-source-code" id="M000071-source">
 144 <pre>
 145 <span class="ruby-comment cmt"># File lib/git/branches.rb, line 10</span>
 146     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">base</span>)
 147       <span class="ruby-ivar">@branches</span> = {}
 148
 149       <span class="ruby-ivar">@base</span> = <span class="ruby-identifier">base</span>
 150
 151       <span class="ruby-ivar">@base</span>.<span class="ruby-identifier">lib</span>.<span class="ruby-identifier">branches_all</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">b</span><span class="ruby-operator">|</span>
 152         <span class="ruby-ivar">@branches</span>[<span class="ruby-identifier">b</span>[<span class="ruby-value">0</span>]] = <span class="ruby-constant">Git</span><span class="ruby-operator">::</span><span class="ruby-constant">Branch</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@base</span>, <span class="ruby-identifier">b</span>[<span class="ruby-value">0</span>])
 153       <span class="ruby-keyword kw">end</span>
 154     <span class="ruby-keyword kw">end</span>
 155 </pre>
 156           </div>
 157         </div>
 158       </div>
 159
 160       <h3 class="section-bar">Public Instance methods</h3>
 161
 162       <div id="method-M000076" class="method-detail">
 163         <a name="M000076"></a>
 164
 165         <div class="method-heading">
 166           <a href="#M000076" class="method-signature">
 167           <span class="method-name">[]</span><span class="method-args">(symbol)</span>
 168           </a>
 169         </div>
 170
 171         <div class="method-description">
 172           <p><a class="source-toggle" href="#"
 173             onclick="toggleCode('M000076-source');return false;">[Source]</a></p>
 174           <div class="method-source-code" id="M000076-source">
 175 <pre>
 176 <span class="ruby-comment cmt"># File lib/git/branches.rb, line 40</span>
 177     <span class="ruby-keyword kw">def</span> <span class="ruby-operator">[]</span>(<span class="ruby-identifier">symbol</span>)
 178       <span class="ruby-ivar">@branches</span>[<span class="ruby-identifier">symbol</span>.<span class="ruby-identifier">to_s</span>]
 179     <span class="ruby-keyword kw">end</span>
 180 </pre>
 181           </div>
 182         </div>
 183       </div>
 184
 185       <div id="method-M000075" class="method-detail">
 186         <a name="M000075"></a>
 187
 188         <div class="method-heading">
 189           <a href="#M000075" class="method-signature">
 190           <span class="method-name">each</span><span class="method-args">() {|b| ...}</span>
 191           </a>
 192         </div>
 193
 194         <div class="method-description">
 195           <p><a class="source-toggle" href="#"
 196             onclick="toggleCode('M000075-source');return false;">[Source]</a></p>
 197           <div class="method-source-code" id="M000075-source">
 198 <pre>
 199 <span class="ruby-comment cmt"># File lib/git/branches.rb, line 34</span>
 200     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">each</span>
 201       <span class="ruby-ivar">@branches</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">k</span>, <span class="ruby-identifier">b</span><span class="ruby-operator">|</span>
 202         <span class="ruby-keyword kw">yield</span> <span class="ruby-identifier">b</span>
 203       <span class="ruby-keyword kw">end</span>
 204     <span class="ruby-keyword kw">end</span>
 205 </pre>
 206           </div>
 207         </div>
 208       </div>
 209
 210       <div id="method-M000072" class="method-detail">
 211         <a name="M000072"></a>
 212
 213         <div class="method-heading">
 214           <a href="#M000072" class="method-signature">
 215           <span class="method-name">local</span><span class="method-args">()</span>
 216           </a>
 217         </div>
 218
 219         <div class="method-description">
 220           <p><a class="source-toggle" href="#"
 221             onclick="toggleCode('M000072-source');return false;">[Source]</a></p>
 222           <div class="method-source-code" id="M000072-source">
 223 <pre>
 224 <span class="ruby-comment cmt"># File lib/git/branches.rb, line 20</span>
 225     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">local</span>
 226       <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">select</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">b</span><span class="ruby-operator">|</span> <span class="ruby-operator">!</span><span class="ruby-identifier">b</span>.<span class="ruby-identifier">remote</span> }
 227     <span class="ruby-keyword kw">end</span>
 228 </pre>
 229           </div>
 230         </div>
 231       </div>
 232
 233       <div id="method-M000073" class="method-detail">
 234         <a name="M000073"></a>
 235
 236         <div class="method-heading">
 237           <a href="#M000073" class="method-signature">
 238           <span class="method-name">remote</span><span class="method-args">()</span>
 239           </a>
 240         </div>
 241
 242         <div class="method-description">
 243           <p><a class="source-toggle" href="#"
 244             onclick="toggleCode('M000073-source');return false;">[Source]</a></p>
 245           <div class="method-source-code" id="M000073-source">
 246 <pre>
 247 <span class="ruby-comment cmt"># File lib/git/branches.rb, line 24</span>
 248     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">remote</span>
 249       <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">select</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">b</span><span class="ruby-operator">|</span> <span class="ruby-identifier">b</span>.<span class="ruby-identifier">remote</span> }
 250     <span class="ruby-keyword kw">end</span>
 251 </pre>
 252           </div>
 253         </div>
 254       </div>
 255
 256       <div id="method-M000074" class="method-detail">
 257         <a name="M000074"></a>
 258
 259         <div class="method-heading">
 260           <a href="#M000074" class="method-signature">
 261           <span class="method-name">size</span><span class="method-args">()</span>
 262           </a>
 263         </div>
 264
 265         <div class="method-description">
 266           <p>
 267 array like methods
 268 </p>
 269           <p><a class="source-toggle" href="#"
 270             onclick="toggleCode('M000074-source');return false;">[Source]</a></p>
 271           <div class="method-source-code" id="M000074-source">
 272 <pre>
 273 <span class="ruby-comment cmt"># File lib/git/branches.rb, line 30</span>
 274     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">size</span>
 275       <span class="ruby-ivar">@branches</span>.<span class="ruby-identifier">size</span>
 276     <span class="ruby-keyword kw">end</span>
 277 </pre>
 278           </div>
 279         </div>
 280       </div>
 281
 282
 283     </div>
 284
 285
 286   </div>
 287
 288
 289 <div id="validator-badges">
 290   <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
 291 </div>
 292
 293 </body>
 294 </html>