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="#M000125">contents</a>&nbsp;&nbsp;
  90       <a href="#M000126">contents_array</a>&nbsp;&nbsp;
  91       <a href="#M000130">diff</a>&nbsp;&nbsp;
  92       <a href="#M000129">grep</a>&nbsp;&nbsp;
  93       <a href="#M000131">log</a>&nbsp;&nbsp;
  94       <a href="#M000124">new</a>&nbsp;&nbsp;
  95       <a href="#M000127">setup</a>&nbsp;&nbsp;
  96       <a href="#M000128">to_s</a>&nbsp;&nbsp;
  97       </div>
  98     </div>
  99
 100   </div>
 101
 102
 103     <!-- if includes -->
 104
 105     <div id="section">
 106
 107
 108
 109
 110
 111     <div id="attribute-list">
 112       <h3 class="section-bar">Attributes</h3>
 113
 114       <div class="name-list">
 115         <table>
 116         <tr class="top-aligned-row context-row">
 117           <td class="context-item-name">mode</td>
 118           <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
 119           <td class="context-item-desc"></td>
 120         </tr>
 121         <tr class="top-aligned-row context-row">
 122           <td class="context-item-name">sha</td>
 123           <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
 124           <td class="context-item-desc"></td>
 125         </tr>
 126         <tr class="top-aligned-row context-row">
 127           <td class="context-item-name">size</td>
 128           <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
 129           <td class="context-item-desc"></td>
 130         </tr>
 131         <tr class="top-aligned-row context-row">
 132           <td class="context-item-name">type</td>
 133           <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
 134           <td class="context-item-desc"></td>
 135         </tr>
 136         </table>
 137       </div>
 138     </div>
 139
 140
 141
 142     <!-- if method_list -->
 143     <div id="methods">
 144       <h3 class="section-bar">Public Class methods</h3>
 145
 146       <div id="method-M000124" class="method-detail">
 147         <a name="M000124"></a>
 148
 149         <div class="method-heading">
 150           <a href="#M000124" class="method-signature">
 151           <span class="method-name">new</span><span class="method-args">(base, sha)</span>
 152           </a>
 153         </div>
 154
 155         <div class="method-description">
 156           <p><a class="source-toggle" href="#"
 157             onclick="toggleCode('M000124-source');return false;">[Source]</a></p>
 158           <div class="method-source-code" id="M000124-source">
 159 <pre>
 160 <span class="ruby-comment cmt"># File lib/git/object.rb, line 13</span>
 161       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">base</span>, <span class="ruby-identifier">sha</span>)
 162         <span class="ruby-ivar">@base</span> = <span class="ruby-identifier">base</span>
 163         <span class="ruby-ivar">@sha</span> = <span class="ruby-identifier">sha</span>
 164         <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">@sha</span>)
 165         <span class="ruby-identifier">setup</span>
 166       <span class="ruby-keyword kw">end</span>
 167 </pre>
 168           </div>
 169         </div>
 170       </div>
 171
 172       <h3 class="section-bar">Public Instance methods</h3>
 173
 174       <div id="method-M000125" class="method-detail">
 175         <a name="M000125"></a>
 176
 177         <div class="method-heading">
 178           <a href="#M000125" class="method-signature">
 179           <span class="method-name">contents</span><span class="method-args">()</span>
 180           </a>
 181         </div>
 182
 183         <div class="method-description">
 184           <p><a class="source-toggle" href="#"
 185             onclick="toggleCode('M000125-source');return false;">[Source]</a></p>
 186           <div class="method-source-code" id="M000125-source">
 187 <pre>
 188 <span class="ruby-comment cmt"># File lib/git/object.rb, line 20</span>
 189       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">contents</span>
 190         <span class="ruby-ivar">@base</span>.<span class="ruby-identifier">lib</span>.<span class="ruby-identifier">object_contents</span>(<span class="ruby-ivar">@sha</span>)
 191       <span class="ruby-keyword kw">end</span>
 192 </pre>
 193           </div>
 194         </div>
 195       </div>
 196
 197       <div id="method-M000126" class="method-detail">
 198         <a name="M000126"></a>
 199
 200         <div class="method-heading">
 201           <a href="#M000126" class="method-signature">
 202           <span class="method-name">contents_array</span><span class="method-args">()</span>
 203           </a>
 204         </div>
 205
 206         <div class="method-description">
 207           <p><a class="source-toggle" href="#"
 208             onclick="toggleCode('M000126-source');return false;">[Source]</a></p>
 209           <div class="method-source-code" id="M000126-source">
 210 <pre>
 211 <span class="ruby-comment cmt"># File lib/git/object.rb, line 24</span>
 212       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">contents_array</span>
 213         <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>)
 214       <span class="ruby-keyword kw">end</span>
 215 </pre>
 216           </div>
 217         </div>
 218       </div>
 219
 220       <div id="method-M000130" class="method-detail">
 221         <a name="M000130"></a>
 222
 223         <div class="method-heading">
 224           <a href="#M000130" class="method-signature">
 225           <span class="method-name">diff</span><span class="method-args">(objectish)</span>
 226           </a>
 227         </div>
 228
 229         <div class="method-description">
 230           <p><a class="source-toggle" href="#"
 231             onclick="toggleCode('M000130-source');return false;">[Source]</a></p>
 232           <div class="method-source-code" id="M000130-source">
 233 <pre>
 234 <span class="ruby-comment cmt"># File lib/git/object.rb, line 42</span>
 235       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">diff</span>(<span class="ruby-identifier">objectish</span>)
 236         <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">@sha</span>, <span class="ruby-identifier">objectish</span>)
 237       <span class="ruby-keyword kw">end</span>
 238 </pre>
 239           </div>
 240         </div>
 241       </div>
 242
 243       <div id="method-M000129" class="method-detail">
 244         <a name="M000129"></a>
 245
 246         <div class="method-heading">
 247           <a href="#M000129" class="method-signature">
 248           <span class="method-name">grep</span><span class="method-args">(string, path_limiter = nil, opts = {})</span>
 249           </a>
 250         </div>
 251
 252         <div class="method-description">
 253           <p><a class="source-toggle" href="#"
 254             onclick="toggleCode('M000129-source');return false;">[Source]</a></p>
 255           <div class="method-source-code" id="M000129-source">
 256 <pre>
 257 <span class="ruby-comment cmt"># File lib/git/object.rb, line 36</span>
 258       <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> = {})
 259         <span class="ruby-identifier">default</span> = {<span class="ruby-identifier">:object</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-ivar">@sha</span>, <span class="ruby-identifier">:path_limiter</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">path_limiter</span>}
 260         <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>)
 261         <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>)
 262       <span class="ruby-keyword kw">end</span>
 263 </pre>
 264           </div>
 265         </div>
 266       </div>
 267
 268       <div id="method-M000131" class="method-detail">
 269         <a name="M000131"></a>
 270
 271         <div class="method-heading">
 272           <a href="#M000131" class="method-signature">
 273           <span class="method-name">log</span><span class="method-args">(count = 30)</span>
 274           </a>
 275         </div>
 276
 277         <div class="method-description">
 278           <p><a class="source-toggle" href="#"
 279             onclick="toggleCode('M000131-source');return false;">[Source]</a></p>
 280           <div class="method-source-code" id="M000131-source">
 281 <pre>
 282 <span class="ruby-comment cmt"># File lib/git/object.rb, line 46</span>
 283       <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>)
 284         <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">@sha</span>)
 285       <span class="ruby-keyword kw">end</span>
 286 </pre>
 287           </div>
 288         </div>
 289       </div>
 290
 291       <div id="method-M000127" class="method-detail">
 292         <a name="M000127"></a>
 293
 294         <div class="method-heading">
 295           <a href="#M000127" class="method-signature">
 296           <span class="method-name">setup</span><span class="method-args">()</span>
 297           </a>
 298         </div>
 299
 300         <div class="method-description">
 301           <p><a class="source-toggle" href="#"
 302             onclick="toggleCode('M000127-source');return false;">[Source]</a></p>
 303           <div class="method-source-code" id="M000127-source">
 304 <pre>
 305 <span class="ruby-comment cmt"># File lib/git/object.rb, line 28</span>
 306       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">setup</span>
 307         <span class="ruby-identifier">raise</span> <span class="ruby-constant">NotImplementedError</span>
 308       <span class="ruby-keyword kw">end</span>
 309 </pre>
 310           </div>
 311         </div>
 312       </div>
 313
 314       <div id="method-M000128" class="method-detail">
 315         <a name="M000128"></a>
 316
 317         <div class="method-heading">
 318           <a href="#M000128" class="method-signature">
 319           <span class="method-name">to_s</span><span class="method-args">()</span>
 320           </a>
 321         </div>
 322
 323         <div class="method-description">
 324           <p><a class="source-toggle" href="#"
 325             onclick="toggleCode('M000128-source');return false;">[Source]</a></p>
 326           <div class="method-source-code" id="M000128-source">
 327 <pre>
 328 <span class="ruby-comment cmt"># File lib/git/object.rb, line 32</span>
 329       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">to_s</span>
 330         <span class="ruby-ivar">@sha</span>
 331       <span class="ruby-keyword kw">end</span>
 332 </pre>
 333           </div>
 334         </div>
 335       </div>
 336
 337
 338     </div>
 339
 340
 341   </div>
 342
 343
 344 <div id="validator-badges">
 345   <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
 346 </div>
 347
 348 </body>
 349 </html>