log4r 1.1.6 → 1.1.7

Sign up to get free protection for your applications and to get access to all the features.
Files changed (121) hide show
  1. data/README +3 -3
  2. data/Rakefile +2 -2
  3. data/doc/rdoc/Log4r.html +519 -0
  4. data/doc/rdoc/Log4r/BasicFormatter.html +388 -0
  5. data/doc/rdoc/Log4r/ConfigError.html +225 -0
  6. data/doc/rdoc/Log4r/Configurator.html +1068 -0
  7. data/doc/rdoc/Log4r/DateFileOutputter.html +479 -0
  8. data/doc/rdoc/Log4r/DefaultFormatter.html +223 -0
  9. data/doc/rdoc/Log4r/EmailOutputter.html +654 -0
  10. data/doc/rdoc/Log4r/FileOutputter.html +346 -0
  11. data/doc/rdoc/Log4r/Formatter.html +309 -0
  12. data/doc/rdoc/Log4r/GDC.html +346 -0
  13. data/doc/rdoc/Log4r/GDC_rb.html +80 -0
  14. data/doc/rdoc/Log4r/IOOutputter.html +410 -0
  15. data/doc/rdoc/Log4r/Log4jXmlFormatter.html +337 -0
  16. data/doc/rdoc/Log4r/Log4rConfig.html +211 -0
  17. data/doc/rdoc/Log4r/Log4rTools.html +388 -0
  18. data/doc/rdoc/Log4r/LogEvent.html +378 -0
  19. data/doc/rdoc/Log4r/LogServer.html +340 -0
  20. data/doc/rdoc/Log4r/Logger.html +1150 -0
  21. data/doc/rdoc/Log4r/Logger/LoggerFactory.html +218 -0
  22. data/doc/rdoc/Log4r/Logger/Repository.html +225 -0
  23. data/doc/rdoc/Log4r/MDC.html +424 -0
  24. data/doc/rdoc/Log4r/MDC_rb.html +83 -0
  25. data/doc/rdoc/Log4r/NDC.html +632 -0
  26. data/doc/rdoc/Log4r/NDC_rb.html +110 -0
  27. data/doc/rdoc/Log4r/ObjectFormatter.html +280 -0
  28. data/doc/rdoc/Log4r/Outputter.html +934 -0
  29. data/doc/rdoc/Log4r/Outputter/OutputterFactory.html +218 -0
  30. data/doc/rdoc/Log4r/Outputter/consoleoutputters_rb.html +57 -0
  31. data/doc/rdoc/Log4r/Outputter/datefileoutputter_rb.html +93 -0
  32. data/doc/rdoc/Log4r/Outputter/emailoutputter_rb.html +179 -0
  33. data/doc/rdoc/Log4r/Outputter/fileoutputter_rb.html +64 -0
  34. data/doc/rdoc/Log4r/Outputter/iooutputter_rb.html +59 -0
  35. data/doc/rdoc/Log4r/Outputter/outputter_rb.html +222 -0
  36. data/doc/rdoc/Log4r/Outputter/outputterfactory_rb.html +62 -0
  37. data/doc/rdoc/Log4r/Outputter/remoteoutputter_rb.html +59 -0
  38. data/doc/rdoc/Log4r/Outputter/rollingfileoutputter_rb.html +66 -0
  39. data/doc/rdoc/Log4r/Outputter/staticoutputter_rb.html +55 -0
  40. data/doc/rdoc/Log4r/Outputter/syslogoutputter_rb.html +110 -0
  41. data/doc/rdoc/Log4r/Outputter/udpoutputter_rb.html +220 -0
  42. data/doc/rdoc/Log4r/PatternFormatter.html +404 -0
  43. data/doc/rdoc/Log4r/ROMPClient.html +211 -0
  44. data/doc/rdoc/Log4r/ROMPServer.html +211 -0
  45. data/doc/rdoc/Log4r/RemoteOutputter.html +402 -0
  46. data/doc/rdoc/Log4r/RollingFileOutputter.html +551 -0
  47. data/doc/rdoc/Log4r/RootLogger.html +530 -0
  48. data/doc/rdoc/Log4r/SimpleFormatter.html +276 -0
  49. data/doc/rdoc/Log4r/StderrOutputter.html +268 -0
  50. data/doc/rdoc/Log4r/StdoutOutputter.html +268 -0
  51. data/doc/rdoc/Log4r/SyslogOutputter.html +551 -0
  52. data/doc/rdoc/Log4r/UDPOutputter.html +379 -0
  53. data/doc/rdoc/Log4r/YamlConfigurator.html +966 -0
  54. data/doc/rdoc/Log4r/base_rb.html +57 -0
  55. data/doc/rdoc/Log4r/config_rb.html +122 -0
  56. data/doc/rdoc/Log4r/configurator_rb.html +370 -0
  57. data/doc/rdoc/Log4r/formatter/formatter_rb.html +121 -0
  58. data/doc/rdoc/Log4r/formatter/log4jxmlformatter_rb.html +64 -0
  59. data/doc/rdoc/Log4r/formatter/patternformatter_rb.html +239 -0
  60. data/doc/rdoc/Log4r/lib/drbloader_rb.html +57 -0
  61. data/doc/rdoc/Log4r/lib/xmlloader_rb.html +57 -0
  62. data/doc/rdoc/Log4r/logevent_rb.html +55 -0
  63. data/doc/rdoc/Log4r/logger_rb.html +293 -0
  64. data/doc/rdoc/Log4r/loggerfactory_rb.html +66 -0
  65. data/doc/rdoc/Log4r/logserver_rb.html +161 -0
  66. data/doc/rdoc/Log4r/rdoc/GDC.html +175 -0
  67. data/doc/rdoc/Log4r/rdoc/MDC.html +178 -0
  68. data/doc/rdoc/Log4r/rdoc/NDC.html +207 -0
  69. data/doc/rdoc/Log4r/rdoc/configurator.html +462 -0
  70. data/doc/rdoc/Log4r/rdoc/emailoutputter.html +279 -0
  71. data/doc/rdoc/Log4r/rdoc/formatter.html +218 -0
  72. data/doc/rdoc/Log4r/rdoc/log4r.html +286 -0
  73. data/doc/rdoc/Log4r/rdoc/logger.html +382 -0
  74. data/doc/rdoc/Log4r/rdoc/logserver.html +265 -0
  75. data/doc/rdoc/Log4r/rdoc/outputter.html +313 -0
  76. data/doc/rdoc/Log4r/rdoc/patternformatter.html +331 -0
  77. data/doc/rdoc/Log4r/rdoc/syslogoutputter.html +197 -0
  78. data/doc/rdoc/Log4r/rdoc/win32eventoutputter.html +165 -0
  79. data/doc/rdoc/Log4r/rdoc/yamlconfigurator.html +187 -0
  80. data/doc/rdoc/Log4r/repository_rb.html +74 -0
  81. data/doc/rdoc/Log4r/staticlogger_rb.html +55 -0
  82. data/doc/rdoc/Log4r/yamlconfigurator_rb.html +95 -0
  83. data/doc/rdoc/REXML.html +211 -0
  84. data/doc/rdoc/created.rid +1 -0
  85. data/doc/rdoc/images/brick.png +0 -0
  86. data/doc/rdoc/images/brick_link.png +0 -0
  87. data/doc/rdoc/images/bug.png +0 -0
  88. data/doc/rdoc/images/bullet_black.png +0 -0
  89. data/doc/rdoc/images/bullet_toggle_minus.png +0 -0
  90. data/doc/rdoc/images/bullet_toggle_plus.png +0 -0
  91. data/doc/rdoc/images/date.png +0 -0
  92. data/doc/rdoc/images/find.png +0 -0
  93. data/doc/rdoc/images/loadingAnimation.gif +0 -0
  94. data/doc/rdoc/images/macFFBgHack.png +0 -0
  95. data/doc/rdoc/images/package.png +0 -0
  96. data/doc/rdoc/images/page_green.png +0 -0
  97. data/doc/rdoc/images/page_white_text.png +0 -0
  98. data/doc/rdoc/images/page_white_width.png +0 -0
  99. data/doc/rdoc/images/plugin.png +0 -0
  100. data/doc/rdoc/images/ruby.png +0 -0
  101. data/doc/rdoc/images/tag_green.png +0 -0
  102. data/doc/rdoc/images/wrench.png +0 -0
  103. data/doc/rdoc/images/wrench_orange.png +0 -0
  104. data/doc/rdoc/images/zoom.png +0 -0
  105. data/doc/rdoc/index.html +585 -0
  106. data/doc/rdoc/js/darkfish.js +116 -0
  107. data/doc/rdoc/js/jquery.js +32 -0
  108. data/doc/rdoc/js/quicksearch.js +114 -0
  109. data/doc/rdoc/js/thickbox-compressed.js +10 -0
  110. data/doc/rdoc/log4r-rdoc.css +696 -0
  111. data/doc/rdoc/log4r_rb.html +207 -0
  112. data/doc/rdoc/rdoc.css +696 -0
  113. data/examples/rdoc-gen +2 -0
  114. data/src/log4r.rb +2 -2
  115. data/src/log4r/formatter/patternformatter.rb +15 -15
  116. data/src/log4r/outputter/udpoutputter.rb +4 -4
  117. data/tests/testchainsaw.rb +1 -1
  118. metadata +123 -8
  119. data/src/log4r/outputter/datefileoutputter.patch +0 -24
  120. data/src/log4r/outputter/diff +0 -14
  121. data/src/log4r/outputter/new-datefileoutputter.rb +0 -117
@@ -0,0 +1,388 @@
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: Log4r::Log4rTools</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="../log4r/base_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
32
+ class="thickbox" title="log4r/base.rb">log4r/base.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">Object</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="#M000005">::comma_split</a></li>
63
+
64
+ <li><a href="#M000004">::decode_bool</a></li>
65
+
66
+ <li><a href="#M000002">::valid_level?</a></li>
67
+
68
+ <li><a href="#M000001">::validate_level</a></li>
69
+
70
+ </ul>
71
+ </div>
72
+
73
+
74
+ <!-- Included Modules -->
75
+
76
+ </div>
77
+
78
+ <div id="project-metadata">
79
+
80
+
81
+ <div id="fileindex-section" class="section project-section">
82
+ <h3 class="section-header">Files</h3>
83
+ <ul>
84
+
85
+ <li class="file"><a href="../log4r/rdoc/GDC.html">GDC</a></li>
86
+
87
+ <li class="file"><a href="../log4r/rdoc/MDC.html">MDC</a></li>
88
+
89
+ <li class="file"><a href="../log4r/rdoc/NDC.html">NDC</a></li>
90
+
91
+ <li class="file"><a href="../log4r/rdoc/configurator.html">configurator</a></li>
92
+
93
+ <li class="file"><a href="../log4r/rdoc/emailoutputter.html">emailoutputter</a></li>
94
+
95
+ <li class="file"><a href="../log4r/rdoc/formatter.html">formatter</a></li>
96
+
97
+ <li class="file"><a href="../log4r/rdoc/log4r.html">log4r</a></li>
98
+
99
+ <li class="file"><a href="../log4r/rdoc/logger.html">logger</a></li>
100
+
101
+ <li class="file"><a href="../log4r/rdoc/logserver.html">logserver</a></li>
102
+
103
+ <li class="file"><a href="../log4r/rdoc/outputter.html">outputter</a></li>
104
+
105
+ <li class="file"><a href="../log4r/rdoc/patternformatter.html">patternformatter</a></li>
106
+
107
+ <li class="file"><a href="../log4r/rdoc/syslogoutputter.html">syslogoutputter</a></li>
108
+
109
+ <li class="file"><a href="../log4r/rdoc/win32eventoutputter.html">win32eventoutputter</a></li>
110
+
111
+ <li class="file"><a href="../log4r/rdoc/yamlconfigurator.html">yamlconfigurator</a></li>
112
+
113
+ </ul>
114
+ </div>
115
+
116
+
117
+ <div id="classindex-section" class="section project-section">
118
+ <h3 class="section-header">Class Index
119
+ <span class="search-toggle"><img src="../images/find.png"
120
+ height="16" width="16" alt="[+]"
121
+ title="show/hide quicksearch" /></span></h3>
122
+ <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
123
+ <fieldset>
124
+ <legend>Quicksearch</legend>
125
+ <input type="text" name="quicksearch" value=""
126
+ class="quicksearch-field" />
127
+ </fieldset>
128
+ </form>
129
+
130
+ <ul class="link-list">
131
+
132
+ <li><a href="../Log4r.html">Log4r</a></li>
133
+
134
+ <li><a href="../Log4r/BasicFormatter.html">Log4r::BasicFormatter</a></li>
135
+
136
+ <li><a href="../Log4r/ConfigError.html">Log4r::ConfigError</a></li>
137
+
138
+ <li><a href="../Log4r/Configurator.html">Log4r::Configurator</a></li>
139
+
140
+ <li><a href="../Log4r/DateFileOutputter.html">Log4r::DateFileOutputter</a></li>
141
+
142
+ <li><a href="../Log4r/DefaultFormatter.html">Log4r::DefaultFormatter</a></li>
143
+
144
+ <li><a href="../Log4r/EmailOutputter.html">Log4r::EmailOutputter</a></li>
145
+
146
+ <li><a href="../Log4r/FileOutputter.html">Log4r::FileOutputter</a></li>
147
+
148
+ <li><a href="../Log4r/Formatter.html">Log4r::Formatter</a></li>
149
+
150
+ <li><a href="../Log4r/GDC.html">Log4r::GDC</a></li>
151
+
152
+ <li><a href="../Log4r/IOOutputter.html">Log4r::IOOutputter</a></li>
153
+
154
+ <li><a href="../Log4r/Log4jXmlFormatter.html">Log4r::Log4jXmlFormatter</a></li>
155
+
156
+ <li><a href="../Log4r/Log4rTools.html">Log4r::Log4rTools</a></li>
157
+
158
+ <li><a href="../Log4r/LogEvent.html">Log4r::LogEvent</a></li>
159
+
160
+ <li><a href="../Log4r/LogServer.html">Log4r::LogServer</a></li>
161
+
162
+ <li><a href="../Log4r/Logger.html">Log4r::Logger</a></li>
163
+
164
+ <li><a href="../Log4r/MDC.html">Log4r::MDC</a></li>
165
+
166
+ <li><a href="../Log4r/NDC.html">Log4r::NDC</a></li>
167
+
168
+ <li><a href="../Log4r/ObjectFormatter.html">Log4r::ObjectFormatter</a></li>
169
+
170
+ <li><a href="../Log4r/Outputter.html">Log4r::Outputter</a></li>
171
+
172
+ <li><a href="../Log4r/PatternFormatter.html">Log4r::PatternFormatter</a></li>
173
+
174
+ <li><a href="../Log4r/RemoteOutputter.html">Log4r::RemoteOutputter</a></li>
175
+
176
+ <li><a href="../Log4r/RollingFileOutputter.html">Log4r::RollingFileOutputter</a></li>
177
+
178
+ <li><a href="../Log4r/RootLogger.html">Log4r::RootLogger</a></li>
179
+
180
+ <li><a href="../Log4r/SimpleFormatter.html">Log4r::SimpleFormatter</a></li>
181
+
182
+ <li><a href="../Log4r/StderrOutputter.html">Log4r::StderrOutputter</a></li>
183
+
184
+ <li><a href="../Log4r/StdoutOutputter.html">Log4r::StdoutOutputter</a></li>
185
+
186
+ <li><a href="../Log4r/SyslogOutputter.html">Log4r::SyslogOutputter</a></li>
187
+
188
+ <li><a href="../Log4r/UDPOutputter.html">Log4r::UDPOutputter</a></li>
189
+
190
+ <li><a href="../Log4r/YamlConfigurator.html">Log4r::YamlConfigurator</a></li>
191
+
192
+ </ul>
193
+ <div id="no-class-search-results" style="display: none;">No matching classes.</div>
194
+ </div>
195
+
196
+
197
+ </div>
198
+ </div>
199
+
200
+ <div id="documentation">
201
+ <h1 class="class">Log4r::Log4rTools</h1>
202
+
203
+ <div id="description">
204
+ <p>
205
+ Some common functions
206
+ </p>
207
+
208
+ </div>
209
+
210
+ <!-- Constants -->
211
+
212
+
213
+ <!-- Attributes -->
214
+
215
+
216
+ <!-- Methods -->
217
+
218
+ <div id="public-class-method-details" class="method-section section">
219
+ <h3 class="section-header">Public Class Methods</h3>
220
+
221
+
222
+ <div id="comma-split-method" class="method-detail ">
223
+ <a name="M000005"></a>
224
+
225
+ <div class="method-heading">
226
+
227
+ <span class="method-name">comma_split</span><span
228
+ class="method-args">(string)</span>
229
+ <span class="method-click-advice">click to toggle source</span>
230
+
231
+ </div>
232
+
233
+ <div class="method-description">
234
+
235
+ <p>
236
+ Splits comma-delimited lists with arbitrary s padding
237
+ </p>
238
+
239
+
240
+
241
+ <div class="method-source-code"
242
+ id="comma-split-source">
243
+ <pre>
244
+ <span class="ruby-comment cmt"># File log4r/base.rb, line 70</span>
245
+ <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">comma_split</span>(<span class="ruby-identifier">string</span>)
246
+ <span class="ruby-identifier">string</span>.<span class="ruby-identifier">split</span>(<span class="ruby-regexp re">/\s*,\s*/</span>).<span class="ruby-identifier">collect</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">s</span><span class="ruby-operator">|</span> <span class="ruby-identifier">s</span>.<span class="ruby-identifier">strip</span>}
247
+ <span class="ruby-keyword kw">end</span></pre>
248
+ </div>
249
+
250
+ </div>
251
+
252
+
253
+ </div>
254
+
255
+
256
+ <div id="decode-bool-method" class="method-detail ">
257
+ <a name="M000004"></a>
258
+
259
+ <div class="method-heading">
260
+
261
+ <span class="method-name">decode_bool</span><span
262
+ class="method-args">(hash, symbol, default)</span>
263
+ <span class="method-click-advice">click to toggle source</span>
264
+
265
+ </div>
266
+
267
+ <div class="method-description">
268
+
269
+ <p>
270
+ Shortcut for decoding &#8216;true&#8217;, &#8216;false&#8217;, true, false
271
+ or nil into a bool from a hash parameter. E.g., it looks for true/false
272
+ values for the keys &#8216;symbol&#8217; and :symbol.
273
+ </p>
274
+
275
+
276
+
277
+ <div class="method-source-code"
278
+ id="decode-bool-source">
279
+ <pre>
280
+ <span class="ruby-comment cmt"># File log4r/base.rb, line 59</span>
281
+ <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">decode_bool</span>(<span class="ruby-identifier">hash</span>, <span class="ruby-identifier">symbol</span>, <span class="ruby-identifier">default</span>)
282
+ <span class="ruby-identifier">data</span> = <span class="ruby-identifier">hash</span>[<span class="ruby-identifier">symbol</span>]
283
+ <span class="ruby-identifier">data</span> = <span class="ruby-identifier">hash</span>[<span class="ruby-identifier">symbol</span>.<span class="ruby-identifier">to_s</span>] <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">data</span>.<span class="ruby-identifier">nil?</span>
284
+ <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">case</span> <span class="ruby-identifier">data</span>
285
+ <span class="ruby-keyword kw">when</span> <span class="ruby-value str">'true'</span>,<span class="ruby-keyword kw">true</span> <span class="ruby-keyword kw">then</span> <span class="ruby-keyword kw">true</span>
286
+ <span class="ruby-keyword kw">when</span> <span class="ruby-value str">'false'</span>,<span class="ruby-keyword kw">false</span> <span class="ruby-keyword kw">then</span> <span class="ruby-keyword kw">false</span>
287
+ <span class="ruby-keyword kw">else</span> <span class="ruby-identifier">default</span>
288
+ <span class="ruby-keyword kw">end</span>
289
+ <span class="ruby-keyword kw">end</span></pre>
290
+ </div>
291
+
292
+ </div>
293
+
294
+
295
+ </div>
296
+
297
+
298
+ <div id="valid-level--method" class="method-detail ">
299
+ <a name="M000002"></a>
300
+
301
+ <div class="method-heading">
302
+
303
+ <span class="method-name">valid_level?</span><span
304
+ class="method-args">(lev)</span>
305
+ <span class="method-click-advice">click to toggle source</span>
306
+
307
+ </div>
308
+
309
+ <div class="method-description">
310
+
311
+ <p class="missing-docs">(Not documented)</p>
312
+
313
+
314
+
315
+ <div class="method-source-code"
316
+ id="valid-level--source">
317
+ <pre>
318
+ <span class="ruby-comment cmt"># File log4r/base.rb, line 45</span>
319
+ <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">valid_level?</span>(<span class="ruby-identifier">lev</span>)
320
+ <span class="ruby-keyword kw">not</span> <span class="ruby-identifier">lev</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-keyword kw">and</span> <span class="ruby-identifier">lev</span>.<span class="ruby-identifier">kind_of?</span>(<span class="ruby-constant">Numeric</span>) <span class="ruby-keyword kw">and</span> <span class="ruby-identifier">lev</span> <span class="ruby-operator">&gt;=</span> <span class="ruby-constant">ALL</span> <span class="ruby-keyword kw">and</span> <span class="ruby-identifier">lev</span> <span class="ruby-operator">&lt;=</span> <span class="ruby-constant">OFF</span>
321
+ <span class="ruby-keyword kw">end</span></pre>
322
+ </div>
323
+
324
+ </div>
325
+
326
+
327
+ </div>
328
+
329
+
330
+ <div id="validate-level-method" class="method-detail ">
331
+ <a name="M000001"></a>
332
+
333
+ <div class="method-heading">
334
+
335
+ <span class="method-name">validate_level</span><span
336
+ class="method-args">(level, depth=0)</span>
337
+ <span class="method-click-advice">click to toggle source</span>
338
+
339
+ </div>
340
+
341
+ <div class="method-description">
342
+
343
+ <p>
344
+ Raises ArgumentError if level argument is an invalid level. Depth specifies
345
+ how many trace entries to remove.
346
+ </p>
347
+
348
+
349
+
350
+ <div class="method-source-code"
351
+ id="validate-level-source">
352
+ <pre>
353
+ <span class="ruby-comment cmt"># File log4r/base.rb, line 38</span>
354
+ <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">validate_level</span>(<span class="ruby-identifier">level</span>, <span class="ruby-identifier">depth</span>=<span class="ruby-value">0</span>)
355
+ <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">valid_level?</span>(<span class="ruby-identifier">level</span>)
356
+ <span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-node">&quot;Log level must be in 0..#{LEVELS}&quot;</span>,
357
+ <span class="ruby-identifier">caller</span>[<span class="ruby-value">1</span><span class="ruby-operator">..</span><span class="ruby-operator">-</span>(<span class="ruby-identifier">depth</span> <span class="ruby-operator">+</span> <span class="ruby-value">1</span>)]
358
+ <span class="ruby-keyword kw">end</span>
359
+ <span class="ruby-keyword kw">end</span></pre>
360
+ </div>
361
+
362
+ </div>
363
+
364
+
365
+ </div>
366
+
367
+
368
+ </div>
369
+
370
+
371
+ </div>
372
+
373
+
374
+ <div id="rdoc-debugging-section-dump" class="debugging-section">
375
+
376
+ <p>Disabled; run with --debug to generate this.</p>
377
+
378
+ </div>
379
+
380
+ <div id="validator-badges">
381
+ <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
382
+ <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
383
+ Rdoc Generator</a> 1.1.6</small>.</p>
384
+ </div>
385
+
386
+ </body>
387
+ </html>
388
+
@@ -0,0 +1,378 @@
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: Log4r::LogEvent</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="../log4r/logevent_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
32
+ class="thickbox" title="log4r/logevent.rb">log4r/logevent.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">Object</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="#M000040">::new</a></li>
63
+
64
+ </ul>
65
+ </div>
66
+
67
+
68
+ <!-- Included Modules -->
69
+
70
+ </div>
71
+
72
+ <div id="project-metadata">
73
+
74
+
75
+ <div id="fileindex-section" class="section project-section">
76
+ <h3 class="section-header">Files</h3>
77
+ <ul>
78
+
79
+ <li class="file"><a href="../log4r/rdoc/GDC.html">GDC</a></li>
80
+
81
+ <li class="file"><a href="../log4r/rdoc/MDC.html">MDC</a></li>
82
+
83
+ <li class="file"><a href="../log4r/rdoc/NDC.html">NDC</a></li>
84
+
85
+ <li class="file"><a href="../log4r/rdoc/configurator.html">configurator</a></li>
86
+
87
+ <li class="file"><a href="../log4r/rdoc/emailoutputter.html">emailoutputter</a></li>
88
+
89
+ <li class="file"><a href="../log4r/rdoc/formatter.html">formatter</a></li>
90
+
91
+ <li class="file"><a href="../log4r/rdoc/log4r.html">log4r</a></li>
92
+
93
+ <li class="file"><a href="../log4r/rdoc/logger.html">logger</a></li>
94
+
95
+ <li class="file"><a href="../log4r/rdoc/logserver.html">logserver</a></li>
96
+
97
+ <li class="file"><a href="../log4r/rdoc/outputter.html">outputter</a></li>
98
+
99
+ <li class="file"><a href="../log4r/rdoc/patternformatter.html">patternformatter</a></li>
100
+
101
+ <li class="file"><a href="../log4r/rdoc/syslogoutputter.html">syslogoutputter</a></li>
102
+
103
+ <li class="file"><a href="../log4r/rdoc/win32eventoutputter.html">win32eventoutputter</a></li>
104
+
105
+ <li class="file"><a href="../log4r/rdoc/yamlconfigurator.html">yamlconfigurator</a></li>
106
+
107
+ </ul>
108
+ </div>
109
+
110
+
111
+ <div id="classindex-section" class="section project-section">
112
+ <h3 class="section-header">Class Index
113
+ <span class="search-toggle"><img src="../images/find.png"
114
+ height="16" width="16" alt="[+]"
115
+ title="show/hide quicksearch" /></span></h3>
116
+ <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
117
+ <fieldset>
118
+ <legend>Quicksearch</legend>
119
+ <input type="text" name="quicksearch" value=""
120
+ class="quicksearch-field" />
121
+ </fieldset>
122
+ </form>
123
+
124
+ <ul class="link-list">
125
+
126
+ <li><a href="../Log4r.html">Log4r</a></li>
127
+
128
+ <li><a href="../Log4r/BasicFormatter.html">Log4r::BasicFormatter</a></li>
129
+
130
+ <li><a href="../Log4r/ConfigError.html">Log4r::ConfigError</a></li>
131
+
132
+ <li><a href="../Log4r/Configurator.html">Log4r::Configurator</a></li>
133
+
134
+ <li><a href="../Log4r/DateFileOutputter.html">Log4r::DateFileOutputter</a></li>
135
+
136
+ <li><a href="../Log4r/DefaultFormatter.html">Log4r::DefaultFormatter</a></li>
137
+
138
+ <li><a href="../Log4r/EmailOutputter.html">Log4r::EmailOutputter</a></li>
139
+
140
+ <li><a href="../Log4r/FileOutputter.html">Log4r::FileOutputter</a></li>
141
+
142
+ <li><a href="../Log4r/Formatter.html">Log4r::Formatter</a></li>
143
+
144
+ <li><a href="../Log4r/GDC.html">Log4r::GDC</a></li>
145
+
146
+ <li><a href="../Log4r/IOOutputter.html">Log4r::IOOutputter</a></li>
147
+
148
+ <li><a href="../Log4r/Log4jXmlFormatter.html">Log4r::Log4jXmlFormatter</a></li>
149
+
150
+ <li><a href="../Log4r/Log4rTools.html">Log4r::Log4rTools</a></li>
151
+
152
+ <li><a href="../Log4r/LogEvent.html">Log4r::LogEvent</a></li>
153
+
154
+ <li><a href="../Log4r/LogServer.html">Log4r::LogServer</a></li>
155
+
156
+ <li><a href="../Log4r/Logger.html">Log4r::Logger</a></li>
157
+
158
+ <li><a href="../Log4r/MDC.html">Log4r::MDC</a></li>
159
+
160
+ <li><a href="../Log4r/NDC.html">Log4r::NDC</a></li>
161
+
162
+ <li><a href="../Log4r/ObjectFormatter.html">Log4r::ObjectFormatter</a></li>
163
+
164
+ <li><a href="../Log4r/Outputter.html">Log4r::Outputter</a></li>
165
+
166
+ <li><a href="../Log4r/PatternFormatter.html">Log4r::PatternFormatter</a></li>
167
+
168
+ <li><a href="../Log4r/RemoteOutputter.html">Log4r::RemoteOutputter</a></li>
169
+
170
+ <li><a href="../Log4r/RollingFileOutputter.html">Log4r::RollingFileOutputter</a></li>
171
+
172
+ <li><a href="../Log4r/RootLogger.html">Log4r::RootLogger</a></li>
173
+
174
+ <li><a href="../Log4r/SimpleFormatter.html">Log4r::SimpleFormatter</a></li>
175
+
176
+ <li><a href="../Log4r/StderrOutputter.html">Log4r::StderrOutputter</a></li>
177
+
178
+ <li><a href="../Log4r/StdoutOutputter.html">Log4r::StdoutOutputter</a></li>
179
+
180
+ <li><a href="../Log4r/SyslogOutputter.html">Log4r::SyslogOutputter</a></li>
181
+
182
+ <li><a href="../Log4r/UDPOutputter.html">Log4r::UDPOutputter</a></li>
183
+
184
+ <li><a href="../Log4r/YamlConfigurator.html">Log4r::YamlConfigurator</a></li>
185
+
186
+ </ul>
187
+ <div id="no-class-search-results" style="display: none;">No matching classes.</div>
188
+ </div>
189
+
190
+
191
+ </div>
192
+ </div>
193
+
194
+ <div id="documentation">
195
+ <h1 class="class">Log4r::LogEvent</h1>
196
+
197
+ <div id="description">
198
+ <p>
199
+ <a href="LogEvent.html">LogEvent</a> wraps up all the miscellaneous data
200
+ associated with a logging statement. It gets passed around to the varied
201
+ components of <a href="../Log4r.html">Log4r</a> and should be of interest
202
+ to those creating extensions.
203
+ </p>
204
+ <p>
205
+ Data contained:
206
+ </p>
207
+ <dl>
208
+ <dt>level</dt><dd>The integer level of the log event. Use LNAMES[level] to get the actual
209
+ level name.
210
+
211
+ </dd>
212
+ <dt>tracer</dt><dd>The execution stack returned by <tt>caller</tt> at the log event. It is nil
213
+ if the invoked Logger&#8217;s trace is false.
214
+
215
+ </dd>
216
+ <dt>data</dt><dd>The object that was passed into the logging method.
217
+
218
+ </dd>
219
+ <dt>name</dt><dd>The name of the logger that was invoked.
220
+
221
+ </dd>
222
+ <dt>fullname</dt><dd>The fully qualified name of the logger that was invoked.
223
+
224
+ </dd>
225
+ </dl>
226
+ <p>
227
+ Note that creating timestamps is a task left to formatters.
228
+ </p>
229
+
230
+ </div>
231
+
232
+ <!-- Constants -->
233
+
234
+
235
+ <!-- Attributes -->
236
+
237
+ <div id="attribute-method-details" class="method-section section">
238
+ <h3 class="section-header">Attributes</h3>
239
+
240
+
241
+ <div id="level-attribute-method" class="method-detail">
242
+ <a name="level"></a>
243
+
244
+ <div class="method-heading attribute-method-heading">
245
+ <span class="method-name">level</span><span
246
+ class="attribute-access-type">[R]</span>
247
+ </div>
248
+
249
+ <div class="method-description">
250
+
251
+ <p class="missing-docs">(Not documented)</p>
252
+
253
+ </div>
254
+ </div>
255
+
256
+ <div id="tracer-attribute-method" class="method-detail">
257
+ <a name="tracer"></a>
258
+
259
+ <div class="method-heading attribute-method-heading">
260
+ <span class="method-name">tracer</span><span
261
+ class="attribute-access-type">[R]</span>
262
+ </div>
263
+
264
+ <div class="method-description">
265
+
266
+ <p class="missing-docs">(Not documented)</p>
267
+
268
+ </div>
269
+ </div>
270
+
271
+ <div id="data-attribute-method" class="method-detail">
272
+ <a name="data"></a>
273
+
274
+ <div class="method-heading attribute-method-heading">
275
+ <span class="method-name">data</span><span
276
+ class="attribute-access-type">[R]</span>
277
+ </div>
278
+
279
+ <div class="method-description">
280
+
281
+ <p class="missing-docs">(Not documented)</p>
282
+
283
+ </div>
284
+ </div>
285
+
286
+ <div id="name-attribute-method" class="method-detail">
287
+ <a name="name"></a>
288
+
289
+ <div class="method-heading attribute-method-heading">
290
+ <span class="method-name">name</span><span
291
+ class="attribute-access-type">[R]</span>
292
+ </div>
293
+
294
+ <div class="method-description">
295
+
296
+ <p class="missing-docs">(Not documented)</p>
297
+
298
+ </div>
299
+ </div>
300
+
301
+ <div id="fullname-attribute-method" class="method-detail">
302
+ <a name="fullname"></a>
303
+
304
+ <div class="method-heading attribute-method-heading">
305
+ <span class="method-name">fullname</span><span
306
+ class="attribute-access-type">[R]</span>
307
+ </div>
308
+
309
+ <div class="method-description">
310
+
311
+ <p class="missing-docs">(Not documented)</p>
312
+
313
+ </div>
314
+ </div>
315
+
316
+ </div>
317
+
318
+
319
+ <!-- Methods -->
320
+
321
+ <div id="public-class-method-details" class="method-section section">
322
+ <h3 class="section-header">Public Class Methods</h3>
323
+
324
+
325
+ <div id="new-method" class="method-detail ">
326
+ <a name="M000040"></a>
327
+
328
+ <div class="method-heading">
329
+
330
+ <span class="method-name">new</span><span
331
+ class="method-args">(level, logger, tracer, data)</span>
332
+ <span class="method-click-advice">click to toggle source</span>
333
+
334
+ </div>
335
+
336
+ <div class="method-description">
337
+
338
+ <p class="missing-docs">(Not documented)</p>
339
+
340
+
341
+
342
+ <div class="method-source-code"
343
+ id="new-source">
344
+ <pre>
345
+ <span class="ruby-comment cmt"># File log4r/logevent.rb, line 23</span>
346
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">level</span>, <span class="ruby-identifier">logger</span>, <span class="ruby-identifier">tracer</span>, <span class="ruby-identifier">data</span>)
347
+ <span class="ruby-ivar">@level</span>, <span class="ruby-ivar">@tracer</span>, <span class="ruby-ivar">@data</span> = <span class="ruby-identifier">level</span>, <span class="ruby-identifier">tracer</span>, <span class="ruby-identifier">data</span>
348
+ <span class="ruby-ivar">@name</span>, <span class="ruby-ivar">@fullname</span> = <span class="ruby-identifier">logger</span>.<span class="ruby-identifier">name</span>, <span class="ruby-identifier">logger</span>.<span class="ruby-identifier">fullname</span>
349
+ <span class="ruby-keyword kw">end</span></pre>
350
+ </div>
351
+
352
+ </div>
353
+
354
+
355
+ </div>
356
+
357
+
358
+ </div>
359
+
360
+
361
+ </div>
362
+
363
+
364
+ <div id="rdoc-debugging-section-dump" class="debugging-section">
365
+
366
+ <p>Disabled; run with --debug to generate this.</p>
367
+
368
+ </div>
369
+
370
+ <div id="validator-badges">
371
+ <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
372
+ <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
373
+ Rdoc Generator</a> 1.1.6</small>.</p>
374
+ </div>
375
+
376
+ </body>
377
+ </html>
378
+