doc/classes/Git/Object/AbstractObject.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::Object::AbstractObject</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::Object::AbstractObject</td>
  54         </tr>
  55         <tr class="top-aligned-row">
  56             <td><strong>In:</strong></td>
  57             <td>
  58                 <a href="../../../files/lib/git/object_rb.html">
  59                 lib/git/object.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                 Object
  69             </td>
  70         </tr>
  71         </table>
  72     </div>
  73   <!-- banner header -->
  74
  75   <div id="bodyContent">
  76
  77
  78
  79   <div id="contextContent">
  80
  81
  82
  83    </div>
  84
  85     <div id="method-list">
  86       <h3 class="section-bar">Methods</h3>
  87
  88       <div class="name-list">
  89       <a href="#M000171">archive</a>&nbsp;&nbsp;
  90       <a href="#M000173">blob?</a>&nbsp;&nbsp;
  91       <a href="#M000174">commit?</a>&nbsp;&nbsp;
  92       <a href="#M000164">contents</a>&nbsp;&nbsp;
  93       <a href="#M000165">contents_array</a>&nbsp;&nbsp;
  94       <a href="#M000169">diff</a>&nbsp;&nbsp;
  95       <a href="#M000168">grep</a>&nbsp;&nbsp;
  96       <a href="#M000170">log</a>&nbsp;&nbsp;
  97       <a href="#M000161">new</a>&nbsp;&nbsp;
  98       <a href="#M000166">setup</a>&nbsp;&nbsp;
  99       <a href="#M000162">sha</a>&nbsp;&nbsp;
 100       <a href="#M000163">size</a>&nbsp;&nbsp;
 101       <a href="#M000175">tag?</a>&nbsp;&nbsp;
 102       <a href="#M000167">to_s</a>&nbsp;&nbsp;
 103       <a href="#M000172">tree?</a>&nbsp;&nbsp;
 104       </div>
 105     </div>
 106
 107   </div>
 108
 109
 110     <!-- if includes -->
 111
 112     <div id="section">
 113
 114
 115
 116
 117
 118     <div id="attribute-list">
 119       <h3 class="section-bar">Attributes</h3>
 120
 121       <div class="name-list">
 122         <table>
 123         <tr class="top-aligned-row context-row">
 124           <td class="context-item-name">mode</td>
 125           <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
 126           <td class="context-item-desc"></td>
 127         </tr>
 128         <tr class="top-aligned-row context-row">
 129           <td class="context-item-name">objectish</td>
 130           <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
 131           <td class="context-item-desc"></td>
 132         </tr>
 133         <tr class="top-aligned-row context-row">
 134           <td class="context-item-name">size</td>
 135           <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
 136           <td class="context-item-desc"></td>
 137         </tr>
 138         <tr class="top-aligned-row context-row">
 139           <td class="context-item-name">type</td>
 140           <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
 141           <td class="context-item-desc"></td>
 142         </tr>
 143         </table>
 144       </div>
 145     </div>
 146
 147
 148
 149     <!-- if method_list -->
 150     <div id="methods">
 151       <h3 class="section-bar">Public Class methods</h3>
 152
 153       <div id="method-M000161" class="method-detail">
 154         <a name="M000161"></a>
 155
 156         <div class="method-heading">
 157           <a href="#M000161" class="method-signature">
 158           <span class="method-name">new</span><span class="method-args">(base, objectish)</span>
 159           </a>
 160         </div>
 161
 162         <div class="method-description">
 163           <p><a class="source-toggle" href="#"
 164             onclick="toggleCode('M000161-source');return false;">[Source]</a></p>
 165           <div class="method-source-code" id="M000161-source">
 166 <pre>
 167 <span class="ruby-comment cmt"># File lib/git/object.rb, line 17</span>
 168       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">base</span>, <span class="ruby-identifier">objectish</span>)
 169         <span class="ruby-ivar">@base</span> = <span class="ruby-identifier">base</span>
 170         <span class="ruby-ivar">@objectish</span> = <span class="ruby-identifier">objectish</span>.<span class="ruby-identifier">to_s</span>
 171         <span class="ruby-identifier">setup</span>
 172       <span class="ruby-keyword kw">end</span>
 173 </pre>
 174           </div>
 175         </div>
 176       </div>
 177
 178       <h3 class="section-bar">Public Instance methods</h3>
 179
 180       <div id="method-M000171" class="method-detail">
 181         <a name="M000171"></a>
 182
 183         <div class="method-heading">
 184           <a href="#M000171" class="method-signature">
 185           <span class="method-name">archive</span><span class="method-args">(file = nil, opts = {})</span>
 186           </a>
 187         </div>
 188
 189         <div class="method-description">
 190           <p>
 191 creates an archive of this object (tree)
 192 </p>
 193           <p><a class="source-toggle" href="#"
 194             onclick="toggleCode('M000171-source');return false;">[Source]</a></p>
 195           <div class="method-source-code" id="M000171-source">
 196 <pre>
 197 <span class="ruby-comment cmt"># File lib/git/object.rb, line 63</span>
 198       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">archive</span>(<span class="ruby-identifier">file</span> = <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">opts</span> = {})
 199         <span class="ruby-ivar">@base</span>.<span class="ruby-identifier">lib</span>.<span class="ruby-identifier">archive</span>(<span class="ruby-ivar">@objectish</span>, <span class="ruby-identifier">file</span>, <span class="ruby-identifier">opts</span>)
 200       <span class="ruby-keyword kw">end</span>
 201 </pre>
 202           </div>
 203         </div>
 204       </div>
 205
 206       <div id="method-M000173" class="method-detail">
 207         <a name="M000173"></a>
 208
 209         <div class="method-heading">
 210           <a href="#M000173" class="method-signature">
 211           <span class="method-name">blob?</span><span class="method-args">()</span>
 212           </a>
 213         </div>
 214
 215         <div class="method-description">
 216           <p><a class="source-toggle" href="#"
 217             onclick="toggleCode('M000173-source');return false;">[Source]</a></p>
 218           <div class="method-source-code" id="M000173-source">
 219 <pre>
 220 <span class="ruby-comment cmt"># File lib/git/object.rb, line 71</span>
 221       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">blob?</span>
 222         <span class="ruby-ivar">@type</span> <span class="ruby-operator">==</span> <span class="ruby-value str">'blob'</span>
 223       <span class="ruby-keyword kw">end</span>
 224 </pre>
 225           </div>
 226         </div>
 227       </div>
 228
 229       <div id="method-M000174" class="method-detail">
 230         <a name="M000174"></a>
 231
 232         <div class="method-heading">
 233           <a href="#M000174" class="method-signature">
 234           <span class="method-name">commit?</span><span class="method-args">()</span>
 235           </a>
 236         </div>
 237
 238         <div class="method-description">
 239           <p><a class="source-toggle" href="#"
 240             onclick="toggleCode('M000174-source');return false;">[Source]</a></p>
 241           <div class="method-source-code" id="M000174-source">
 242 <pre>
 243 <span class="ruby-comment cmt"># File lib/git/object.rb, line 75</span>
 244       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">commit?</span>
 245         <span class="ruby-ivar">@type</span> <span class="ruby-operator">==</span> <span class="ruby-value str">'commit'</span>
 246       <span class="ruby-keyword kw">end</span>
 247 </pre>
 248           </div>
 249         </div>
 250       </div>
 251
 252       <div id="method-M000164" class="method-detail">
 253         <a name="M000164"></a>
 254
 255         <div class="method-heading">
 256           <a href="#M000164" class="method-signature">
 257           <span class="method-name">contents</span><span class="method-args">()</span>
 258           </a>
 259         </div>
 260
 261         <div class="method-description">
 262           <p>
 263 caches the contents of this call in memory
 264 </p>
 265           <p><a class="source-toggle" href="#"
 266             onclick="toggleCode('M000164-source');return false;">[Source]</a></p>
 267           <div class="method-source-code" id="M000164-source">
 268 <pre>
 269 <span class="ruby-comment cmt"># File lib/git/object.rb, line 32</span>
 270       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">contents</span>
 271         <span class="ruby-ivar">@contents</span> <span class="ruby-operator">||</span> <span class="ruby-ivar">@contents</span> = <span class="ruby-ivar">@base</span>.<span class="ruby-identifier">lib</span>.<span class="ruby-identifier">object_contents</span>(<span class="ruby-ivar">@objectish</span>)
 272       <span class="ruby-keyword kw">end</span>
 273 </pre>
 274           </div>
 275         </div>
 276       </div>
 277
 278       <div id="method-M000165" class="method-detail">
 279         <a name="M000165"></a>
 280
 281         <div class="method-heading">
 282           <a href="#M000165" class="method-signature">
 283           <span class="method-name">contents_array</span><span class="method-args">()</span>
 284           </a>
 285         </div>
 286
 287         <div class="method-description">
 288           <p><a class="source-toggle" href="#"
 289             onclick="toggleCode('M000165-source');return false;">[Source]</a></p>
 290           <div class="method-source-code" id="M000165-source">
 291 <pre>
 292 <span class="ruby-comment cmt"># File lib/git/object.rb, line 36</span>
 293       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">contents_array</span>
 294         <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">contents</span>.<span class="ruby-identifier">split</span>(<span class="ruby-value str">&quot;\n&quot;</span>)
 295       <span class="ruby-keyword kw">end</span>
 296 </pre>
 297           </div>
 298         </div>
 299       </div>
 300
 301       <div id="method-M000169" class="method-detail">
 302         <a name="M000169"></a>
 303
 304         <div class="method-heading">
 305           <a href="#M000169" class="method-signature">
 306           <span class="method-name">diff</span><span class="method-args">(objectish)</span>
 307           </a>
 308         </div>
 309
 310         <div class="method-description">
 311           <p><a class="source-toggle" href="#"
 312             onclick="toggleCode('M000169-source');return false;">[Source]</a></p>
 313           <div class="method-source-code" id="M000169-source">
 314 <pre>
 315 <span class="ruby-comment cmt"># File lib/git/object.rb, line 54</span>
 316       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">diff</span>(<span class="ruby-identifier">objectish</span>)
 317         <span class="ruby-constant">Git</span><span class="ruby-operator">::</span><span class="ruby-constant">Diff</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@base</span>, <span class="ruby-ivar">@objectish</span>, <span class="ruby-identifier">objectish</span>)
 318       <span class="ruby-keyword kw">end</span>
 319 </pre>
 320           </div>
 321         </div>
 322       </div>
 323
 324       <div id="method-M000168" class="method-detail">
 325         <a name="M000168"></a>
 326
 327         <div class="method-heading">
 328           <a href="#M000168" class="method-signature">
 329           <span class="method-name">grep</span><span class="method-args">(string, path_limiter = nil, opts = {})</span>
 330           </a>
 331         </div>
 332
 333         <div class="method-description">
 334           <p><a class="source-toggle" href="#"
 335             onclick="toggleCode('M000168-source');return false;">[Source]</a></p>
 336           <div class="method-source-code" id="M000168-source">
 337 <pre>
 338 <span class="ruby-comment cmt"># File lib/git/object.rb, line 48</span>
 339       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">grep</span>(<span class="ruby-identifier">string</span>, <span class="ruby-identifier">path_limiter</span> = <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">opts</span> = {})
 340         <span class="ruby-identifier">default</span> = {<span class="ruby-identifier">:object</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">sha</span>, <span class="ruby-identifier">:path_limiter</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">path_limiter</span>}
 341         <span class="ruby-identifier">grep_options</span> = <span class="ruby-identifier">default</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-identifier">opts</span>)
 342         <span class="ruby-ivar">@base</span>.<span class="ruby-identifier">lib</span>.<span class="ruby-identifier">grep</span>(<span class="ruby-identifier">string</span>, <span class="ruby-identifier">grep_options</span>)
 343       <span class="ruby-keyword kw">end</span>
 344 </pre>
 345           </div>
 346         </div>
 347       </div>
 348
 349       <div id="method-M000170" class="method-detail">
 350         <a name="M000170"></a>
 351
 352         <div class="method-heading">
 353           <a href="#M000170" class="method-signature">
 354           <span class="method-name">log</span><span class="method-args">(count = 30)</span>
 355           </a>
 356         </div>
 357
 358         <div class="method-description">
 359           <p><a class="source-toggle" href="#"
 360             onclick="toggleCode('M000170-source');return false;">[Source]</a></p>
 361           <div class="method-source-code" id="M000170-source">
 362 <pre>
 363 <span class="ruby-comment cmt"># File lib/git/object.rb, line 58</span>
 364       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">log</span>(<span class="ruby-identifier">count</span> = <span class="ruby-value">30</span>)
 365         <span class="ruby-constant">Git</span><span class="ruby-operator">::</span><span class="ruby-constant">Log</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@base</span>, <span class="ruby-identifier">count</span>).<span class="ruby-identifier">object</span>(<span class="ruby-ivar">@objectish</span>)
 366       <span class="ruby-keyword kw">end</span>
 367 </pre>
 368           </div>
 369         </div>
 370       </div>
 371
 372       <div id="method-M000166" class="method-detail">
 373         <a name="M000166"></a>
 374
 375         <div class="method-heading">
 376           <a href="#M000166" class="method-signature">
 377           <span class="method-name">setup</span><span class="method-args">()</span>
 378           </a>
 379         </div>
 380
 381         <div class="method-description">
 382           <p><a class="source-toggle" href="#"
 383             onclick="toggleCode('M000166-source');return false;">[Source]</a></p>
 384           <div class="method-source-code" id="M000166-source">
 385 <pre>
 386 <span class="ruby-comment cmt"># File lib/git/object.rb, line 40</span>
 387       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">setup</span>
 388         <span class="ruby-identifier">raise</span> <span class="ruby-constant">NotImplementedError</span>
 389       <span class="ruby-keyword kw">end</span>
 390 </pre>
 391           </div>
 392         </div>
 393       </div>
 394
 395       <div id="method-M000162" class="method-detail">
 396         <a name="M000162"></a>
 397
 398         <div class="method-heading">
 399           <a href="#M000162" class="method-signature">
 400           <span class="method-name">sha</span><span class="method-args">()</span>
 401           </a>
 402         </div>
 403
 404         <div class="method-description">
 405           <p><a class="source-toggle" href="#"
 406             onclick="toggleCode('M000162-source');return false;">[Source]</a></p>
 407           <div class="method-source-code" id="M000162-source">
 408 <pre>
 409 <span class="ruby-comment cmt"># File lib/git/object.rb, line 23</span>
 410       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">sha</span>
 411         <span class="ruby-ivar">@sha</span> <span class="ruby-operator">||</span> <span class="ruby-ivar">@sha</span> = <span class="ruby-ivar">@base</span>.<span class="ruby-identifier">lib</span>.<span class="ruby-identifier">revparse</span>(<span class="ruby-ivar">@objectish</span>)
 412       <span class="ruby-keyword kw">end</span>
 413 </pre>
 414           </div>
 415         </div>
 416       </div>
 417
 418       <div id="method-M000163" class="method-detail">
 419         <a name="M000163"></a>
 420
 421         <div class="method-heading">
 422           <a href="#M000163" class="method-signature">
 423           <span class="method-name">size</span><span class="method-args">()</span>
 424           </a>
 425         </div>
 426
 427         <div class="method-description">
 428           <p><a class="source-toggle" href="#"
 429             onclick="toggleCode('M000163-source');return false;">[Source]</a></p>
 430           <div class="method-source-code" id="M000163-source">
 431 <pre>
 432 <span class="ruby-comment cmt"># File lib/git/object.rb, line 27</span>
 433       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">size</span>
 434         <span class="ruby-ivar">@size</span> <span class="ruby-operator">||</span> <span class="ruby-ivar">@size</span> = <span class="ruby-ivar">@base</span>.<span class="ruby-identifier">lib</span>.<span class="ruby-identifier">object_size</span>(<span class="ruby-ivar">@objectish</span>)
 435       <span class="ruby-keyword kw">end</span>
 436 </pre>
 437           </div>
 438         </div>
 439       </div>
 440
 441       <div id="method-M000175" class="method-detail">
 442         <a name="M000175"></a>
 443
 444         <div class="method-heading">
 445           <a href="#M000175" class="method-signature">
 446           <span class="method-name">tag?</span><span class="method-args">()</span>
 447           </a>
 448         </div>
 449
 450         <div class="method-description">
 451           <p><a class="source-toggle" href="#"
 452             onclick="toggleCode('M000175-source');return false;">[Source]</a></p>
 453           <div class="method-source-code" id="M000175-source">
 454 <pre>
 455 <span class="ruby-comment cmt"># File lib/git/object.rb, line 79</span>
 456      <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">tag?</span>
 457        <span class="ruby-ivar">@type</span> <span class="ruby-operator">==</span> <span class="ruby-value str">'tag'</span>
 458      <span class="ruby-keyword kw">end</span>
 459 </pre>
 460           </div>
 461         </div>
 462       </div>
 463
 464       <div id="method-M000167" class="method-detail">
 465         <a name="M000167"></a>
 466
 467         <div class="method-heading">
 468           <a href="#M000167" class="method-signature">
 469           <span class="method-name">to_s</span><span class="method-args">()</span>
 470           </a>
 471         </div>
 472
 473         <div class="method-description">
 474           <p><a class="source-toggle" href="#"
 475             onclick="toggleCode('M000167-source');return false;">[Source]</a></p>
 476           <div class="method-source-code" id="M000167-source">
 477 <pre>
 478 <span class="ruby-comment cmt"># File lib/git/object.rb, line 44</span>
 479       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">to_s</span>
 480         <span class="ruby-identifier">sha</span>
 481       <span class="ruby-keyword kw">end</span>
 482 </pre>
 483           </div>
 484         </div>
 485       </div>
 486
 487       <div id="method-M000172" class="method-detail">
 488         <a name="M000172"></a>
 489
 490         <div class="method-heading">
 491           <a href="#M000172" class="method-signature">
 492           <span class="method-name">tree?</span><span class="method-args">()</span>
 493           </a>
 494         </div>
 495
 496         <div class="method-description">
 497           <p><a class="source-toggle" href="#"
 498             onclick="toggleCode('M000172-source');return false;">[Source]</a></p>
 499           <div class="method-source-code" id="M000172-source">
 500 <pre>
 501 <span class="ruby-comment cmt"># File lib/git/object.rb, line 67</span>
 502       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">tree?</span>
 503         <span class="ruby-ivar">@type</span> <span class="ruby-operator">==</span> <span class="ruby-value str">'tree'</span>
 504       <span class="ruby-keyword kw">end</span>
 505 </pre>
 506           </div>
 507         </div>
 508       </div>
 509
 510
 511     </div>
 512
 513
 514   </div>
 515
 516
 517 <div id="validator-badges">
 518   <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
 519 </div>
 520
 521 </body>
 522 </html>