← Back to branch summary

~ubuntu-branches/ubuntu/natty/mcollective/natty-201103250207

« back to all changes in this revision

Viewing changes to doc/classes/MCollective/Util.html

  • Committer: Dustin Kirkland
  • Date: 2011-02-17 19:07:47 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: kirkland@ubuntu.com-20110217190747-yym2bspvdu2nd8hg
Tags: 1.0.1-0ubuntu1
* Merge new upstream release
* debian/mcollective.install: drop unneeded /etc/init.d (we use upstart)
* debian/copyright: use Apache 2.0 header and point to common-license
  file, per Lintian

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/classes/MCollective/Util.html
86
86
      <h3 class="section-bar">Methods</h3>
87
87
 
88
88
      <div class="name-list">
89
 
      <a href="#M000017">empty_filter</a>&nbsp;&nbsp;
90
 
      <a href="#M000016">empty_filter?</a>&nbsp;&nbsp;
91
 
      <a href="#M000013">get_fact</a>&nbsp;&nbsp;
92
 
      <a href="#M000011">has_agent?</a>&nbsp;&nbsp;
93
 
      <a href="#M000012">has_cf_class?</a>&nbsp;&nbsp;
94
 
      <a href="#M000014">has_fact?</a>&nbsp;&nbsp;
95
 
      <a href="#M000015">has_identity?</a>&nbsp;&nbsp;
96
 
      <a href="#M000019">loadclass</a>&nbsp;&nbsp;
97
 
      <a href="#M000018">make_target</a>&nbsp;&nbsp;
 
89
      <a href="#M000019">empty_filter</a>&nbsp;&nbsp;
 
90
      <a href="#M000018">empty_filter?</a>&nbsp;&nbsp;
 
91
      <a href="#M000015">get_fact</a>&nbsp;&nbsp;
 
92
      <a href="#M000013">has_agent?</a>&nbsp;&nbsp;
 
93
      <a href="#M000014">has_cf_class?</a>&nbsp;&nbsp;
 
94
      <a href="#M000016">has_fact?</a>&nbsp;&nbsp;
 
95
      <a href="#M000017">has_identity?</a>&nbsp;&nbsp;
 
96
      <a href="#M000021">loadclass</a>&nbsp;&nbsp;
 
97
      <a href="#M000020">make_target</a>&nbsp;&nbsp;
98
98
      </div>
99
99
    </div>
100
100
 
116
116
    <div id="methods">
117
117
      <h3 class="section-bar">Public Class methods</h3>
118
118
 
119
 
      <div id="method-M000017" class="method-detail">
120
 
        <a name="M000017"></a>
 
119
      <div id="method-M000019" class="method-detail">
 
120
        <a name="M000019"></a>
121
121
 
122
122
        <div class="method-heading">
123
 
          <a href="#M000017" class="method-signature">
 
123
          <a href="#M000019" class="method-signature">
124
124
          <span class="method-name">empty_filter</span><span class="method-args">()</span>
125
125
          </a>
126
126
        </div>
130
130
Creates an empty filter
131
131
</p>
132
132
          <p><a class="source-toggle" href="#"
133
 
            onclick="toggleCode('M000017-source');return false;">[Source]</a></p>
134
 
          <div class="method-source-code" id="M000017-source">
 
133
            onclick="toggleCode('M000019-source');return false;">[Source]</a></p>
 
134
          <div class="method-source-code" id="M000019-source">
135
135
<pre>
136
136
    <span class="ruby-comment cmt"># File lib/mcollective/util.rb, line 91</span>
137
137
91:         <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">empty_filter</span>
145
145
        </div>
146
146
      </div>
147
147
 
148
 
      <div id="method-M000016" class="method-detail">
149
 
        <a name="M000016"></a>
 
148
      <div id="method-M000018" class="method-detail">
 
149
        <a name="M000018"></a>
150
150
 
151
151
        <div class="method-heading">
152
 
          <a href="#M000016" class="method-signature">
 
152
          <a href="#M000018" class="method-signature">
153
153
          <span class="method-name">empty_filter?</span><span class="method-args">(filter)</span>
154
154
          </a>
155
155
        </div>
159
159
Checks if the passed in filter is an empty one
160
160
</p>
161
161
          <p><a class="source-toggle" href="#"
162
 
            onclick="toggleCode('M000016-source');return false;">[Source]</a></p>
163
 
          <div class="method-source-code" id="M000016-source">
 
162
            onclick="toggleCode('M000018-source');return false;">[Source]</a></p>
 
163
          <div class="method-source-code" id="M000018-source">
164
164
<pre>
165
165
    <span class="ruby-comment cmt"># File lib/mcollective/util.rb, line 86</span>
166
166
86:         <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">empty_filter?</span>(<span class="ruby-identifier">filter</span>)
171
171
        </div>
172
172
      </div>
173
173
 
174
 
      <div id="method-M000013" class="method-detail">
175
 
        <a name="M000013"></a>
 
174
      <div id="method-M000015" class="method-detail">
 
175
        <a name="M000015"></a>
176
176
 
177
177
        <div class="method-heading">
178
 
          <a href="#M000013" class="method-signature">
 
178
          <a href="#M000015" class="method-signature">
179
179
          <span class="method-name">get_fact</span><span class="method-args">(fact)</span>
180
180
          </a>
181
181
        </div>
183
183
        <div class="method-description">
184
184
          <p>
185
185
Gets the value of a specific fact, mostly just a duplicate of <a
186
 
href="Facts.html#M000131">MCollective::Facts.get_fact</a> but it kind of
 
186
href="Facts.html#M000133">MCollective::Facts.get_fact</a> but it kind of
187
187
goes with the other classes here
188
188
</p>
189
189
          <p><a class="source-toggle" href="#"
190
 
            onclick="toggleCode('M000013-source');return false;">[Source]</a></p>
191
 
          <div class="method-source-code" id="M000013-source">
 
190
            onclick="toggleCode('M000015-source');return false;">[Source]</a></p>
 
191
          <div class="method-source-code" id="M000015-source">
192
192
<pre>
193
193
    <span class="ruby-comment cmt"># File lib/mcollective/util.rb, line 49</span>
194
194
49:         <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">get_fact</span>(<span class="ruby-identifier">fact</span>)
199
199
        </div>
200
200
      </div>
201
201
 
202
 
      <div id="method-M000011" class="method-detail">
203
 
        <a name="M000011"></a>
 
202
      <div id="method-M000013" class="method-detail">
 
203
        <a name="M000013"></a>
204
204
 
205
205
        <div class="method-heading">
206
 
          <a href="#M000011" class="method-signature">
 
206
          <a href="#M000013" class="method-signature">
207
207
          <span class="method-name">has_agent?</span><span class="method-args">(agent)</span>
208
208
          </a>
209
209
        </div>
218
218
use regex to match
219
219
</p>
220
220
          <p><a class="source-toggle" href="#"
221
 
            onclick="toggleCode('M000011-source');return false;">[Source]</a></p>
222
 
          <div class="method-source-code" id="M000011-source">
 
221
            onclick="toggleCode('M000013-source');return false;">[Source]</a></p>
 
222
          <div class="method-source-code" id="M000013-source">
223
223
<pre>
224
224
    <span class="ruby-comment cmt"># File lib/mcollective/util.rb, line 8</span>
225
225
 8:         <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">has_agent?</span>(<span class="ruby-identifier">agent</span>)
242
242
        </div>
243
243
      </div>
244
244
 
245
 
      <div id="method-M000012" class="method-detail">
246
 
        <a name="M000012"></a>
 
245
      <div id="method-M000014" class="method-detail">
 
246
        <a name="M000014"></a>
247
247
 
248
248
        <div class="method-heading">
249
 
          <a href="#M000012" class="method-signature">
 
249
          <a href="#M000014" class="method-signature">
250
250
          <span class="method-name">has_cf_class?</span><span class="method-args">(klass)</span>
251
251
          </a>
252
252
        </div>
262
262
use regex to match
263
263
</p>
264
264
          <p><a class="source-toggle" href="#"
265
 
            onclick="toggleCode('M000012-source');return false;">[Source]</a></p>
266
 
          <div class="method-source-code" id="M000012-source">
 
265
            onclick="toggleCode('M000014-source');return false;">[Source]</a></p>
 
266
          <div class="method-source-code" id="M000014-source">
267
267
<pre>
268
268
    <span class="ruby-comment cmt"># File lib/mcollective/util.rb, line 30</span>
269
269
30:         <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">has_cf_class?</span>(<span class="ruby-identifier">klass</span>)
287
287
        </div>
288
288
      </div>
289
289
 
290
 
      <div id="method-M000014" class="method-detail">
291
 
        <a name="M000014"></a>
 
290
      <div id="method-M000016" class="method-detail">
 
291
        <a name="M000016"></a>
292
292
 
293
293
        <div class="method-heading">
294
 
          <a href="#M000014" class="method-signature">
 
294
          <a href="#M000016" class="method-signature">
295
295
          <span class="method-name">has_fact?</span><span class="method-args">(fact, value)</span>
296
296
          </a>
297
297
        </div>
305
305
use regex to match
306
306
</p>
307
307
          <p><a class="source-toggle" href="#"
308
 
            onclick="toggleCode('M000014-source');return false;">[Source]</a></p>
309
 
          <div class="method-source-code" id="M000014-source">
 
308
            onclick="toggleCode('M000016-source');return false;">[Source]</a></p>
 
309
          <div class="method-source-code" id="M000016-source">
310
310
<pre>
311
311
    <span class="ruby-comment cmt"># File lib/mcollective/util.rb, line 57</span>
312
312
57:         <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">has_fact?</span>(<span class="ruby-identifier">fact</span>, <span class="ruby-identifier">value</span>)
325
325
        </div>
326
326
      </div>
327
327
 
328
 
      <div id="method-M000015" class="method-detail">
329
 
        <a name="M000015"></a>
 
328
      <div id="method-M000017" class="method-detail">
 
329
        <a name="M000017"></a>
330
330
 
331
331
        <div class="method-heading">
332
 
          <a href="#M000015" class="method-signature">
 
332
          <a href="#M000017" class="method-signature">
333
333
          <span class="method-name">has_identity?</span><span class="method-args">(identity)</span>
334
334
          </a>
335
335
        </div>
343
343
use regex to match
344
344
</p>
345
345
          <p><a class="source-toggle" href="#"
346
 
            onclick="toggleCode('M000015-source');return false;">[Source]</a></p>
347
 
          <div class="method-source-code" id="M000015-source">
 
346
            onclick="toggleCode('M000017-source');return false;">[Source]</a></p>
 
347
          <div class="method-source-code" id="M000017-source">
348
348
<pre>
349
349
    <span class="ruby-comment cmt"># File lib/mcollective/util.rb, line 73</span>
350
350
73:         <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">has_identity?</span>(<span class="ruby-identifier">identity</span>)
363
363
        </div>
364
364
      </div>
365
365
 
366
 
      <div id="method-M000019" class="method-detail">
367
 
        <a name="M000019"></a>
 
366
      <div id="method-M000021" class="method-detail">
 
367
        <a name="M000021"></a>
368
368
 
369
369
        <div class="method-heading">
370
 
          <a href="#M000019" class="method-signature">
 
370
          <a href="#M000021" class="method-signature">
371
371
          <span class="method-name">loadclass</span><span class="method-args">(klass)</span>
372
372
          </a>
373
373
        </div>
375
375
        <div class="method-description">
376
376
          <p>
377
377
Wrapper around <a
378
 
href="PluginManager.html#M000043">PluginManager.loadclass</a>
 
378
href="PluginManager.html#M000045">PluginManager.loadclass</a>
379
379
</p>
380
380
          <p><a class="source-toggle" href="#"
381
 
            onclick="toggleCode('M000019-source');return false;">[Source]</a></p>
382
 
          <div class="method-source-code" id="M000019-source">
 
381
            onclick="toggleCode('M000021-source');return false;">[Source]</a></p>
 
382
          <div class="method-source-code" id="M000021-source">
383
383
<pre>
384
384
     <span class="ruby-comment cmt"># File lib/mcollective/util.rb, line 108</span>
385
385
108:         <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">loadclass</span>(<span class="ruby-identifier">klass</span>)
390
390
        </div>
391
391
      </div>
392
392
 
393
 
      <div id="method-M000018" class="method-detail">
394
 
        <a name="M000018"></a>
 
393
      <div id="method-M000020" class="method-detail">
 
394
        <a name="M000020"></a>
395
395
 
396
396
        <div class="method-heading">
397
 
          <a href="#M000018" class="method-signature">
 
397
          <a href="#M000020" class="method-signature">
398
398
          <span class="method-name">make_target</span><span class="method-args">(agent, type)</span>
399
399
          </a>
400
400
        </div>
405
405
options
406
406
</p>
407
407
          <p><a class="source-toggle" href="#"
408
 
            onclick="toggleCode('M000018-source');return false;">[Source]</a></p>
409
 
          <div class="method-source-code" id="M000018-source">
 
408
            onclick="toggleCode('M000020-source');return false;">[Source]</a></p>
 
409
          <div class="method-source-code" id="M000020-source">
410
410
<pre>
411
411
     <span class="ruby-comment cmt"># File lib/mcollective/util.rb, line 99</span>
412
412
 99:         <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">make_target</span>(<span class="ruby-identifier">agent</span>, <span class="ruby-identifier">type</span>)