doc/classes/Git/Path.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::Path</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::Path</td>
  54         </tr>
  55         <tr class="top-aligned-row">
  56             <td><strong>In:</strong></td>
  57             <td>
  58                 <a href="../../files/lib/git/path_rb.html">
  59                 lib/git/path.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
  84
  85    </div>
  86
  87     <div id="method-list">
  88       <h3 class="section-bar">Methods</h3>
  89
  90       <div class="name-list">
  91       <a href="#M000145">new</a>&nbsp;&nbsp;
  92       <a href="#M000146">readable?</a>&nbsp;&nbsp;
  93       <a href="#M000148">to_s</a>&nbsp;&nbsp;
  94       <a href="#M000147">writable?</a>&nbsp;&nbsp;
  95       </div>
  96     </div>
  97
  98   </div>
  99
 100
 101     <!-- if includes -->
 102
 103     <div id="section">
 104
 105
 106
 107
 108
 109     <div id="attribute-list">
 110       <h3 class="section-bar">Attributes</h3>
 111
 112       <div class="name-list">
 113         <table>
 114         <tr class="top-aligned-row context-row">
 115           <td class="context-item-name">path</td>
 116           <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
 117           <td class="context-item-desc"></td>
 118         </tr>
 119         </table>
 120       </div>
 121     </div>
 122
 123
 124
 125     <!-- if method_list -->
 126     <div id="methods">
 127       <h3 class="section-bar">Public Class methods</h3>
 128
 129       <div id="method-M000145" class="method-detail">
 130         <a name="M000145"></a>
 131
 132         <div class="method-heading">
 133           <a href="#M000145" class="method-signature">
 134           <span class="method-name">new</span><span class="method-args">(path, check_path = true)</span>
 135           </a>
 136         </div>
 137
 138         <div class="method-description">
 139           <p><a class="source-toggle" href="#"
 140             onclick="toggleCode('M000145-source');return false;">[Source]</a></p>
 141           <div class="method-source-code" id="M000145-source">
 142 <pre>
 143 <span class="ruby-comment cmt"># File lib/git/path.rb, line 6</span>
 144     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">path</span>, <span class="ruby-identifier">check_path</span> = <span class="ruby-keyword kw">true</span>)
 145       <span class="ruby-keyword kw">if</span> <span class="ruby-operator">!</span><span class="ruby-identifier">check_path</span> <span class="ruby-operator">||</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">exists?</span>(<span class="ruby-identifier">path</span>)
 146         <span class="ruby-ivar">@path</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">expand_path</span>(<span class="ruby-identifier">path</span>)
 147       <span class="ruby-keyword kw">else</span>
 148         <span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-value str">&quot;path does not exist&quot;</span>, <span class="ruby-constant">File</span>.<span class="ruby-identifier">expand_path</span>(<span class="ruby-identifier">path</span>)
 149       <span class="ruby-keyword kw">end</span>
 150     <span class="ruby-keyword kw">end</span>
 151 </pre>
 152           </div>
 153         </div>
 154       </div>
 155
 156       <h3 class="section-bar">Public Instance methods</h3>
 157
 158       <div id="method-M000146" class="method-detail">
 159         <a name="M000146"></a>
 160
 161         <div class="method-heading">
 162           <a href="#M000146" class="method-signature">
 163           <span class="method-name">readable?</span><span class="method-args">()</span>
 164           </a>
 165         </div>
 166
 167         <div class="method-description">
 168           <p><a class="source-toggle" href="#"
 169             onclick="toggleCode('M000146-source');return false;">[Source]</a></p>
 170           <div class="method-source-code" id="M000146-source">
 171 <pre>
 172 <span class="ruby-comment cmt"># File lib/git/path.rb, line 14</span>
 173     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">readable?</span>
 174       <span class="ruby-constant">File</span>.<span class="ruby-identifier">readable?</span>(<span class="ruby-ivar">@path</span>)
 175     <span class="ruby-keyword kw">end</span>
 176 </pre>
 177           </div>
 178         </div>
 179       </div>
 180
 181       <div id="method-M000148" class="method-detail">
 182         <a name="M000148"></a>
 183
 184         <div class="method-heading">
 185           <a href="#M000148" class="method-signature">
 186           <span class="method-name">to_s</span><span class="method-args">()</span>
 187           </a>
 188         </div>
 189
 190         <div class="method-description">
 191           <p><a class="source-toggle" href="#"
 192             onclick="toggleCode('M000148-source');return false;">[Source]</a></p>
 193           <div class="method-source-code" id="M000148-source">
 194 <pre>
 195 <span class="ruby-comment cmt"># File lib/git/path.rb, line 22</span>
 196     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">to_s</span>
 197       <span class="ruby-ivar">@path</span>
 198     <span class="ruby-keyword kw">end</span>
 199 </pre>
 200           </div>
 201         </div>
 202       </div>
 203
 204       <div id="method-M000147" class="method-detail">
 205         <a name="M000147"></a>
 206
 207         <div class="method-heading">
 208           <a href="#M000147" class="method-signature">
 209           <span class="method-name">writable?</span><span class="method-args">()</span>
 210           </a>
 211         </div>
 212
 213         <div class="method-description">
 214           <p><a class="source-toggle" href="#"
 215             onclick="toggleCode('M000147-source');return false;">[Source]</a></p>
 216           <div class="method-source-code" id="M000147-source">
 217 <pre>
 218 <span class="ruby-comment cmt"># File lib/git/path.rb, line 18</span>
 219     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">writable?</span>
 220       <span class="ruby-constant">File</span>.<span class="ruby-identifier">writable?</span>(<span class="ruby-ivar">@path</span>)
 221     <span class="ruby-keyword kw">end</span>
 222 </pre>
 223           </div>
 224         </div>
 225       </div>
 226
 227
 228     </div>
 229
 230
 231   </div>
 232
 233
 234 <div id="validator-badges">
 235   <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
 236 </div>
 237
 238 </body>
 239 </html>