log4r 1.1.1 → 1.1.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (107) hide show
  1. data/README +3 -3
  2. data/Rakefile +3 -3
  3. data/doc/rdoc-log4r.css +696 -0
  4. data/examples/syslogcustom.rb +6 -1
  5. data/src/doc/Log4r.html +392 -0
  6. data/src/doc/Log4r/BasicFormatter.html +370 -0
  7. data/src/doc/Log4r/ConfigError.html +207 -0
  8. data/src/doc/Log4r/Configurator.html +1050 -0
  9. data/src/doc/Log4r/DateFileOutputter.html +454 -0
  10. data/src/doc/Log4r/DefaultFormatter.html +205 -0
  11. data/src/doc/Log4r/EmailOutputter.html +636 -0
  12. data/src/doc/Log4r/FileOutputter.html +321 -0
  13. data/src/doc/Log4r/Formatter.html +291 -0
  14. data/src/doc/Log4r/IOOutputter.html +392 -0
  15. data/src/doc/Log4r/Log4rConfig.html +193 -0
  16. data/src/doc/Log4r/Log4rTools.html +370 -0
  17. data/src/doc/Log4r/LogEvent.html +360 -0
  18. data/src/doc/Log4r/LogServer.html +322 -0
  19. data/src/doc/Log4r/Logger.html +1132 -0
  20. data/src/doc/Log4r/Logger/LoggerFactory.html +200 -0
  21. data/src/doc/Log4r/Logger/Repository.html +207 -0
  22. data/src/doc/Log4r/ObjectFormatter.html +262 -0
  23. data/src/doc/Log4r/Outputter.html +910 -0
  24. data/src/doc/Log4r/Outputter/OutputterFactory.html +200 -0
  25. data/src/doc/Log4r/Outputter/consoleoutputters_rb.html +57 -0
  26. data/src/doc/Log4r/Outputter/datefileoutputter_rb.html +93 -0
  27. data/src/doc/Log4r/Outputter/emailoutputter_rb.html +179 -0
  28. data/src/doc/Log4r/Outputter/fileoutputter_rb.html +64 -0
  29. data/src/doc/Log4r/Outputter/iooutputter_rb.html +59 -0
  30. data/src/doc/Log4r/Outputter/outputter_rb.html +222 -0
  31. data/src/doc/Log4r/Outputter/outputterfactory_rb.html +62 -0
  32. data/src/doc/Log4r/Outputter/remoteoutputter_rb.html +59 -0
  33. data/src/doc/Log4r/Outputter/rollingfileoutputter_rb.html +66 -0
  34. data/src/doc/Log4r/Outputter/staticoutputter_rb.html +55 -0
  35. data/src/doc/Log4r/Outputter/syslogoutputter_rb.html +110 -0
  36. data/src/doc/Log4r/Outputter/tst_rb.html +54 -0
  37. data/src/doc/Log4r/PatternFormatter.html +422 -0
  38. data/src/doc/Log4r/ROMPClient.html +193 -0
  39. data/src/doc/Log4r/ROMPServer.html +193 -0
  40. data/src/doc/Log4r/RemoteOutputter.html +384 -0
  41. data/src/doc/Log4r/RollingFileOutputter.html +528 -0
  42. data/src/doc/Log4r/RootLogger.html +512 -0
  43. data/src/doc/Log4r/SimpleFormatter.html +258 -0
  44. data/src/doc/Log4r/StderrOutputter.html +250 -0
  45. data/src/doc/Log4r/StdoutOutputter.html +250 -0
  46. data/src/doc/Log4r/SyslogOutputter.html +533 -0
  47. data/src/doc/Log4r/YamlConfigurator.html +948 -0
  48. data/src/doc/Log4r/base_rb.html +57 -0
  49. data/src/doc/Log4r/config_rb.html +76 -0
  50. data/src/doc/Log4r/configurator_rb.html +370 -0
  51. data/src/doc/Log4r/formatter/formatter_rb.html +121 -0
  52. data/src/doc/Log4r/formatter/patternformatter_rb.html +233 -0
  53. data/src/doc/Log4r/lib/drbloader_rb.html +57 -0
  54. data/src/doc/Log4r/lib/xmlloader_rb.html +57 -0
  55. data/src/doc/Log4r/logevent_rb.html +55 -0
  56. data/src/doc/Log4r/logger_rb.html +293 -0
  57. data/src/doc/Log4r/loggerfactory_rb.html +66 -0
  58. data/src/doc/Log4r/logserver_rb.html +161 -0
  59. data/src/doc/Log4r/rdoc/configurator.html +444 -0
  60. data/src/doc/Log4r/rdoc/emailoutputter.html +261 -0
  61. data/src/doc/Log4r/rdoc/formatter.html +200 -0
  62. data/src/doc/Log4r/rdoc/log4r.html +268 -0
  63. data/src/doc/Log4r/rdoc/logger.html +364 -0
  64. data/src/doc/Log4r/rdoc/logserver.html +247 -0
  65. data/src/doc/Log4r/rdoc/outputter.html +295 -0
  66. data/src/doc/Log4r/rdoc/patternformatter.html +313 -0
  67. data/src/doc/Log4r/rdoc/syslogoutputter.html +179 -0
  68. data/src/doc/Log4r/rdoc/yamlconfigurator.html +169 -0
  69. data/src/doc/Log4r/repository_rb.html +62 -0
  70. data/src/doc/Log4r/staticlogger_rb.html +55 -0
  71. data/src/doc/Log4r/yamlconfigurator_rb.html +95 -0
  72. data/src/doc/REXML.html +193 -0
  73. data/src/doc/created.rid +1 -0
  74. data/src/doc/images/brick.png +0 -0
  75. data/src/doc/images/brick_link.png +0 -0
  76. data/src/doc/images/bug.png +0 -0
  77. data/src/doc/images/bullet_black.png +0 -0
  78. data/src/doc/images/bullet_toggle_minus.png +0 -0
  79. data/src/doc/images/bullet_toggle_plus.png +0 -0
  80. data/src/doc/images/date.png +0 -0
  81. data/src/doc/images/find.png +0 -0
  82. data/src/doc/images/loadingAnimation.gif +0 -0
  83. data/src/doc/images/macFFBgHack.png +0 -0
  84. data/src/doc/images/package.png +0 -0
  85. data/src/doc/images/page_green.png +0 -0
  86. data/src/doc/images/page_white_text.png +0 -0
  87. data/src/doc/images/page_white_width.png +0 -0
  88. data/src/doc/images/plugin.png +0 -0
  89. data/src/doc/images/ruby.png +0 -0
  90. data/src/doc/images/tag_green.png +0 -0
  91. data/src/doc/images/wrench.png +0 -0
  92. data/src/doc/images/wrench_orange.png +0 -0
  93. data/src/doc/images/zoom.png +0 -0
  94. data/src/doc/index.html +384 -0
  95. data/src/doc/js/darkfish.js +116 -0
  96. data/src/doc/js/jquery.js +32 -0
  97. data/src/doc/js/quicksearch.js +114 -0
  98. data/src/doc/js/thickbox-compressed.js +10 -0
  99. data/src/doc/rdoc.css +696 -0
  100. data/src/log4r.rb +2 -2
  101. data/src/log4r/formatter/patternformatter.rb +18 -2
  102. data/src/log4r/logger.rb +2 -2
  103. data/src/log4r/outputter/emailoutputter.rb +2 -0
  104. data/src/log4r/outputter/syslogoutputter.rb +29 -9
  105. data/src/log4r/outputter/tst.rb +8 -0
  106. metadata +99 -3
  107. data/examples/logs/simple.log +0 -1
data/src/doc/Log4r/LogServer.html ADDED
@@ -0,0 +1,322 @@
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::LogServer</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/logserver_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
32
+ class="thickbox" title="log4r/logserver.rb">log4r/logserver.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">Logger</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="#M000049">::new</a></li>
63
+
64
+ <li><a href="#M000050">::new</a></li>
65
+
66
+ </ul>
67
+ </div>
68
+
69
+
70
+ <!-- Included Modules -->
71
+
72
+ <div id="includes-section" class="section">
73
+ <h3 class="section-header">Included Modules</h3>
74
+ <ul class="link-list">
75
+
76
+
77
+ <li><a class="include" href="ROMPClient.html">Log4r::ROMPClient</a></li>
78
+
79
+
80
+ </ul>
81
+ </div>
82
+
83
+ </div>
84
+
85
+ <div id="project-metadata">
86
+
87
+
88
+ <div id="fileindex-section" class="section project-section">
89
+ <h3 class="section-header">Files</h3>
90
+ <ul>
91
+
92
+ <li class="file"><a href="../log4r/rdoc/configurator.html">configurator</a></li>
93
+
94
+ <li class="file"><a href="../log4r/rdoc/emailoutputter.html">emailoutputter</a></li>
95
+
96
+ <li class="file"><a href="../log4r/rdoc/formatter.html">formatter</a></li>
97
+
98
+ <li class="file"><a href="../log4r/rdoc/log4r.html">log4r</a></li>
99
+
100
+ <li class="file"><a href="../log4r/rdoc/logger.html">logger</a></li>
101
+
102
+ <li class="file"><a href="../log4r/rdoc/logserver.html">logserver</a></li>
103
+
104
+ <li class="file"><a href="../log4r/rdoc/outputter.html">outputter</a></li>
105
+
106
+ <li class="file"><a href="../log4r/rdoc/patternformatter.html">patternformatter</a></li>
107
+
108
+ <li class="file"><a href="../log4r/rdoc/syslogoutputter.html">syslogoutputter</a></li>
109
+
110
+ <li class="file"><a href="../log4r/rdoc/yamlconfigurator.html">yamlconfigurator</a></li>
111
+
112
+ </ul>
113
+ </div>
114
+
115
+
116
+ <div id="classindex-section" class="section project-section">
117
+ <h3 class="section-header">Class Index
118
+ <span class="search-toggle"><img src="../images/find.png"
119
+ height="16" width="16" alt="[+]"
120
+ title="show/hide quicksearch" /></span></h3>
121
+ <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
122
+ <fieldset>
123
+ <legend>Quicksearch</legend>
124
+ <input type="text" name="quicksearch" value=""
125
+ class="quicksearch-field" />
126
+ </fieldset>
127
+ </form>
128
+
129
+ <ul class="link-list">
130
+
131
+ <li><a href="../Log4r.html">Log4r</a></li>
132
+
133
+ <li><a href="../Log4r/BasicFormatter.html">Log4r::BasicFormatter</a></li>
134
+
135
+ <li><a href="../Log4r/ConfigError.html">Log4r::ConfigError</a></li>
136
+
137
+ <li><a href="../Log4r/Configurator.html">Log4r::Configurator</a></li>
138
+
139
+ <li><a href="../Log4r/DateFileOutputter.html">Log4r::DateFileOutputter</a></li>
140
+
141
+ <li><a href="../Log4r/DefaultFormatter.html">Log4r::DefaultFormatter</a></li>
142
+
143
+ <li><a href="../Log4r/EmailOutputter.html">Log4r::EmailOutputter</a></li>
144
+
145
+ <li><a href="../Log4r/FileOutputter.html">Log4r::FileOutputter</a></li>
146
+
147
+ <li><a href="../Log4r/Formatter.html">Log4r::Formatter</a></li>
148
+
149
+ <li><a href="../Log4r/IOOutputter.html">Log4r::IOOutputter</a></li>
150
+
151
+ <li><a href="../Log4r/Log4rTools.html">Log4r::Log4rTools</a></li>
152
+
153
+ <li><a href="../Log4r/LogEvent.html">Log4r::LogEvent</a></li>
154
+
155
+ <li><a href="../Log4r/LogServer.html">Log4r::LogServer</a></li>
156
+
157
+ <li><a href="../Log4r/Logger.html">Log4r::Logger</a></li>
158
+
159
+ <li><a href="../Log4r/ObjectFormatter.html">Log4r::ObjectFormatter</a></li>
160
+
161
+ <li><a href="../Log4r/Outputter.html">Log4r::Outputter</a></li>
162
+
163
+ <li><a href="../Log4r/PatternFormatter.html">Log4r::PatternFormatter</a></li>
164
+
165
+ <li><a href="../Log4r/RemoteOutputter.html">Log4r::RemoteOutputter</a></li>
166
+
167
+ <li><a href="../Log4r/RollingFileOutputter.html">Log4r::RollingFileOutputter</a></li>
168
+
169
+ <li><a href="../Log4r/RootLogger.html">Log4r::RootLogger</a></li>
170
+
171
+ <li><a href="../Log4r/SimpleFormatter.html">Log4r::SimpleFormatter</a></li>
172
+
173
+ <li><a href="../Log4r/StderrOutputter.html">Log4r::StderrOutputter</a></li>
174
+
175
+ <li><a href="../Log4r/StdoutOutputter.html">Log4r::StdoutOutputter</a></li>
176
+
177
+ <li><a href="../Log4r/SyslogOutputter.html">Log4r::SyslogOutputter</a></li>
178
+
179
+ <li><a href="../Log4r/YamlConfigurator.html">Log4r::YamlConfigurator</a></li>
180
+
181
+ </ul>
182
+ <div id="no-class-search-results" style="display: none;">No matching classes.</div>
183
+ </div>
184
+
185
+
186
+ </div>
187
+ </div>
188
+
189
+ <div id="documentation">
190
+ <h1 class="class">Log4r::LogServer</h1>
191
+
192
+ <div id="description">
193
+ <p>
194
+ See <a href="../log4r/logserver_rb.html">log4r/logserver.rb</a>
195
+ </p>
196
+
197
+ </div>
198
+
199
+ <!-- Constants -->
200
+
201
+
202
+ <!-- Attributes -->
203
+
204
+ <div id="attribute-method-details" class="method-section section">
205
+ <h3 class="section-header">Attributes</h3>
206
+
207
+
208
+ <div id="uri-attribute-method" class="method-detail">
209
+ <a name="uri"></a>
210
+
211
+ <div class="method-heading attribute-method-heading">
212
+ <span class="method-name">uri</span><span
213
+ class="attribute-access-type">[R]</span>
214
+ </div>
215
+
216
+ <div class="method-description">
217
+
218
+ <p class="missing-docs">(Not documented)</p>
219
+
220
+ </div>
221
+ </div>
222
+
223
+ </div>
224
+
225
+
226
+ <!-- Methods -->
227
+
228
+ <div id="public-class-method-details" class="method-section section">
229
+ <h3 class="section-header">Public Class Methods</h3>
230
+
231
+
232
+ <div id="new-method" class="method-detail ">
233
+ <a name="M000049"></a>
234
+
235
+ <div class="method-heading">
236
+
237
+ <span class="method-name">new</span><span
238
+ class="method-args">(_fullname, _uri, _level=nil, _additive=true, _trace=false, &accept)</span>
239
+ <span class="method-click-advice">click to toggle source</span>
240
+
241
+ </div>
242
+
243
+ <div class="method-description">
244
+
245
+ <p>
246
+ A valid ROMP uri must be specified.
247
+ </p>
248
+
249
+
250
+
251
+ <div class="method-source-code"
252
+ id="new-source">
253
+ <pre>
254
+ <span class="ruby-comment cmt"># File log4r/logserver.rb, line 12</span>
255
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">_fullname</span>, <span class="ruby-identifier">_uri</span>, <span class="ruby-identifier">_level</span>=<span class="ruby-keyword kw">nil</span>,
256
+ <span class="ruby-identifier">_additive</span>=<span class="ruby-keyword kw">true</span>, <span class="ruby-identifier">_trace</span>=<span class="ruby-keyword kw">false</span>, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">accept</span>)
257
+ <span class="ruby-keyword kw">super</span>(<span class="ruby-identifier">_fullname</span>, <span class="ruby-identifier">_level</span>, <span class="ruby-identifier">_additive</span>, <span class="ruby-identifier">_trace</span>)
258
+ <span class="ruby-ivar">@uri</span> = <span class="ruby-identifier">_uri</span>
259
+ <span class="ruby-identifier">start_server</span>(<span class="ruby-identifier">_uri</span>, <span class="ruby-identifier">accept</span>)
260
+ <span class="ruby-constant">Logger</span>.<span class="ruby-identifier">log_internal</span> {<span class="ruby-node">&quot;LogServer started at #{@uri}&quot;</span>}
261
+ <span class="ruby-keyword kw">end</span></pre>
262
+ </div>
263
+
264
+ </div>
265
+
266
+
267
+ </div>
268
+
269
+
270
+ <div id="new-method" class="method-detail ">
271
+ <a name="M000050"></a>
272
+
273
+ <div class="method-heading">
274
+
275
+ <span class="method-name">new</span><span
276
+ class="method-args">(*args)</span>
277
+ <span class="method-click-advice">click to toggle source</span>
278
+
279
+ </div>
280
+
281
+ <div class="method-description">
282
+
283
+ <p class="missing-docs">(Not documented)</p>
284
+
285
+
286
+
287
+ <div class="method-source-code"
288
+ id="new-source">
289
+ <pre>
290
+ <span class="ruby-comment cmt"># File log4r/logserver.rb, line 23</span>
291
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
292
+ <span class="ruby-identifier">raise</span> <span class="ruby-constant">RuntimeError</span>, <span class="ruby-value str">&quot;LogServer not supported. ROMP is required&quot;</span>, <span class="ruby-identifier">caller</span>
293
+ <span class="ruby-keyword kw">end</span></pre>
294
+ </div>
295
+
296
+ </div>
297
+
298
+
299
+ </div>
300
+
301
+
302
+ </div>
303
+
304
+
305
+ </div>
306
+
307
+
308
+ <div id="rdoc-debugging-section-dump" class="debugging-section">
309
+
310
+ <p>Disabled; run with --debug to generate this.</p>
311
+
312
+ </div>
313
+
314
+ <div id="validator-badges">
315
+ <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
316
+ <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
317
+ Rdoc Generator</a> 1.1.6</small>.</p>
318
+ </div>
319
+
320
+ </body>
321
+ </html>
322
+
data/src/doc/Log4r/Logger.html ADDED
@@ -0,0 +1,1132 @@
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::Logger</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/loggerfactory_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
32
+ class="thickbox" title="log4r/loggerfactory.rb">log4r/loggerfactory.rb</a></li>
33
+
34
+ <li><a href="../log4r/logger_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
35
+ class="thickbox" title="log4r/logger.rb">log4r/logger.rb</a></li>
36
+
37
+ <li><a href="../log4r/repository_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
38
+ class="thickbox" title="log4r/repository.rb">log4r/repository.rb</a></li>
39
+
40
+ <li><a href="../log4r/staticlogger_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
41
+ class="thickbox" title="log4r/staticlogger.rb">log4r/staticlogger.rb</a></li>
42
+
43
+ </ul>
44
+ </div>
45
+ </div>
46
+
47
+
48
+ </div>
49
+
50
+ <div id="class-metadata">
51
+
52
+ <!-- Parent Class -->
53
+
54
+ <div id="parent-class-section" class="section">
55
+ <h3 class="section-header">Parent</h3>
56
+
57
+ <p class="link">Object</p>
58
+
59
+ </div>
60
+
61
+
62
+ <!-- Namespace Contents -->
63
+
64
+ <div id="namespace-list-section" class="section">
65
+ <h3 class="section-header">Namespace</h3>
66
+ <ul class="link-list">
67
+
68
+ <li><span class="type">CLASS</span> <a href="Logger/LoggerFactory.html">Log4r::Logger::LoggerFactory</a></li>
69
+
70
+ <li><span class="type">CLASS</span> <a href="Logger/Repository.html">Log4r::Logger::Repository</a></li>
71
+
72
+ </ul>
73
+ </div>
74
+
75
+
76
+ <!-- Method Quickref -->
77
+
78
+ <div id="method-list-section" class="section">
79
+ <h3 class="section-header">Methods</h3>
80
+ <ul class="link-list">
81
+
82
+ <li><a href="#M000111">::[]</a></li>
83
+
84
+ <li><a href="#M000113">::each</a></li>
85
+
86
+ <li><a href="#M000114">::each_logger</a></li>
87
+
88
+ <li><a href="#M000112">::get</a></li>
89
+
90
+ <li><a href="#M000110">::global</a></li>
91
+
92
+ <li><a href="#M000115">::log_internal</a></li>
93
+
94
+ <li><a href="#M000037">::new</a></li>
95
+
96
+ <li><a href="#M000109">::root</a></li>
97
+
98
+ <li><a href="#M000048">#==</a></li>
99
+
100
+ <li><a href="#M000045">#add</a></li>
101
+
102
+ <li><a href="#M000041">#additive=</a></li>
103
+
104
+ <li><a href="#M000039">#deal_with_inheritance</a></li>
105
+
106
+ <li><a href="#M000047">#is_root?</a></li>
107
+
108
+ <li><a href="#M000040">#level=</a></li>
109
+
110
+ <li><a href="#M000044">#outputters=</a></li>
111
+
112
+ <li><a href="#M000043">#parent=</a></li>
113
+
114
+ <li><a href="#M000046">#remove</a></li>
115
+
116
+ <li><a href="#M000042">#trace=</a></li>
117
+
118
+ <li><a href="#M000038">#validate_name</a></li>
119
+
120
+ </ul>
121
+ </div>
122
+
123
+
124
+ <!-- Included Modules -->
125
+
126
+ </div>
127
+
128
+ <div id="project-metadata">
129
+
130
+
131
+ <div id="fileindex-section" class="section project-section">
132
+ <h3 class="section-header">Files</h3>
133
+ <ul>
134
+
135
+ <li class="file"><a href="../log4r/rdoc/configurator.html">configurator</a></li>
136
+
137
+ <li class="file"><a href="../log4r/rdoc/emailoutputter.html">emailoutputter</a></li>
138
+
139
+ <li class="file"><a href="../log4r/rdoc/formatter.html">formatter</a></li>
140
+
141
+ <li class="file"><a href="../log4r/rdoc/log4r.html">log4r</a></li>
142
+
143
+ <li class="file"><a href="../log4r/rdoc/logger.html">logger</a></li>
144
+
145
+ <li class="file"><a href="../log4r/rdoc/logserver.html">logserver</a></li>
146
+
147
+ <li class="file"><a href="../log4r/rdoc/outputter.html">outputter</a></li>
148
+
149
+ <li class="file"><a href="../log4r/rdoc/patternformatter.html">patternformatter</a></li>
150
+
151
+ <li class="file"><a href="../log4r/rdoc/syslogoutputter.html">syslogoutputter</a></li>
152
+
153
+ <li class="file"><a href="../log4r/rdoc/yamlconfigurator.html">yamlconfigurator</a></li>
154
+
155
+ </ul>
156
+ </div>
157
+
158
+
159
+ <div id="classindex-section" class="section project-section">
160
+ <h3 class="section-header">Class Index
161
+ <span class="search-toggle"><img src="../images/find.png"
162
+ height="16" width="16" alt="[+]"
163
+ title="show/hide quicksearch" /></span></h3>
164
+ <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
165
+ <fieldset>
166
+ <legend>Quicksearch</legend>
167
+ <input type="text" name="quicksearch" value=""
168
+ class="quicksearch-field" />
169
+ </fieldset>
170
+ </form>
171
+
172
+ <ul class="link-list">
173
+
174
+ <li><a href="../Log4r.html">Log4r</a></li>
175
+
176
+ <li><a href="../Log4r/BasicFormatter.html">Log4r::BasicFormatter</a></li>
177
+
178
+ <li><a href="../Log4r/ConfigError.html">Log4r::ConfigError</a></li>
179
+
180
+ <li><a href="../Log4r/Configurator.html">Log4r::Configurator</a></li>
181
+
182
+ <li><a href="../Log4r/DateFileOutputter.html">Log4r::DateFileOutputter</a></li>
183
+
184
+ <li><a href="../Log4r/DefaultFormatter.html">Log4r::DefaultFormatter</a></li>
185
+
186
+ <li><a href="../Log4r/EmailOutputter.html">Log4r::EmailOutputter</a></li>
187
+
188
+ <li><a href="../Log4r/FileOutputter.html">Log4r::FileOutputter</a></li>
189
+
190
+ <li><a href="../Log4r/Formatter.html">Log4r::Formatter</a></li>
191
+
192
+ <li><a href="../Log4r/IOOutputter.html">Log4r::IOOutputter</a></li>
193
+
194
+ <li><a href="../Log4r/Log4rTools.html">Log4r::Log4rTools</a></li>
195
+
196
+ <li><a href="../Log4r/LogEvent.html">Log4r::LogEvent</a></li>
197
+
198
+ <li><a href="../Log4r/LogServer.html">Log4r::LogServer</a></li>
199
+
200
+ <li><a href="../Log4r/Logger.html">Log4r::Logger</a></li>
201
+
202
+ <li><a href="../Log4r/ObjectFormatter.html">Log4r::ObjectFormatter</a></li>
203
+
204
+ <li><a href="../Log4r/Outputter.html">Log4r::Outputter</a></li>
205
+
206
+ <li><a href="../Log4r/PatternFormatter.html">Log4r::PatternFormatter</a></li>
207
+
208
+ <li><a href="../Log4r/RemoteOutputter.html">Log4r::RemoteOutputter</a></li>
209
+
210
+ <li><a href="../Log4r/RollingFileOutputter.html">Log4r::RollingFileOutputter</a></li>
211
+
212
+ <li><a href="../Log4r/RootLogger.html">Log4r::RootLogger</a></li>
213
+
214
+ <li><a href="../Log4r/SimpleFormatter.html">Log4r::SimpleFormatter</a></li>
215
+
216
+ <li><a href="../Log4r/StderrOutputter.html">Log4r::StderrOutputter</a></li>
217
+
218
+ <li><a href="../Log4r/StdoutOutputter.html">Log4r::StdoutOutputter</a></li>
219
+
220
+ <li><a href="../Log4r/SyslogOutputter.html">Log4r::SyslogOutputter</a></li>
221
+
222
+ <li><a href="../Log4r/YamlConfigurator.html">Log4r::YamlConfigurator</a></li>
223
+
224
+ </ul>
225
+ <div id="no-class-search-results" style="display: none;">No matching classes.</div>
226
+ </div>
227
+
228
+
229
+ </div>
230
+ </div>
231
+
232
+ <div id="documentation">
233
+ <h1 class="class">Log4r::Logger</h1>
234
+
235
+ <div id="description">
236
+ <p>
237
+ See <a href="../log4r/logger_rb.html">log4r/logger.rb</a>
238
+ </p>
239
+
240
+ </div>
241
+
242
+ <!-- Constants -->
243
+
244
+
245
+ <!-- Attributes -->
246
+
247
+ <div id="attribute-method-details" class="method-section section">
248
+ <h3 class="section-header">Attributes</h3>
249
+
250
+
251
+ <div id="name-attribute-method" class="method-detail">
252
+ <a name="name"></a>
253
+
254
+ <div class="method-heading attribute-method-heading">
255
+ <span class="method-name">name</span><span
256
+ class="attribute-access-type">[R]</span>
257
+ </div>
258
+
259
+ <div class="method-description">
260
+
261
+ <p class="missing-docs">(Not documented)</p>
262
+
263
+ </div>
264
+ </div>
265
+
266
+ <div id="fullname-attribute-method" class="method-detail">
267
+ <a name="fullname"></a>
268
+
269
+ <div class="method-heading attribute-method-heading">
270
+ <span class="method-name">fullname</span><span
271
+ class="attribute-access-type">[R]</span>
272
+ </div>
273
+
274
+ <div class="method-description">
275
+
276
+ <p class="missing-docs">(Not documented)</p>
277
+
278
+ </div>
279
+ </div>
280
+
281
+ <div id="path-attribute-method" class="method-detail">
282
+ <a name="path"></a>
283
+
284
+ <div class="method-heading attribute-method-heading">
285
+ <span class="method-name">path</span><span
286
+ class="attribute-access-type">[R]</span>
287
+ </div>
288
+
289
+ <div class="method-description">
290
+
291
+ <p class="missing-docs">(Not documented)</p>
292
+
293
+ </div>
294
+ </div>
295
+
296
+ <div id="level-attribute-method" class="method-detail">
297
+ <a name="level"></a>
298
+
299
+ <div class="method-heading attribute-method-heading">
300
+ <span class="method-name">level</span><span
301
+ class="attribute-access-type">[R]</span>
302
+ </div>
303
+
304
+ <div class="method-description">
305
+
306
+ <p class="missing-docs">(Not documented)</p>
307
+
308
+ </div>
309
+ </div>
310
+
311
+ <div id="parent-attribute-method" class="method-detail">
312
+ <a name="parent"></a>
313
+
314
+ <div class="method-heading attribute-method-heading">
315
+ <span class="method-name">parent</span><span
316
+ class="attribute-access-type">[R]</span>
317
+ </div>
318
+
319
+ <div class="method-description">
320
+
321
+ <p class="missing-docs">(Not documented)</p>
322
+
323
+ </div>
324
+ </div>
325
+
326
+ <div id="additive-attribute-method" class="method-detail">
327
+ <a name="additive"></a>
328
+
329
+ <div class="method-heading attribute-method-heading">
330
+ <span class="method-name">additive</span><span
331
+ class="attribute-access-type">[R]</span>
332
+ </div>
333
+
334
+ <div class="method-description">
335
+
336
+ <p class="missing-docs">(Not documented)</p>
337
+
338
+ </div>
339
+ </div>
340
+
341
+ <div id="trace-attribute-method" class="method-detail">
342
+ <a name="trace"></a>
343
+
344
+ <div class="method-heading attribute-method-heading">
345
+ <span class="method-name">trace</span><span
346
+ class="attribute-access-type">[R]</span>
347
+ </div>
348
+
349
+ <div class="method-description">
350
+
351
+ <p class="missing-docs">(Not documented)</p>
352
+
353
+ </div>
354
+ </div>
355
+
356
+ <div id="outputters-attribute-method" class="method-detail">
357
+ <a name="outputters"></a>
358
+
359
+ <div class="method-heading attribute-method-heading">
360
+ <span class="method-name">outputters</span><span
361
+ class="attribute-access-type">[R]</span>
362
+ </div>
363
+
364
+ <div class="method-description">
365
+
366
+ <p class="missing-docs">(Not documented)</p>
367
+
368
+ </div>
369
+ </div>
370
+
371
+ </div>
372
+
373
+
374
+ <!-- Methods -->
375
+
376
+ <div id="public-class-method-details" class="method-section section">
377
+ <h3 class="section-header">Public Class Methods</h3>
378
+
379
+
380
+ <div id="--method" class="method-detail ">
381
+ <a name="M000111"></a>
382
+
383
+ <div class="method-heading">
384
+
385
+ <span class="method-name">[]</span><span
386
+ class="method-args">(_fullname)</span>
387
+ <span class="method-click-advice">click to toggle source</span>
388
+
389
+ </div>
390
+
391
+ <div class="method-description">
392
+
393
+ <p>
394
+ Get a logger with a fullname from the repository or nil if logger
395
+ wasn&#8217;t found.
396
+ </p>
397
+
398
+
399
+
400
+ <div class="method-source-code"
401
+ id="--source">
402
+ <pre>
403
+ <span class="ruby-comment cmt"># File log4r/staticlogger.rb, line 12</span>
404
+ <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-operator">[]</span>(<span class="ruby-identifier">_fullname</span>)
405
+ <span class="ruby-comment cmt"># forces creation of RootLogger if it doesn't exist yet.</span>
406
+ <span class="ruby-keyword kw">return</span> <span class="ruby-constant">RootLogger</span>.<span class="ruby-identifier">instance</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">_fullname</span><span class="ruby-operator">==</span><span class="ruby-value str">'root'</span> <span class="ruby-keyword kw">or</span> <span class="ruby-identifier">_fullname</span><span class="ruby-operator">==</span><span class="ruby-value str">'global'</span>
407
+ <span class="ruby-constant">Repository</span>[<span class="ruby-identifier">_fullname</span>]
408
+ <span class="ruby-keyword kw">end</span></pre>
409
+ </div>
410
+
411
+ </div>
412
+
413
+
414
+ </div>
415
+
416
+
417
+ <div id="each-method" class="method-detail ">
418
+ <a name="M000113"></a>
419
+
420
+ <div class="method-heading">
421
+
422
+ <span class="method-name">each</span><span
423
+ class="method-args">()</span>
424
+ <span class="method-click-advice">click to toggle source</span>
425
+
426
+ </div>
427
+
428
+ <div class="method-description">
429
+
430
+ <p>
431
+ Yields fullname and logger for every logger in the system.
432
+ </p>
433
+
434
+
435
+
436
+ <div class="method-source-code"
437
+ id="each-source">
438
+ <pre>
439
+ <span class="ruby-comment cmt"># File log4r/staticlogger.rb, line 29</span>
440
+ <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">each</span>
441
+ <span class="ruby-keyword kw">for</span> <span class="ruby-identifier">fullname</span>, <span class="ruby-identifier">logger</span> <span class="ruby-keyword kw">in</span> <span class="ruby-constant">Repository</span>.<span class="ruby-identifier">instance</span>.<span class="ruby-identifier">loggers</span>
442
+ <span class="ruby-keyword kw">yield</span> <span class="ruby-identifier">fullname</span>, <span class="ruby-identifier">logger</span>
443
+ <span class="ruby-keyword kw">end</span>
444
+ <span class="ruby-keyword kw">end</span></pre>
445
+ </div>
446
+
447
+ </div>
448
+
449
+
450
+ </div>
451
+
452
+
453
+ <div id="each-logger-method" class="method-detail ">
454
+ <a name="M000114"></a>
455
+
456
+ <div class="method-heading">
457
+
458
+ <span class="method-name">each_logger</span><span
459
+ class="method-args">()</span>
460
+ <span class="method-click-advice">click to toggle source</span>
461
+
462
+ </div>
463
+
464
+ <div class="method-description">
465
+
466
+ <p class="missing-docs">(Not documented)</p>
467
+
468
+
469
+
470
+ <div class="method-source-code"
471
+ id="each-logger-source">
472
+ <pre>
473
+ <span class="ruby-comment cmt"># File log4r/staticlogger.rb, line 35</span>
474
+ <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">each_logger</span>
475
+ <span class="ruby-constant">Repository</span>.<span class="ruby-identifier">instance</span>.<span class="ruby-identifier">loggers</span>.<span class="ruby-identifier">each_value</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">logger</span><span class="ruby-operator">|</span> <span class="ruby-keyword kw">yield</span> <span class="ruby-identifier">logger</span>}
476
+ <span class="ruby-keyword kw">end</span></pre>
477
+ </div>
478
+
479
+ </div>
480
+
481
+
482
+ </div>
483
+
484
+
485
+ <div id="get-method" class="method-detail ">
486
+ <a name="M000112"></a>
487
+
488
+ <div class="method-heading">
489
+
490
+ <span class="method-name">get</span><span
491
+ class="method-args">(_fullname)</span>
492
+ <span class="method-click-advice">click to toggle source</span>
493
+
494
+ </div>
495
+
496
+ <div class="method-description">
497
+
498
+ <p>
499
+ Like Logger[] except that it raises NameError if <a
500
+ href="Logger.html">Logger</a> wasn&#8217;t found.
501
+ </p>
502
+
503
+
504
+
505
+ <div class="method-source-code"
506
+ id="get-source">
507
+ <pre>
508
+ <span class="ruby-comment cmt"># File log4r/staticlogger.rb, line 20</span>
509
+ <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">get</span>(<span class="ruby-identifier">_fullname</span>)
510
+ <span class="ruby-identifier">logger</span> = <span class="ruby-keyword kw">self</span>[<span class="ruby-identifier">_fullname</span>]
511
+ <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">logger</span>.<span class="ruby-identifier">nil?</span>
512
+ <span class="ruby-identifier">raise</span> <span class="ruby-constant">NameError</span>, <span class="ruby-node">&quot;Logger '#{_fullname}' not found.&quot;</span>, <span class="ruby-identifier">caller</span>
513
+ <span class="ruby-keyword kw">end</span>
514
+ <span class="ruby-identifier">logger</span>
515
+ <span class="ruby-keyword kw">end</span></pre>
516
+ </div>
517
+
518
+ </div>
519
+
520
+
521
+ </div>
522
+
523
+
524
+ <div id="global-method" class="method-detail ">
525
+ <a name="M000110"></a>
526
+
527
+ <div class="method-heading">
528
+
529
+ <span class="method-name">global</span><span
530
+ class="method-args">()</span>
531
+ <span class="method-click-advice">click to toggle source</span>
532
+
533
+ </div>
534
+
535
+ <div class="method-description">
536
+
537
+ <p>
538
+ Returns the root logger. Identical to <a
539
+ href="Logger.html#M000109">Logger.root</a>
540
+ </p>
541
+
542
+
543
+
544
+ <div class="method-source-code"
545
+ id="global-source">
546
+ <pre>
547
+ <span class="ruby-comment cmt"># File log4r/staticlogger.rb, line 7</span>
548
+ <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">global</span>; <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">root</span> <span class="ruby-keyword kw">end</span></pre>
549
+ </div>
550
+
551
+ </div>
552
+
553
+
554
+ </div>
555
+
556
+
557
+ <div id="log-internal-method" class="method-detail ">
558
+ <a name="M000115"></a>
559
+
560
+ <div class="method-heading">
561
+
562
+ <span class="method-name">log_internal</span><span
563
+ class="method-args">(level=1)</span>
564
+ <span class="method-click-advice">click to toggle source</span>
565
+
566
+ </div>
567
+
568
+ <div class="method-description">
569
+
570
+ <p>
571
+ Internal logging for <a href="../Log4r.html">Log4r</a> components. Accepts
572
+ only blocks. To see such log events, create a logger named
573
+ &#8216;log4r&#8217; and give it an outputter.
574
+ </p>
575
+
576
+
577
+
578
+ <div class="method-source-code"
579
+ id="log-internal-source">
580
+ <pre>
581
+ <span class="ruby-comment cmt"># File log4r/staticlogger.rb, line 43</span>
582
+ <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">log_internal</span>(<span class="ruby-identifier">level</span>=<span class="ruby-value">1</span>)
583
+ <span class="ruby-identifier">internal</span> = <span class="ruby-constant">Logger</span>[<span class="ruby-value str">'log4r'</span>]
584
+ <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">internal</span>.<span class="ruby-identifier">nil?</span>
585
+ <span class="ruby-identifier">internal</span>.<span class="ruby-identifier">send</span>(<span class="ruby-constant">LNAMES</span>[<span class="ruby-identifier">level</span>].<span class="ruby-identifier">downcase</span>, <span class="ruby-keyword kw">yield</span>)
586
+ <span class="ruby-keyword kw">end</span></pre>
587
+ </div>
588
+
589
+ </div>
590
+
591
+
592
+ </div>
593
+
594
+
595
+ <div id="new-method" class="method-detail ">
596
+ <a name="M000037"></a>
597
+
598
+ <div class="method-heading">
599
+
600
+ <span class="method-name">new</span><span
601
+ class="method-args">(_fullname, _level=nil, _additive=true, _trace=false)</span>
602
+ <span class="method-click-advice">click to toggle source</span>
603
+
604
+ </div>
605
+
606
+ <div class="method-description">
607
+
608
+ <p>
609
+ <a href="Logger.html">Logger</a> requires a name. The last 3 parameters
610
+ are:
611
+ </p>
612
+ <table>
613
+ <tr><td valign="top">level:</td><td>Do I have a level? (Otherwise, I&#8217;ll inherit my parent&#8217;s)
614
+
615
+ </td></tr>
616
+ <tr><td valign="top">additive:</td><td>Am I additive?
617
+
618
+ </td></tr>
619
+ <tr><td valign="top">trace:</td><td>Do I record the execution trace? (slows things a wee bit)
620
+
621
+ </td></tr>
622
+ </table>
623
+
624
+
625
+
626
+ <div class="method-source-code"
627
+ id="new-source">
628
+ <pre>
629
+ <span class="ruby-comment cmt"># File log4r/logger.rb, line 26</span>
630
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">_fullname</span>, <span class="ruby-identifier">_level</span>=<span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">_additive</span>=<span class="ruby-keyword kw">true</span>, <span class="ruby-identifier">_trace</span>=<span class="ruby-keyword kw">false</span>)
631
+ <span class="ruby-comment cmt"># validation</span>
632
+ <span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-value str">&quot;Logger must have a name&quot;</span>, <span class="ruby-identifier">caller</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">_fullname</span>.<span class="ruby-identifier">nil?</span>
633
+ <span class="ruby-constant">Log4rTools</span>.<span class="ruby-identifier">validate_level</span>(<span class="ruby-identifier">_level</span>) <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">_level</span>.<span class="ruby-identifier">nil?</span>
634
+ <span class="ruby-identifier">validate_name</span>(<span class="ruby-identifier">_fullname</span>)
635
+
636
+ <span class="ruby-comment cmt"># create the logger</span>
637
+ <span class="ruby-ivar">@fullname</span> = <span class="ruby-identifier">_fullname</span>
638
+ <span class="ruby-ivar">@outputters</span> = []
639
+ <span class="ruby-ivar">@additive</span> = <span class="ruby-identifier">_additive</span>
640
+ <span class="ruby-identifier">deal_with_inheritance</span>(<span class="ruby-identifier">_level</span>)
641
+ <span class="ruby-constant">LoggerFactory</span>.<span class="ruby-identifier">define_methods</span>(<span class="ruby-keyword kw">self</span>)
642
+ <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">trace</span> = <span class="ruby-identifier">_trace</span>
643
+ <span class="ruby-constant">Repository</span>[<span class="ruby-ivar">@fullname</span>] = <span class="ruby-keyword kw">self</span>
644
+ <span class="ruby-keyword kw">end</span></pre>
645
+ </div>
646
+
647
+ </div>
648
+
649
+
650
+ </div>
651
+
652
+
653
+ <div id="root-method" class="method-detail ">
654
+ <a name="M000109"></a>
655
+
656
+ <div class="method-heading">
657
+
658
+ <span class="method-name">root</span><span
659
+ class="method-args">()</span>
660
+ <span class="method-click-advice">click to toggle source</span>
661
+
662
+ </div>
663
+
664
+ <div class="method-description">
665
+
666
+ <p>
667
+ Returns the root logger. Identical to <a
668
+ href="Logger.html#M000110">Logger.global</a>
669
+ </p>
670
+
671
+
672
+
673
+ <div class="method-source-code"
674
+ id="root-source">
675
+ <pre>
676
+ <span class="ruby-comment cmt"># File log4r/staticlogger.rb, line 5</span>
677
+ <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">root</span>; <span class="ruby-keyword kw">return</span> <span class="ruby-constant">RootLogger</span>.<span class="ruby-identifier">instance</span> <span class="ruby-keyword kw">end</span></pre>
678
+ </div>
679
+
680
+ </div>
681
+
682
+
683
+ </div>
684
+
685
+
686
+ </div>
687
+
688
+ <div id="public-instance-method-details" class="method-section section">
689
+ <h3 class="section-header">Public Instance Methods</h3>
690
+
691
+
692
+ <div id="--method" class="method-detail ">
693
+ <a name="M000048"></a>
694
+
695
+ <div class="method-heading">
696
+
697
+ <span class="method-name">==</span><span
698
+ class="method-args">(other)</span>
699
+ <span class="method-click-advice">click to toggle source</span>
700
+
701
+ </div>
702
+
703
+ <div class="method-description">
704
+
705
+ <p class="missing-docs">(Not documented)</p>
706
+
707
+
708
+
709
+ <div class="method-source-code"
710
+ id="--source">
711
+ <pre>
712
+ <span class="ruby-comment cmt"># File log4r/logger.rb, line 140</span>
713
+ <span class="ruby-keyword kw">def</span> <span class="ruby-operator">==</span>(<span class="ruby-identifier">other</span>)
714
+ <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">true</span> <span class="ruby-keyword kw">if</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">object_id</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">other</span>.<span class="ruby-identifier">object_id</span>
715
+ <span class="ruby-keyword kw">end</span></pre>
716
+ </div>
717
+
718
+ </div>
719
+
720
+
721
+ </div>
722
+
723
+
724
+ <div id="add-method" class="method-detail ">
725
+ <a name="M000045"></a>
726
+
727
+ <div class="method-heading">
728
+
729
+ <span class="method-name">add</span><span
730
+ class="method-args">(*_outputters)</span>
731
+ <span class="method-click-advice">click to toggle source</span>
732
+
733
+ </div>
734
+
735
+ <div class="method-description">
736
+
737
+ <p>
738
+ Add outputters by name or by reference. Can be done any time.
739
+ </p>
740
+
741
+
742
+
743
+ <div class="method-source-code"
744
+ id="add-source">
745
+ <pre>
746
+ <span class="ruby-comment cmt"># File log4r/logger.rb, line 114</span>
747
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">add</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">_outputters</span>)
748
+ <span class="ruby-keyword kw">for</span> <span class="ruby-identifier">thing</span> <span class="ruby-keyword kw">in</span> <span class="ruby-identifier">_outputters</span>
749
+ <span class="ruby-identifier">o</span> = (<span class="ruby-identifier">thing</span>.<span class="ruby-identifier">kind_of?</span>(<span class="ruby-constant">Outputter</span>) <span class="ruby-operator">?</span> <span class="ruby-identifier">thing</span> <span class="ruby-operator">:</span> <span class="ruby-constant">Outputter</span>[<span class="ruby-identifier">thing</span>])
750
+ <span class="ruby-comment cmt"># some basic validation</span>
751
+ <span class="ruby-keyword kw">if</span> <span class="ruby-keyword kw">not</span> <span class="ruby-identifier">o</span>.<span class="ruby-identifier">kind_of?</span>(<span class="ruby-constant">Outputter</span>)
752
+ <span class="ruby-identifier">raise</span> <span class="ruby-constant">TypeError</span>, <span class="ruby-node">&quot;Expected kind of Outputter, got #{o.class}&quot;</span>, <span class="ruby-identifier">caller</span>
753
+ <span class="ruby-keyword kw">elsif</span> <span class="ruby-identifier">o</span>.<span class="ruby-identifier">nil?</span>
754
+ <span class="ruby-identifier">raise</span> <span class="ruby-constant">TypeError</span>, <span class="ruby-node">&quot;Couldn't find Outputter '#{thing}'&quot;</span>, <span class="ruby-identifier">caller</span>
755
+ <span class="ruby-keyword kw">end</span>
756
+ <span class="ruby-ivar">@outputters</span>.<span class="ruby-identifier">push</span> <span class="ruby-identifier">o</span>
757
+ <span class="ruby-constant">Logger</span>.<span class="ruby-identifier">log_internal</span> {<span class="ruby-node">&quot;Added outputter '#{o.name}' to '#{@fullname}'&quot;</span>}
758
+ <span class="ruby-keyword kw">end</span>
759
+ <span class="ruby-ivar">@outputters</span>
760
+ <span class="ruby-keyword kw">end</span></pre>
761
+ </div>
762
+
763
+ </div>
764
+
765
+
766
+ </div>
767
+
768
+
769
+ <div id="additive--method" class="method-detail ">
770
+ <a name="M000041"></a>
771
+
772
+ <div class="method-heading">
773
+
774
+ <span class="method-name">additive=</span><span
775
+ class="method-args">(_additive)</span>
776
+ <span class="method-click-advice">click to toggle source</span>
777
+
778
+ </div>
779
+
780
+ <div class="method-description">
781
+
782
+ <p>
783
+ Set the additivity of the logger dynamically. True or false.
784
+ </p>
785
+
786
+
787
+
788
+ <div class="method-source-code"
789
+ id="additive--source">
790
+ <pre>
791
+ <span class="ruby-comment cmt"># File log4r/logger.rb, line 82</span>
792
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">additive=</span>(<span class="ruby-identifier">_additive</span>)
793
+ <span class="ruby-ivar">@additive</span> = <span class="ruby-identifier">_additive</span>
794
+ <span class="ruby-constant">LoggerFactory</span>.<span class="ruby-identifier">define_methods</span>(<span class="ruby-keyword kw">self</span>)
795
+ <span class="ruby-constant">Logger</span>.<span class="ruby-identifier">log_internal</span> {<span class="ruby-node">&quot;Logger '#{@fullname}' is additive&quot;</span>}
796
+ <span class="ruby-ivar">@additive</span>
797
+ <span class="ruby-keyword kw">end</span></pre>
798
+ </div>
799
+
800
+ </div>
801
+
802
+
803
+ </div>
804
+
805
+
806
+ <div id="is-root--method" class="method-detail ">
807
+ <a name="M000047"></a>
808
+
809
+ <div class="method-heading">
810
+
811
+ <span class="method-name">is_root?</span><span
812
+ class="method-args">()</span>
813
+ <span class="method-click-advice">click to toggle source</span>
814
+
815
+ </div>
816
+
817
+ <div class="method-description">
818
+
819
+ <p class="missing-docs">(Not documented)</p>
820
+
821
+
822
+
823
+ <div class="method-source-code"
824
+ id="is-root--source">
825
+ <pre>
826
+ <span class="ruby-comment cmt"># File log4r/logger.rb, line 138</span>
827
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">is_root?</span>; <span class="ruby-keyword kw">false</span> <span class="ruby-keyword kw">end</span></pre>
828
+ </div>
829
+
830
+ </div>
831
+
832
+
833
+ </div>
834
+
835
+
836
+ <div id="level--method" class="method-detail ">
837
+ <a name="M000040"></a>
838
+
839
+ <div class="method-heading">
840
+
841
+ <span class="method-name">level=</span><span
842
+ class="method-args">(_level)</span>
843
+ <span class="method-click-advice">click to toggle source</span>
844
+
845
+ </div>
846
+
847
+ <div class="method-description">
848
+
849
+ <p>
850
+ Set the logger level dynamically. Does not affect children.
851
+ </p>
852
+
853
+
854
+
855
+ <div class="method-source-code"
856
+ id="level--source">
857
+ <pre>
858
+ <span class="ruby-comment cmt"># File log4r/logger.rb, line 73</span>
859
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">level=</span>(<span class="ruby-identifier">_level</span>)
860
+ <span class="ruby-constant">Log4rTools</span>.<span class="ruby-identifier">validate_level</span>(<span class="ruby-identifier">_level</span>)
861
+ <span class="ruby-ivar">@level</span> = <span class="ruby-identifier">_level</span>
862
+ <span class="ruby-constant">LoggerFactory</span>.<span class="ruby-identifier">define_methods</span>(<span class="ruby-keyword kw">self</span>)
863
+ <span class="ruby-constant">Logger</span>.<span class="ruby-identifier">log_internal</span> {<span class="ruby-node">&quot;Logger '#{@fullname}' set to #{LNAMES[@level]}&quot;</span>}
864
+ <span class="ruby-ivar">@level</span>
865
+ <span class="ruby-keyword kw">end</span></pre>
866
+ </div>
867
+
868
+ </div>
869
+
870
+
871
+ </div>
872
+
873
+
874
+ <div id="outputters--method" class="method-detail ">
875
+ <a name="M000044"></a>
876
+
877
+ <div class="method-heading">
878
+
879
+ <span class="method-name">outputters=</span><span
880
+ class="method-args">(_outputters)</span>
881
+ <span class="method-click-advice">click to toggle source</span>
882
+
883
+ </div>
884
+
885
+ <div class="method-description">
886
+
887
+ <p>
888
+ Set the Outputters dynamically by name or reference. Can be done any time.
889
+ </p>
890
+
891
+
892
+
893
+ <div class="method-source-code"
894
+ id="outputters--source">
895
+ <pre>
896
+ <span class="ruby-comment cmt"># File log4r/logger.rb, line 108</span>
897
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">outputters=</span>(<span class="ruby-identifier">_outputters</span>)
898
+ <span class="ruby-ivar">@outputters</span>.<span class="ruby-identifier">clear</span>
899
+ <span class="ruby-identifier">add</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">_outputters</span>)
900
+ <span class="ruby-keyword kw">end</span></pre>
901
+ </div>
902
+
903
+ </div>
904
+
905
+
906
+ </div>
907
+
908
+
909
+ <div id="parent--method" class="method-detail ">
910
+ <a name="M000043"></a>
911
+
912
+ <div class="method-heading">
913
+
914
+ <span class="method-name">parent=</span><span
915
+ class="method-args">(parent)</span>
916
+ <span class="method-click-advice">click to toggle source</span>
917
+
918
+ </div>
919
+
920
+ <div class="method-description">
921
+
922
+ <p>
923
+ Please don&#8217;t reset the parent
924
+ </p>
925
+
926
+
927
+
928
+ <div class="method-source-code"
929
+ id="parent--source">
930
+ <pre>
931
+ <span class="ruby-comment cmt"># File log4r/logger.rb, line 102</span>
932
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">parent=</span>(<span class="ruby-identifier">parent</span>)
933
+ <span class="ruby-ivar">@parent</span> = <span class="ruby-identifier">parent</span>
934
+ <span class="ruby-keyword kw">end</span></pre>
935
+ </div>
936
+
937
+ </div>
938
+
939
+
940
+ </div>
941
+
942
+
943
+ <div id="remove-method" class="method-detail ">
944
+ <a name="M000046"></a>
945
+
946
+ <div class="method-heading">
947
+
948
+ <span class="method-name">remove</span><span
949
+ class="method-args">(*_outputters)</span>
950
+ <span class="method-click-advice">click to toggle source</span>
951
+
952
+ </div>
953
+
954
+ <div class="method-description">
955
+
956
+ <p>
957
+ Remove outputters from this logger by name only. Can be done any time.
958
+ </p>
959
+
960
+
961
+
962
+ <div class="method-source-code"
963
+ id="remove-source">
964
+ <pre>
965
+ <span class="ruby-comment cmt"># File log4r/logger.rb, line 130</span>
966
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">remove</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">_outputters</span>)
967
+ <span class="ruby-keyword kw">for</span> <span class="ruby-identifier">name</span> <span class="ruby-keyword kw">in</span> <span class="ruby-identifier">_outputters</span>
968
+ <span class="ruby-identifier">o</span> = <span class="ruby-constant">Outputter</span>[<span class="ruby-identifier">name</span>]
969
+ <span class="ruby-ivar">@outputters</span>.<span class="ruby-identifier">delete</span> <span class="ruby-identifier">o</span>
970
+ <span class="ruby-constant">Logger</span>.<span class="ruby-identifier">log_internal</span> {<span class="ruby-node">&quot;Removed outputter '#{o.name}' from '#{@fullname}'&quot;</span>}
971
+ <span class="ruby-keyword kw">end</span>
972
+ <span class="ruby-keyword kw">end</span></pre>
973
+ </div>
974
+
975
+ </div>
976
+
977
+
978
+ </div>
979
+
980
+
981
+ <div id="trace--method" class="method-detail ">
982
+ <a name="M000042"></a>
983
+
984
+ <div class="method-heading">
985
+
986
+ <span class="method-name">trace=</span><span
987
+ class="method-args">(_trace)</span>
988
+ <span class="method-click-advice">click to toggle source</span>
989
+
990
+ </div>
991
+
992
+ <div class="method-description">
993
+
994
+ <p>
995
+ Set whether the logger traces. Can be set dynamically. Defaults to false
996
+ and understands the strings &#8216;true&#8217; and &#8216;false&#8217;.
997
+ </p>
998
+
999
+
1000
+
1001
+ <div class="method-source-code"
1002
+ id="trace--source">
1003
+ <pre>
1004
+ <span class="ruby-comment cmt"># File log4r/logger.rb, line 91</span>
1005
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">trace=</span>(<span class="ruby-identifier">_trace</span>)
1006
+ <span class="ruby-ivar">@trace</span> =
1007
+ <span class="ruby-keyword kw">case</span> <span class="ruby-identifier">_trace</span>
1008
+ <span class="ruby-keyword kw">when</span> <span class="ruby-value str">&quot;true&quot;</span>, <span class="ruby-keyword kw">true</span> <span class="ruby-keyword kw">then</span> <span class="ruby-keyword kw">true</span>
1009
+ <span class="ruby-keyword kw">else</span> <span class="ruby-keyword kw">false</span> <span class="ruby-keyword kw">end</span>
1010
+ <span class="ruby-constant">LoggerFactory</span>.<span class="ruby-identifier">define_methods</span>(<span class="ruby-keyword kw">self</span>)
1011
+ <span class="ruby-constant">Logger</span>.<span class="ruby-identifier">log_internal</span> {<span class="ruby-node">&quot;Logger '#{@fullname}' is tracing&quot;</span>} <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@trace</span>
1012
+ <span class="ruby-ivar">@trace</span>
1013
+ <span class="ruby-keyword kw">end</span></pre>
1014
+ </div>
1015
+
1016
+ </div>
1017
+
1018
+
1019
+ </div>
1020
+
1021
+
1022
+ </div>
1023
+
1024
+ <div id="private-instance-method-details" class="method-section section">
1025
+ <h3 class="section-header">Private Instance Methods</h3>
1026
+
1027
+
1028
+ <div id="deal-with-inheritance-method" class="method-detail ">
1029
+ <a name="M000039"></a>
1030
+
1031
+ <div class="method-heading">
1032
+
1033
+ <span class="method-name">deal_with_inheritance</span><span
1034
+ class="method-args">(_level)</span>
1035
+ <span class="method-click-advice">click to toggle source</span>
1036
+
1037
+ </div>
1038
+
1039
+ <div class="method-description">
1040
+
1041
+ <p>
1042
+ Parses name for location in heiarchy, sets the parent, and deals with level
1043
+ inheritance
1044
+ </p>
1045
+
1046
+
1047
+
1048
+ <div class="method-source-code"
1049
+ id="deal-with-inheritance-source">
1050
+ <pre>
1051
+ <span class="ruby-comment cmt"># File log4r/logger.rb, line 53</span>
1052
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">deal_with_inheritance</span>(<span class="ruby-identifier">_level</span>)
1053
+ <span class="ruby-identifier">mypath</span> = <span class="ruby-ivar">@fullname</span>.<span class="ruby-identifier">split</span> <span class="ruby-constant">Log4rConfig</span><span class="ruby-operator">::</span><span class="ruby-constant">LoggerPathDelimiter</span>
1054
+ <span class="ruby-ivar">@name</span> = <span class="ruby-identifier">mypath</span>.<span class="ruby-identifier">pop</span>
1055
+ <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">mypath</span>.<span class="ruby-identifier">empty?</span> <span class="ruby-comment cmt"># then root is my daddy</span>
1056
+ <span class="ruby-ivar">@path</span> = <span class="ruby-value str">&quot;&quot;</span>
1057
+ <span class="ruby-comment cmt"># This is one of the guarantees that RootLogger gets created</span>
1058
+ <span class="ruby-ivar">@parent</span> = <span class="ruby-constant">Logger</span>.<span class="ruby-identifier">root</span>
1059
+ <span class="ruby-keyword kw">else</span>
1060
+ <span class="ruby-ivar">@path</span> = <span class="ruby-identifier">mypath</span>.<span class="ruby-identifier">join</span>(<span class="ruby-constant">Log4rConfig</span><span class="ruby-operator">::</span><span class="ruby-constant">LoggerPathDelimiter</span>)
1061
+ <span class="ruby-ivar">@parent</span> = <span class="ruby-constant">Repository</span>.<span class="ruby-identifier">find_ancestor</span>(<span class="ruby-ivar">@path</span>)
1062
+ <span class="ruby-ivar">@parent</span> = <span class="ruby-constant">Logger</span>.<span class="ruby-identifier">root</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@parent</span>.<span class="ruby-identifier">nil?</span>
1063
+ <span class="ruby-keyword kw">end</span>
1064
+ <span class="ruby-comment cmt"># inherit the level if no level defined</span>
1065
+ <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">_level</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-keyword kw">then</span> <span class="ruby-ivar">@level</span> = <span class="ruby-ivar">@parent</span>.<span class="ruby-identifier">level</span>
1066
+ <span class="ruby-keyword kw">else</span> <span class="ruby-ivar">@level</span> = <span class="ruby-identifier">_level</span> <span class="ruby-keyword kw">end</span>
1067
+ <span class="ruby-constant">Repository</span>.<span class="ruby-identifier">reassign_any_children</span>(<span class="ruby-keyword kw">self</span>)
1068
+ <span class="ruby-keyword kw">end</span></pre>
1069
+ </div>
1070
+
1071
+ </div>
1072
+
1073
+
1074
+ </div>
1075
+
1076
+
1077
+ <div id="validate-name-method" class="method-detail ">
1078
+ <a name="M000038"></a>
1079
+
1080
+ <div class="method-heading">
1081
+
1082
+ <span class="method-name">validate_name</span><span
1083
+ class="method-args">(_fullname)</span>
1084
+ <span class="method-click-advice">click to toggle source</span>
1085
+
1086
+ </div>
1087
+
1088
+ <div class="method-description">
1089
+
1090
+ <p class="missing-docs">(Not documented)</p>
1091
+
1092
+
1093
+
1094
+ <div class="method-source-code"
1095
+ id="validate-name-source">
1096
+ <pre>
1097
+ <span class="ruby-comment cmt"># File log4r/logger.rb, line 42</span>
1098
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">validate_name</span>(<span class="ruby-identifier">_fullname</span>)
1099
+ <span class="ruby-identifier">parts</span> = <span class="ruby-identifier">_fullname</span>.<span class="ruby-identifier">split</span> <span class="ruby-constant">Log4rConfig</span><span class="ruby-operator">::</span><span class="ruby-constant">LoggerPathDelimiter</span>
1100
+ <span class="ruby-keyword kw">for</span> <span class="ruby-identifier">part</span> <span class="ruby-keyword kw">in</span> <span class="ruby-identifier">parts</span>
1101
+ <span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-value str">&quot;Malformed path&quot;</span>, <span class="ruby-identifier">caller</span>[<span class="ruby-value">1</span><span class="ruby-operator">..</span><span class="ruby-value">-1</span>] <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">part</span>.<span class="ruby-identifier">empty?</span>
1102
+ <span class="ruby-keyword kw">end</span>
1103
+ <span class="ruby-keyword kw">end</span></pre>
1104
+ </div>
1105
+
1106
+ </div>
1107
+
1108
+
1109
+ </div>
1110
+
1111
+
1112
+ </div>
1113
+
1114
+
1115
+ </div>
1116
+
1117
+
1118
+ <div id="rdoc-debugging-section-dump" class="debugging-section">
1119
+
1120
+ <p>Disabled; run with --debug to generate this.</p>
1121
+
1122
+ </div>
1123
+
1124
+ <div id="validator-badges">
1125
+ <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
1126
+ <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
1127
+ Rdoc Generator</a> 1.1.6</small>.</p>
1128
+ </div>
1129
+
1130
+ </body>
1131
+ </html>
1132
+