doc/classes/MCollective/Data/Result.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: MCollective::Data::Result</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">MCollective::Data::Result</td>
  54         </tr>
  55         <tr class="top-aligned-row">
  56             <td><strong>In:</strong></td>
  57             <td>
  58                 <a href="../../../files/lib/mcollective/data/result_rb.html">
  59                 lib/mcollective/data/result.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="#M000233">[]</a>&nbsp;&nbsp;
  90       <a href="#M000234">[]=</a>&nbsp;&nbsp;
  91       <a href="#M000232">include?</a>&nbsp;&nbsp;
  92       <a href="#M000235">keys</a>&nbsp;&nbsp;
  93       <a href="#M000236">method_missing</a>&nbsp;&nbsp;
  94       <a href="#M000231">new</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
 110
 111
 112     <!-- if method_list -->
 113     <div id="methods">
 114       <h3 class="section-bar">Public Class methods</h3>
 115
 116       <div id="method-M000231" class="method-detail">
 117         <a name="M000231"></a>
 118
 119         <div class="method-heading">
 120           <a href="#M000231" class="method-signature">
 121           <span class="method-name">new</span><span class="method-args">(outputs)</span>
 122           </a>
 123         </div>
 124
 125         <div class="method-description">
 126           <p><a class="source-toggle" href="#"
 127             onclick="toggleCode('M000231-source');return false;">[Source]</a></p>
 128           <div class="method-source-code" id="M000231-source">
 129 <pre>
 130     <span class="ruby-comment cmt"># File lib/mcollective/data/result.rb, line 9</span>
 131  9:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">outputs</span>)
 132 10:         <span class="ruby-ivar">@data</span> = {}
 133 11:
 134 12:         <span class="ruby-identifier">outputs</span>.<span class="ruby-identifier">keys</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">output</span><span class="ruby-operator">|</span>
 135 13:           <span class="ruby-ivar">@data</span>[<span class="ruby-identifier">output</span>] = <span class="ruby-constant">Marshal</span>.<span class="ruby-identifier">load</span>(<span class="ruby-constant">Marshal</span>.<span class="ruby-identifier">dump</span>(<span class="ruby-identifier">outputs</span>[<span class="ruby-identifier">output</span>].<span class="ruby-identifier">fetch</span>(<span class="ruby-identifier">:default</span>, <span class="ruby-keyword kw">nil</span>)))
 136 14:         <span class="ruby-keyword kw">end</span>
 137 15:       <span class="ruby-keyword kw">end</span>
 138 </pre>
 139           </div>
 140         </div>
 141       </div>
 142
 143       <h3 class="section-bar">Public Instance methods</h3>
 144
 145       <div id="method-M000233" class="method-detail">
 146         <a name="M000233"></a>
 147
 148         <div class="method-heading">
 149           <a href="#M000233" class="method-signature">
 150           <span class="method-name">[]</span><span class="method-args">(key)</span>
 151           </a>
 152         </div>
 153
 154         <div class="method-description">
 155           <p><a class="source-toggle" href="#"
 156             onclick="toggleCode('M000233-source');return false;">[Source]</a></p>
 157           <div class="method-source-code" id="M000233-source">
 158 <pre>
 159     <span class="ruby-comment cmt"># File lib/mcollective/data/result.rb, line 21</span>
 160 21:       <span class="ruby-keyword kw">def</span> <span class="ruby-operator">[]</span>(<span class="ruby-identifier">key</span>)
 161 22:         <span class="ruby-ivar">@data</span>[<span class="ruby-identifier">key</span>.<span class="ruby-identifier">to_sym</span>]
 162 23:       <span class="ruby-keyword kw">end</span>
 163 </pre>
 164           </div>
 165         </div>
 166       </div>
 167
 168       <div id="method-M000234" class="method-detail">
 169         <a name="M000234"></a>
 170
 171         <div class="method-heading">
 172           <a href="#M000234" class="method-signature">
 173           <span class="method-name">[]=</span><span class="method-args">(key, val)</span>
 174           </a>
 175         </div>
 176
 177         <div class="method-description">
 178           <p><a class="source-toggle" href="#"
 179             onclick="toggleCode('M000234-source');return false;">[Source]</a></p>
 180           <div class="method-source-code" id="M000234-source">
 181 <pre>
 182     <span class="ruby-comment cmt"># File lib/mcollective/data/result.rb, line 25</span>
 183 25:       <span class="ruby-keyword kw">def</span> <span class="ruby-operator">[]=</span>(<span class="ruby-identifier">key</span>, <span class="ruby-identifier">val</span>)
 184 26:         <span class="ruby-identifier">raise</span> <span class="ruby-node">&quot;Can only store String, Integer, Float or Boolean data but got #{val.class} for key #{key}&quot;</span> <span class="ruby-keyword kw">unless</span> [<span class="ruby-constant">String</span>, <span class="ruby-constant">Fixnum</span>, <span class="ruby-constant">Bignum</span>, <span class="ruby-constant">Float</span>, <span class="ruby-constant">TrueClass</span>, <span class="ruby-constant">FalseClass</span>].<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">val</span>.<span class="ruby-identifier">class</span>)
 185 27:
 186 28:         <span class="ruby-ivar">@data</span>[<span class="ruby-identifier">key</span>.<span class="ruby-identifier">to_sym</span>] = <span class="ruby-identifier">val</span>
 187 29:       <span class="ruby-keyword kw">end</span>
 188 </pre>
 189           </div>
 190         </div>
 191       </div>
 192
 193       <div id="method-M000232" class="method-detail">
 194         <a name="M000232"></a>
 195
 196         <div class="method-heading">
 197           <a href="#M000232" class="method-signature">
 198           <span class="method-name">include?</span><span class="method-args">(key)</span>
 199           </a>
 200         </div>
 201
 202         <div class="method-description">
 203           <p><a class="source-toggle" href="#"
 204             onclick="toggleCode('M000232-source');return false;">[Source]</a></p>
 205           <div class="method-source-code" id="M000232-source">
 206 <pre>
 207     <span class="ruby-comment cmt"># File lib/mcollective/data/result.rb, line 17</span>
 208 17:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">include?</span>(<span class="ruby-identifier">key</span>)
 209 18:         <span class="ruby-ivar">@data</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">key</span>.<span class="ruby-identifier">to_sym</span>)
 210 19:       <span class="ruby-keyword kw">end</span>
 211 </pre>
 212           </div>
 213         </div>
 214       </div>
 215
 216       <div id="method-M000235" class="method-detail">
 217         <a name="M000235"></a>
 218
 219         <div class="method-heading">
 220           <a href="#M000235" class="method-signature">
 221           <span class="method-name">keys</span><span class="method-args">()</span>
 222           </a>
 223         </div>
 224
 225         <div class="method-description">
 226           <p><a class="source-toggle" href="#"
 227             onclick="toggleCode('M000235-source');return false;">[Source]</a></p>
 228           <div class="method-source-code" id="M000235-source">
 229 <pre>
 230     <span class="ruby-comment cmt"># File lib/mcollective/data/result.rb, line 31</span>
 231 31:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">keys</span>
 232 32:         <span class="ruby-ivar">@data</span>.<span class="ruby-identifier">keys</span>
 233 33:       <span class="ruby-keyword kw">end</span>
 234 </pre>
 235           </div>
 236         </div>
 237       </div>
 238
 239       <div id="method-M000236" class="method-detail">
 240         <a name="M000236"></a>
 241
 242         <div class="method-heading">
 243           <a href="#M000236" class="method-signature">
 244           <span class="method-name">method_missing</span><span class="method-args">(method, *args)</span>
 245           </a>
 246         </div>
 247
 248         <div class="method-description">
 249           <p><a class="source-toggle" href="#"
 250             onclick="toggleCode('M000236-source');return false;">[Source]</a></p>
 251           <div class="method-source-code" id="M000236-source">
 252 <pre>
 253     <span class="ruby-comment cmt"># File lib/mcollective/data/result.rb, line 35</span>
 254 35:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">method_missing</span>(<span class="ruby-identifier">method</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
 255 36:         <span class="ruby-identifier">key</span> = <span class="ruby-identifier">method</span>.<span class="ruby-identifier">to_sym</span>
 256 37:
 257 38:         <span class="ruby-identifier">raise</span> <span class="ruby-constant">NoMethodError</span>, <span class="ruby-value str">&quot;undefined local variable or method `%s'&quot;</span> <span class="ruby-operator">%</span> <span class="ruby-identifier">key</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">include?</span>(<span class="ruby-identifier">key</span>)
 258 39:
 259 40:         <span class="ruby-ivar">@data</span>[<span class="ruby-identifier">key</span>]
 260 41:       <span class="ruby-keyword kw">end</span>
 261 </pre>
 262           </div>
 263         </div>
 264       </div>
 265
 266
 267     </div>
 268
 269
 270   </div>
 271
 272
 273 <div id="validator-badges">
 274   <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
 275 </div>
 276
 277 </body>
 278 </html>