updated docs
[rubygit.git] / doc / classes / Git / Object / Tree.html
blob870df371116d995d897827c980d74c8ffb4d1400
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">
6 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
7 <head>
8 <title>Class: Git::Object::Tree</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[
15 function popupCode( url ) {
16 window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
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;
27 elemStyle = elem.style;
29 if ( elemStyle.display != "block" ) {
30 elemStyle.display = "block"
31 } else {
32 elemStyle.display = "none"
35 return true;
38 // Make codeblocks hidden by default
39 document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
41 // ]]>
42 </script>
44 </head>
45 <body>
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::Tree</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>
65 <tr class="top-aligned-row">
66 <td><strong>Parent:</strong></td>
67 <td>
68 <a href="AbstractObject.html">
69 AbstractObject
70 </a>
71 </td>
72 </tr>
73 </table>
74 </div>
75 <!-- banner header -->
77 <div id="bodyContent">
81 <div id="contextContent">
85 </div>
87 <div id="method-list">
88 <h3 class="section-bar">Methods</h3>
90 <div class="name-list">
91 <a href="#M000184">blobs</a>&nbsp;&nbsp;
92 <a href="#M000183">children</a>&nbsp;&nbsp;
93 <a href="#M000185">files</a>&nbsp;&nbsp;
94 <a href="#M000182">new</a>&nbsp;&nbsp;
95 <a href="#M000188">subdirectories</a>&nbsp;&nbsp;
96 <a href="#M000187">subtrees</a>&nbsp;&nbsp;
97 <a href="#M000186">trees</a>&nbsp;&nbsp;
98 </div>
99 </div>
101 </div>
104 <!-- if includes -->
106 <div id="section">
115 <!-- if method_list -->
116 <div id="methods">
117 <h3 class="section-bar">Public Class methods</h3>
119 <div id="method-M000182" class="method-detail">
120 <a name="M000182"></a>
122 <div class="method-heading">
123 <a href="#M000182" class="method-signature">
124 <span class="method-name">new</span><span class="method-args">(base, sha, mode = nil)</span>
125 </a>
126 </div>
128 <div class="method-description">
129 <p><a class="source-toggle" href="#"
130 onclick="toggleCode('M000182-source');return false;">[Source]</a></p>
131 <div class="method-source-code" id="M000182-source">
132 <pre>
133 <span class="ruby-comment cmt"># File lib/git/object.rb, line 105</span>
134 <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>, <span class="ruby-identifier">mode</span> = <span class="ruby-keyword kw">nil</span>)
135 <span class="ruby-keyword kw">super</span>(<span class="ruby-identifier">base</span>, <span class="ruby-identifier">sha</span>)
136 <span class="ruby-ivar">@mode</span> = <span class="ruby-identifier">mode</span>
137 <span class="ruby-keyword kw">end</span>
138 </pre>
139 </div>
140 </div>
141 </div>
143 <h3 class="section-bar">Public Instance methods</h3>
145 <div id="method-M000184" class="method-detail">
146 <a name="M000184"></a>
148 <div class="method-heading">
149 <a href="#M000184" class="method-signature">
150 <span class="method-name">blobs</span><span class="method-args">()</span>
151 </a>
152 </div>
154 <div class="method-description">
155 <p><a class="source-toggle" href="#"
156 onclick="toggleCode('M000184-source');return false;">[Source]</a></p>
157 <div class="method-source-code" id="M000184-source">
158 <pre>
159 <span class="ruby-comment cmt"># File lib/git/object.rb, line 114</span>
160 <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">blobs</span>
161 <span class="ruby-identifier">check_tree</span>
162 <span class="ruby-ivar">@blobs</span>
163 <span class="ruby-keyword kw">end</span>
164 </pre>
165 </div>
166 </div>
167 </div>
169 <div id="method-M000183" class="method-detail">
170 <a name="M000183"></a>
172 <div class="method-heading">
173 <a href="#M000183" class="method-signature">
174 <span class="method-name">children</span><span class="method-args">()</span>
175 </a>
176 </div>
178 <div class="method-description">
179 <p><a class="source-toggle" href="#"
180 onclick="toggleCode('M000183-source');return false;">[Source]</a></p>
181 <div class="method-source-code" id="M000183-source">
182 <pre>
183 <span class="ruby-comment cmt"># File lib/git/object.rb, line 110</span>
184 <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">children</span>
185 <span class="ruby-identifier">blobs</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-identifier">subtrees</span>)
186 <span class="ruby-keyword kw">end</span>
187 </pre>
188 </div>
189 </div>
190 </div>
192 <div id="method-M000185" class="method-detail">
193 <a name="M000185"></a>
195 <div class="method-heading">
196 <span class="method-name">files</span><span class="method-args">()</span>
197 </div>
199 <div class="method-description">
201 Alias for <a href="Tree.html#M000184">blobs</a>
202 </p>
203 </div>
204 </div>
206 <div id="method-M000188" class="method-detail">
207 <a name="M000188"></a>
209 <div class="method-heading">
210 <span class="method-name">subdirectories</span><span class="method-args">()</span>
211 </div>
213 <div class="method-description">
215 Alias for <a href="Tree.html#M000186">trees</a>
216 </p>
217 </div>
218 </div>
220 <div id="method-M000187" class="method-detail">
221 <a name="M000187"></a>
223 <div class="method-heading">
224 <span class="method-name">subtrees</span><span class="method-args">()</span>
225 </div>
227 <div class="method-description">
229 Alias for <a href="Tree.html#M000186">trees</a>
230 </p>
231 </div>
232 </div>
234 <div id="method-M000186" class="method-detail">
235 <a name="M000186"></a>
237 <div class="method-heading">
238 <a href="#M000186" class="method-signature">
239 <span class="method-name">trees</span><span class="method-args">()</span>
240 </a>
241 </div>
243 <div class="method-description">
244 <p><a class="source-toggle" href="#"
245 onclick="toggleCode('M000186-source');return false;">[Source]</a></p>
246 <div class="method-source-code" id="M000186-source">
247 <pre>
248 <span class="ruby-comment cmt"># File lib/git/object.rb, line 120</span>
249 <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">trees</span>
250 <span class="ruby-identifier">check_tree</span>
251 <span class="ruby-ivar">@trees</span>
252 <span class="ruby-keyword kw">end</span>
253 </pre>
254 </div>
255 </div>
256 </div>
259 </div>
262 </div>
265 <div id="validator-badges">
266 <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
267 </div>
269 </body>
270 </html>