Update version according to OSCI-883
[packages/precise/mcollective.git] / doc / Symbol.html
1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
3         "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5 <head>
6         <meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
7
8         <title>Class: Symbol</title>
9
10         <link rel="stylesheet" href="./rdoc.css" type="text/css" media="screen" />
11
12         <script src="./js/jquery.js" type="text/javascript"
13                 charset="utf-8"></script>
14         <script src="./js/thickbox-compressed.js" type="text/javascript"
15                 charset="utf-8"></script>
16         <script src="./js/quicksearch.js" type="text/javascript"
17                 charset="utf-8"></script>
18         <script src="./js/darkfish.js" type="text/javascript"
19                 charset="utf-8"></script>
20
21 </head>
22 <body class="class">
23
24         <div id="metadata">
25                 <div id="file-metadata">
26                         <div id="file-list-section" class="section">
27                                 <h3 class="section-header">In Files</h3>
28                                 <div class="section-body">
29                                         <ul>
30                                         
31                                                 <li><a href="./lib/mcollective/monkey_patches_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
32                                                         class="thickbox" title="lib/mcollective/monkey_patches.rb">lib/mcollective/monkey_patches.rb</a></li>
33                                         
34                                         </ul>
35                                 </div>
36                         </div>
37
38                         
39                 </div>
40
41                 <div id="class-metadata">
42
43                         <!-- Parent Class -->
44                         
45                         <div id="parent-class-section" class="section">
46                                 <h3 class="section-header">Parent</h3>
47                                 
48                                 <p class="link"><a href="Object.html">Object</a></p>
49                                 
50                         </div>
51                         
52
53                         <!-- Namespace Contents -->
54                         
55
56                         <!-- Method Quickref -->
57                         
58                         <div id="method-list-section" class="section">
59                                 <h3 class="section-header">Methods</h3>
60                                 <ul class="link-list">
61                                         
62                                         <li><a href="#M000199">#<=></a></li>
63                                         
64                                 </ul>
65                         </div>
66                         
67
68                         <!-- Included Modules -->
69                         
70                         <div id="includes-section" class="section">
71                                 <h3 class="section-header">Included Modules</h3>
72                                 <ul class="link-list">
73                                 
74                                 
75                                         <li><span class="include">Comparable</span></li>
76                                 
77                                 
78                                 </ul>
79                         </div>
80                         
81                 </div>
82
83                 <div id="project-metadata">
84                         
85                         
86                         <div id="fileindex-section" class="section project-section">
87                                 <h3 class="section-header">Files</h3>
88                                 <ul>
89                                 
90                                         <li class="file"><a href="./COPYING.html">COPYING</a></li>
91                                 
92                                         <li class="file"><a href="./Gemfile.html">Gemfile</a></li>
93                                 
94                                         <li class="file"><a href="./README.html">README</a></li>
95                                 
96                                         <li class="file"><a href="./Rakefile.html">Rakefile</a></li>
97                                 
98                                         <li class="file"><a href="./etc/client_cfg_dist.html">client.cfg.dist</a></li>
99                                 
100                                         <li class="file"><a href="./etc/data-help_erb.html">data-help.erb</a></li>
101                                 
102                                         <li class="file"><a href="./etc/discovery-help_erb.html">discovery-help.erb</a></li>
103                                 
104                                         <li class="file"><a href="./etc/facts_yaml_dist.html">facts.yaml.dist</a></li>
105                                 
106                                         <li class="file"><a href="./etc/metadata-help_erb.html">metadata-help.erb</a></li>
107                                 
108                                         <li class="file"><a href="./etc/msg-help_erb.html">msg-help.erb</a></li>
109                                 
110                                         <li class="file"><a href="./etc/rpc-help_erb.html">rpc-help.erb</a></li>
111                                 
112                                         <li class="file"><a href="./etc/server_cfg_dist.html">server.cfg.dist</a></li>
113                                 
114                                         <li class="file"><a href="./etc/ssl/PLACEHOLDER.html">PLACEHOLDER</a></li>
115                                 
116                                         <li class="file"><a href="./etc/ssl/clients/PLACEHOLDER.html">PLACEHOLDER</a></li>
117                                 
118                                         <li class="file"><a href="./lib/mcollective/generators/templates/action_snippet_erb.html">action_snippet.erb</a></li>
119                                 
120                                         <li class="file"><a href="./lib/mcollective/generators/templates/data_input_snippet_erb.html">data_input_snippet.erb</a></li>
121                                 
122                                         <li class="file"><a href="./lib/mcollective/generators/templates/ddl_erb.html">ddl.erb</a></li>
123                                 
124                                         <li class="file"><a href="./lib/mcollective/generators/templates/plugin_erb.html">plugin.erb</a></li>
125                                 
126                                         <li class="file"><a href="./lib/mcollective/locales/en_yml.html">en.yml</a></li>
127                                 
128                                         <li class="file"><a href="./mcollective_init.html">mcollective.init</a></li>
129                                 
130                                 </ul>
131                         </div>
132                         
133
134                         <div id="classindex-section" class="section project-section">
135                                 <h3 class="section-header">Class Index
136                                         <span class="search-toggle"><img src="./images/find.png"
137                                                 height="16" width="16" alt="[+]"
138                                                 title="show/hide quicksearch" /></span></h3>
139                                 <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
140                                 <fieldset>
141                                         <legend>Quicksearch</legend>
142                                         <input type="text" name="quicksearch" value=""
143                                                 class="quicksearch-field" />
144                                 </fieldset>
145                                 </form>
146
147                                 <ul class="link-list">
148                                 
149                                         <li><a href="./MCollective.html">MCollective</a></li>
150                                 
151                                         <li><a href="./MCollective/Agent.html">MCollective::Agent</a></li>
152                                 
153                                         <li><a href="./MCollective/Agents.html">MCollective::Agents</a></li>
154                                 
155                                         <li><a href="./MCollective/Aggregate.html">MCollective::Aggregate</a></li>
156                                 
157                                         <li><a href="./MCollective/Aggregate/Base.html">MCollective::Aggregate::Base</a></li>
158                                 
159                                         <li><a href="./MCollective/Aggregate/Result.html">MCollective::Aggregate::Result</a></li>
160                                 
161                                         <li><a href="./MCollective/Aggregate/Result/Base.html">MCollective::Aggregate::Result::Base</a></li>
162                                 
163                                         <li><a href="./MCollective/Aggregate/Result/CollectionResult.html">MCollective::Aggregate::Result::CollectionResult</a></li>
164                                 
165                                         <li><a href="./MCollective/Aggregate/Result/NumericResult.html">MCollective::Aggregate::Result::NumericResult</a></li>
166                                 
167                                         <li><a href="./MCollective/Application.html">MCollective::Application</a></li>
168                                 
169                                         <li><a href="./MCollective/Applications.html">MCollective::Applications</a></li>
170                                 
171                                         <li><a href="./MCollective/Cache.html">MCollective::Cache</a></li>
172                                 
173                                         <li><a href="./MCollective/Client.html">MCollective::Client</a></li>
174                                 
175                                         <li><a href="./MCollective/CodedError.html">MCollective::CodedError</a></li>
176                                 
177                                         <li><a href="./MCollective/Config.html">MCollective::Config</a></li>
178                                 
179                                         <li><a href="./MCollective/Connector.html">MCollective::Connector</a></li>
180                                 
181                                         <li><a href="./MCollective/Connector/Base.html">MCollective::Connector::Base</a></li>
182                                 
183                                         <li><a href="./MCollective/DDL.html">MCollective::DDL</a></li>
184                                 
185                                         <li><a href="./MCollective/DDL/AgentDDL.html">MCollective::DDL::AgentDDL</a></li>
186                                 
187                                         <li><a href="./MCollective/DDL/Base.html">MCollective::DDL::Base</a></li>
188                                 
189                                         <li><a href="./MCollective/DDL/DataDDL.html">MCollective::DDL::DataDDL</a></li>
190                                 
191                                         <li><a href="./MCollective/DDL/DiscoveryDDL.html">MCollective::DDL::DiscoveryDDL</a></li>
192                                 
193                                         <li><a href="./MCollective/DDL/ValidatorDDL.html">MCollective::DDL::ValidatorDDL</a></li>
194                                 
195                                         <li><a href="./MCollective/DDLValidationError.html">MCollective::DDLValidationError</a></li>
196                                 
197                                         <li><a href="./MCollective/Data.html">MCollective::Data</a></li>
198                                 
199                                         <li><a href="./MCollective/Data/Base.html">MCollective::Data::Base</a></li>
200                                 
201                                         <li><a href="./MCollective/Data/Result.html">MCollective::Data::Result</a></li>
202                                 
203                                         <li><a href="./MCollective/Discovery.html">MCollective::Discovery</a></li>
204                                 
205                                         <li><a href="./MCollective/Facts.html">MCollective::Facts</a></li>
206                                 
207                                         <li><a href="./MCollective/Facts/Base.html">MCollective::Facts::Base</a></li>
208                                 
209                                         <li><a href="./MCollective/Generators.html">MCollective::Generators</a></li>
210                                 
211                                         <li><a href="./MCollective/Generators/AgentGenerator.html">MCollective::Generators::AgentGenerator</a></li>
212                                 
213                                         <li><a href="./MCollective/Generators/Base.html">MCollective::Generators::Base</a></li>
214                                 
215                                         <li><a href="./MCollective/Generators/DataGenerator.html">MCollective::Generators::DataGenerator</a></li>
216                                 
217                                         <li><a href="./MCollective/InvalidRPCData.html">MCollective::InvalidRPCData</a></li>
218                                 
219                                         <li><a href="./MCollective/Log.html">MCollective::Log</a></li>
220                                 
221                                         <li><a href="./MCollective/Logger.html">MCollective::Logger</a></li>
222                                 
223                                         <li><a href="./MCollective/Logger/Base.html">MCollective::Logger::Base</a></li>
224                                 
225                                         <li><a href="./MCollective/Logger/Console_logger.html">MCollective::Logger::Console_logger</a></li>
226                                 
227                                         <li><a href="./MCollective/Logger/File_logger.html">MCollective::Logger::File_logger</a></li>
228                                 
229                                         <li><a href="./MCollective/Logger/Syslog_logger.html">MCollective::Logger::Syslog_logger</a></li>
230                                 
231                                         <li><a href="./MCollective/Matcher.html">MCollective::Matcher</a></li>
232                                 
233                                         <li><a href="./MCollective/Matcher/Parser.html">MCollective::Matcher::Parser</a></li>
234                                 
235                                         <li><a href="./MCollective/Matcher/Scanner.html">MCollective::Matcher::Scanner</a></li>
236                                 
237                                         <li><a href="./MCollective/Message.html">MCollective::Message</a></li>
238                                 
239                                         <li><a href="./MCollective/MissingRPCData.html">MCollective::MissingRPCData</a></li>
240                                 
241                                         <li><a href="./MCollective/MsgDoesNotMatchRequestID.html">MCollective::MsgDoesNotMatchRequestID</a></li>
242                                 
243                                         <li><a href="./MCollective/MsgTTLExpired.html">MCollective::MsgTTLExpired</a></li>
244                                 
245                                         <li><a href="./MCollective/NotTargettedAtUs.html">MCollective::NotTargettedAtUs</a></li>
246                                 
247                                         <li><a href="./MCollective/Optionparser.html">MCollective::Optionparser</a></li>
248                                 
249                                         <li><a href="./MCollective/PluginManager.html">MCollective::PluginManager</a></li>
250                                 
251                                         <li><a href="./MCollective/PluginPackager.html">MCollective::PluginPackager</a></li>
252                                 
253                                         <li><a href="./MCollective/PluginPackager/AgentDefinition.html">MCollective::PluginPackager::AgentDefinition</a></li>
254                                 
255                                         <li><a href="./MCollective/PluginPackager/StandardDefinition.html">MCollective::PluginPackager::StandardDefinition</a></li>
256                                 
257                                         <li><a href="./MCollective/RPC.html">MCollective::RPC</a></li>
258                                 
259                                         <li><a href="./MCollective/RPC/ActionRunner.html">MCollective::RPC::ActionRunner</a></li>
260                                 
261                                         <li><a href="./MCollective/RPC/Agent.html">MCollective::RPC::Agent</a></li>
262                                 
263                                         <li><a href="./MCollective/RPC/Audit.html">MCollective::RPC::Audit</a></li>
264                                 
265                                         <li><a href="./MCollective/RPC/Client.html">MCollective::RPC::Client</a></li>
266                                 
267                                         <li><a href="./MCollective/RPC/Helpers.html">MCollective::RPC::Helpers</a></li>
268                                 
269                                         <li><a href="./MCollective/RPC/Progress.html">MCollective::RPC::Progress</a></li>
270                                 
271                                         <li><a href="./MCollective/RPC/Reply.html">MCollective::RPC::Reply</a></li>
272                                 
273                                         <li><a href="./MCollective/RPC/Request.html">MCollective::RPC::Request</a></li>
274                                 
275                                         <li><a href="./MCollective/RPC/Result.html">MCollective::RPC::Result</a></li>
276                                 
277                                         <li><a href="./MCollective/RPC/Stats.html">MCollective::RPC::Stats</a></li>
278                                 
279                                         <li><a href="./MCollective/RPCAborted.html">MCollective::RPCAborted</a></li>
280                                 
281                                         <li><a href="./MCollective/RPCError.html">MCollective::RPCError</a></li>
282                                 
283                                         <li><a href="./MCollective/Registration.html">MCollective::Registration</a></li>
284                                 
285                                         <li><a href="./MCollective/Registration/Base.html">MCollective::Registration::Base</a></li>
286                                 
287                                         <li><a href="./MCollective/Runner.html">MCollective::Runner</a></li>
288                                 
289                                         <li><a href="./MCollective/RunnerStats.html">MCollective::RunnerStats</a></li>
290                                 
291                                         <li><a href="./MCollective/SSL.html">MCollective::SSL</a></li>
292                                 
293                                         <li><a href="./MCollective/Security.html">MCollective::Security</a></li>
294                                 
295                                         <li><a href="./MCollective/Security/Base.html">MCollective::Security::Base</a></li>
296                                 
297                                         <li><a href="./MCollective/SecurityValidationFailed.html">MCollective::SecurityValidationFailed</a></li>
298                                 
299                                         <li><a href="./MCollective/Shell.html">MCollective::Shell</a></li>
300                                 
301                                         <li><a href="./MCollective/Translatable.html">MCollective::Translatable</a></li>
302                                 
303                                         <li><a href="./MCollective/UnixDaemon.html">MCollective::UnixDaemon</a></li>
304                                 
305                                         <li><a href="./MCollective/UnknownRPCAction.html">MCollective::UnknownRPCAction</a></li>
306                                 
307                                         <li><a href="./MCollective/UnknownRPCError.html">MCollective::UnknownRPCError</a></li>
308                                 
309                                         <li><a href="./MCollective/Util.html">MCollective::Util</a></li>
310                                 
311                                         <li><a href="./MCollective/Validator.html">MCollective::Validator</a></li>
312                                 
313                                         <li><a href="./MCollective/ValidatorError.html">MCollective::ValidatorError</a></li>
314                                 
315                                         <li><a href="./MCollective/WindowsDaemon.html">MCollective::WindowsDaemon</a></li>
316                                 
317                                         <li><a href="./Array.html">Array</a></li>
318                                 
319                                         <li><a href="./Dir.html">Dir</a></li>
320                                 
321                                         <li><a href="./Object.html">Object</a></li>
322                                 
323                                         <li><a href="./String.html">String</a></li>
324                                 
325                                         <li><a href="./Symbol.html">Symbol</a></li>
326                                 
327                                 </ul>
328                                 <div id="no-class-search-results" style="display: none;">No matching classes.</div>
329                         </div>
330
331                         
332                 </div>
333         </div>
334
335         <div id="documentation">
336                 <h1 class="class">Symbol</h1>
337
338                 <div id="description">
339                         <p>
340 Make arrays of Symbols sortable
341 </p>
342
343                 </div>
344
345                 <!-- Constants -->
346                 
347
348                 <!-- Attributes -->
349                 
350
351                 <!-- Methods -->
352                 
353                 <div id="public-instance-method-details" class="method-section section">
354                         <h3 class="section-header">Public Instance Methods</h3>
355
356                 
357                         <div id="--method" class="method-detail ">
358                                 <a name="M000199"></a>
359
360                                 <div class="method-heading">
361                                 
362                                         <span class="method-name">&lt;=&gt;</span><span
363                                                 class="method-args">(other)</span>
364                                         <span class="method-click-advice">click to toggle source</span>
365                                 
366                                 </div>
367
368                                 <div class="method-description">
369                                         
370                                         <p class="missing-docs">(Not documented)</p>
371                                         
372
373                                         
374                                         <div class="method-source-code"
375                                                 id="--source">
376 <pre>
377     <span class="ruby-comment cmt"># File lib/mcollective/monkey_patches.rb, line 13</span>
378 13:   <span class="ruby-keyword kw">def</span> <span class="ruby-operator">&lt;=&gt;</span>(<span class="ruby-identifier">other</span>)
379 14:     <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">to_s</span> <span class="ruby-operator">&lt;=&gt;</span> <span class="ruby-identifier">other</span>.<span class="ruby-identifier">to_s</span>
380 15:   <span class="ruby-keyword kw">end</span></pre>
381                                         </div>
382                                         
383                                 </div>
384
385                                 
386                         </div>
387
388                 
389                 </div>
390         
391
392         </div>
393
394
395         <div id="rdoc-debugging-section-dump" class="debugging-section">
396         
397                 <p>Disabled; run with --debug to generate this.</p>
398         
399         </div>
400
401         <div id="validator-badges">
402                 <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
403                 <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
404                         Rdoc Generator</a> 1.1.6</small>.</p>
405         </div>
406
407 </body>
408 </html>
409