1 <?xml version="1.0" encoding="iso-8859-1"?>
3 PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
6 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
8 <title>Class: MCollective::CodedError</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">
15 function popupCode( url ) {
16 window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
19 function toggleCode( id ) {
20 if ( document.getElementById )
21 elem = document.getElementById( id );
22 else if ( document.all )
23 elem = eval( "document.all." + id );
27 elemStyle = elem.style;
29 if ( elemStyle.display != "block" ) {
30 elemStyle.display = "block"
32 elemStyle.display = "none"
38 // Make codeblocks hidden by default
39 document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
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::CodedError</td>
55 <tr class="top-aligned-row">
56 <td><strong>In:</strong></td>
58 <a href="../../files/lib/mcollective/exception_rb.html">
59 lib/mcollective/exception.rb
65 <tr class="top-aligned-row">
66 <td><strong>Parent:</strong></td>
73 <!-- banner header -->
75 <div id="bodyContent">
79 <div id="contextContent">
85 <div id="method-list">
86 <h3 class="section-bar">Methods</h3>
88 <div class="name-list">
89 <a href="#M000331">log</a>
90 <a href="#M000329">new</a>
91 <a href="#M000330">set_backtrace</a>
106 <div id="attribute-list">
107 <h3 class="section-bar">Attributes</h3>
109 <div class="name-list">
111 <tr class="top-aligned-row context-row">
112 <td class="context-item-name">args</td>
113 <td class="context-item-value"> [R] </td>
114 <td class="context-item-desc"></td>
116 <tr class="top-aligned-row context-row">
117 <td class="context-item-name">code</td>
118 <td class="context-item-value"> [R] </td>
119 <td class="context-item-desc"></td>
121 <tr class="top-aligned-row context-row">
122 <td class="context-item-name">default</td>
123 <td class="context-item-value"> [R] </td>
124 <td class="context-item-desc"></td>
126 <tr class="top-aligned-row context-row">
127 <td class="context-item-name">log_level</td>
128 <td class="context-item-value"> [R] </td>
129 <td class="context-item-desc"></td>
137 <!-- if method_list -->
139 <h3 class="section-bar">Public Class methods</h3>
141 <div id="method-M000329" class="method-detail">
142 <a name="M000329"></a>
144 <div class="method-heading">
145 <a href="#M000329" class="method-signature">
146 <span class="method-name">new</span><span class="method-args">(msgid, default, level=:debug, args={})</span>
150 <div class="method-description">
151 <p><a class="source-toggle" href="#"
152 onclick="toggleCode('M000329-source');return false;">[Source]</a></p>
153 <div class="method-source-code" id="M000329-source">
155 <span class="ruby-comment cmt"># File lib/mcollective/exception.rb, line 5</span>
156 5: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">msgid</span>, <span class="ruby-identifier">default</span>, <span class="ruby-identifier">level</span>=<span class="ruby-identifier">:debug</span>, <span class="ruby-identifier">args</span>={})
157 6: <span class="ruby-ivar">@code</span> = <span class="ruby-identifier">msgid</span>
158 7: <span class="ruby-ivar">@log_level</span> = <span class="ruby-identifier">level</span>
159 8: <span class="ruby-ivar">@args</span> = <span class="ruby-identifier">args</span>
160 9: <span class="ruby-ivar">@default</span> = <span class="ruby-identifier">default</span>
162 11: <span class="ruby-identifier">msg</span> = <span class="ruby-constant">Util</span>.<span class="ruby-identifier">t</span>(<span class="ruby-ivar">@code</span>, {<span class="ruby-identifier">:default</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">default</span>}.<span class="ruby-identifier">merge</span>(<span class="ruby-ivar">@args</span>))
164 13: <span class="ruby-keyword kw">super</span>(<span class="ruby-identifier">msg</span>)
165 14: <span class="ruby-keyword kw">end</span>
171 <h3 class="section-bar">Public Instance methods</h3>
173 <div id="method-M000331" class="method-detail">
174 <a name="M000331"></a>
176 <div class="method-heading">
177 <a href="#M000331" class="method-signature">
178 <span class="method-name">log</span><span class="method-args">(level, log_backtrace=false)</span>
182 <div class="method-description">
183 <p><a class="source-toggle" href="#"
184 onclick="toggleCode('M000331-source');return false;">[Source]</a></p>
185 <div class="method-source-code" id="M000331-source">
187 <span class="ruby-comment cmt"># File lib/mcollective/exception.rb, line 21</span>
188 21: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">log</span>(<span class="ruby-identifier">level</span>, <span class="ruby-identifier">log_backtrace</span>=<span class="ruby-keyword kw">false</span>)
189 22: <span class="ruby-constant">Log</span>.<span class="ruby-identifier">logexception</span>(<span class="ruby-ivar">@code</span>, <span class="ruby-identifier">level</span>, <span class="ruby-keyword kw">self</span>, <span class="ruby-identifier">log_backtrace</span>)
190 23: <span class="ruby-keyword kw">end</span>
196 <div id="method-M000330" class="method-detail">
197 <a name="M000330"></a>
199 <div class="method-heading">
200 <a href="#M000330" class="method-signature">
201 <span class="method-name">set_backtrace</span><span class="method-args">(trace)</span>
205 <div class="method-description">
206 <p><a class="source-toggle" href="#"
207 onclick="toggleCode('M000330-source');return false;">[Source]</a></p>
208 <div class="method-source-code" id="M000330-source">
210 <span class="ruby-comment cmt"># File lib/mcollective/exception.rb, line 16</span>
211 16: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">set_backtrace</span>(<span class="ruby-identifier">trace</span>)
212 17: <span class="ruby-keyword kw">super</span>
213 18: <span class="ruby-identifier">log</span>(<span class="ruby-ivar">@log_level</span>)
214 19: <span class="ruby-keyword kw">end</span>
227 <div id="validator-badges">
228 <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>