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="#M000122">new</a>&nbsp;&nbsp;
  92       <a href="#M000123">readable?</a>&nbsp;&nbsp;
  93       <a href="#M000124">writable?</a>&nbsp;&nbsp;
  94       </div>
  95     </div>
  96
  97   </div>
  98
  99
 100     <!-- if includes -->
 101
 102     <div id="section">
 103
 104
 105
 106
 107
 108     <div id="attribute-list">
 109       <h3 class="section-bar">Attributes</h3>
 110
 111       <div class="name-list">
 112         <table>
 113         <tr class="top-aligned-row context-row">
 114           <td class="context-item-name">path</td>
 115           <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
 116           <td class="context-item-desc"></td>
 117         </tr>
 118         </table>
 119       </div>
 120     </div>
 121
 122
 123
 124     <!-- if method_list -->
 125     <div id="methods">
 126       <h3 class="section-bar">Public Class methods</h3>
 127
 128       <div id="method-M000122" class="method-detail">
 129         <a name="M000122"></a>
 130
 131         <div class="method-heading">
 132           <a href="#M000122" class="method-signature">
 133           <span class="method-name">new</span><span class="method-args">(path, check_path = true)</span>
 134           </a>
 135         </div>
 136
 137         <div class="method-description">
 138           <p><a class="source-toggle" href="#"
 139             onclick="toggleCode('M000122-source');return false;">[Source]</a></p>
 140           <div class="method-source-code" id="M000122-source">
 141 <pre>
 142 <span class="ruby-comment cmt"># File lib/git/path.rb, line 6</span>
 143     <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>)
 144       <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>)
 145         <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>)
 146       <span class="ruby-keyword kw">else</span>
 147         <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>)
 148       <span class="ruby-keyword kw">end</span>
 149     <span class="ruby-keyword kw">end</span>
 150 </pre>
 151           </div>
 152         </div>
 153       </div>
 154
 155       <h3 class="section-bar">Public Instance methods</h3>
 156
 157       <div id="method-M000123" class="method-detail">
 158         <a name="M000123"></a>
 159
 160         <div class="method-heading">
 161           <a href="#M000123" class="method-signature">
 162           <span class="method-name">readable?</span><span class="method-args">()</span>
 163           </a>
 164         </div>
 165
 166         <div class="method-description">
 167           <p><a class="source-toggle" href="#"
 168             onclick="toggleCode('M000123-source');return false;">[Source]</a></p>
 169           <div class="method-source-code" id="M000123-source">
 170 <pre>
 171 <span class="ruby-comment cmt"># File lib/git/path.rb, line 14</span>
 172     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">readable?</span>
 173       <span class="ruby-constant">File</span>.<span class="ruby-identifier">readable?</span>(<span class="ruby-ivar">@path</span>)
 174     <span class="ruby-keyword kw">end</span>
 175 </pre>
 176           </div>
 177         </div>
 178       </div>
 179
 180       <div id="method-M000124" class="method-detail">
 181         <a name="M000124"></a>
 182
 183         <div class="method-heading">
 184           <a href="#M000124" class="method-signature">
 185           <span class="method-name">writable?</span><span class="method-args">()</span>
 186           </a>
 187         </div>
 188
 189         <div class="method-description">
 190           <p><a class="source-toggle" href="#"
 191             onclick="toggleCode('M000124-source');return false;">[Source]</a></p>
 192           <div class="method-source-code" id="M000124-source">
 193 <pre>
 194 <span class="ruby-comment cmt"># File lib/git/path.rb, line 18</span>
 195     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">writable?</span>
 196       <span class="ruby-constant">File</span>.<span class="ruby-identifier">writable?</span>(<span class="ruby-ivar">@path</span>)
 197     <span class="ruby-keyword kw">end</span>
 198 </pre>
 199           </div>
 200         </div>
 201       </div>
 202
 203
 204     </div>
 205
 206
 207   </div>
 208
 209
 210 <div id="validator-badges">
 211   <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
 212 </div>
 213
 214 </body>
 215 </html>