log4r 1.1.1 → 1.1.2

Sign up to get free protection for your applications and to get access to all the features.
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/FileOutputter.html ADDED
@@ -0,0 +1,321 @@
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::FileOutputter</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/outputter/fileoutputter_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
32
+ class="thickbox" title="log4r/outputter/fileoutputter.rb">log4r/outputter/fileoutputter.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">IOOutputter</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="#M000070">::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/configurator.html">configurator</a></li>
80
+
81
+ <li class="file"><a href="../log4r/rdoc/emailoutputter.html">emailoutputter</a></li>
82
+
83
+ <li class="file"><a href="../log4r/rdoc/formatter.html">formatter</a></li>
84
+
85
+ <li class="file"><a href="../log4r/rdoc/log4r.html">log4r</a></li>
86
+
87
+ <li class="file"><a href="../log4r/rdoc/logger.html">logger</a></li>
88
+
89
+ <li class="file"><a href="../log4r/rdoc/logserver.html">logserver</a></li>
90
+
91
+ <li class="file"><a href="../log4r/rdoc/outputter.html">outputter</a></li>
92
+
93
+ <li class="file"><a href="../log4r/rdoc/patternformatter.html">patternformatter</a></li>
94
+
95
+ <li class="file"><a href="../log4r/rdoc/syslogoutputter.html">syslogoutputter</a></li>
96
+
97
+ <li class="file"><a href="../log4r/rdoc/yamlconfigurator.html">yamlconfigurator</a></li>
98
+
99
+ </ul>
100
+ </div>
101
+
102
+
103
+ <div id="classindex-section" class="section project-section">
104
+ <h3 class="section-header">Class Index
105
+ <span class="search-toggle"><img src="../images/find.png"
106
+ height="16" width="16" alt="[+]"
107
+ title="show/hide quicksearch" /></span></h3>
108
+ <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
109
+ <fieldset>
110
+ <legend>Quicksearch</legend>
111
+ <input type="text" name="quicksearch" value=""
112
+ class="quicksearch-field" />
113
+ </fieldset>
114
+ </form>
115
+
116
+ <ul class="link-list">
117
+
118
+ <li><a href="../Log4r.html">Log4r</a></li>
119
+
120
+ <li><a href="../Log4r/BasicFormatter.html">Log4r::BasicFormatter</a></li>
121
+
122
+ <li><a href="../Log4r/ConfigError.html">Log4r::ConfigError</a></li>
123
+
124
+ <li><a href="../Log4r/Configurator.html">Log4r::Configurator</a></li>
125
+
126
+ <li><a href="../Log4r/DateFileOutputter.html">Log4r::DateFileOutputter</a></li>
127
+
128
+ <li><a href="../Log4r/DefaultFormatter.html">Log4r::DefaultFormatter</a></li>
129
+
130
+ <li><a href="../Log4r/EmailOutputter.html">Log4r::EmailOutputter</a></li>
131
+
132
+ <li><a href="../Log4r/FileOutputter.html">Log4r::FileOutputter</a></li>
133
+
134
+ <li><a href="../Log4r/Formatter.html">Log4r::Formatter</a></li>
135
+
136
+ <li><a href="../Log4r/IOOutputter.html">Log4r::IOOutputter</a></li>
137
+
138
+ <li><a href="../Log4r/Log4rTools.html">Log4r::Log4rTools</a></li>
139
+
140
+ <li><a href="../Log4r/LogEvent.html">Log4r::LogEvent</a></li>
141
+
142
+ <li><a href="../Log4r/LogServer.html">Log4r::LogServer</a></li>
143
+
144
+ <li><a href="../Log4r/Logger.html">Log4r::Logger</a></li>
145
+
146
+ <li><a href="../Log4r/ObjectFormatter.html">Log4r::ObjectFormatter</a></li>
147
+
148
+ <li><a href="../Log4r/Outputter.html">Log4r::Outputter</a></li>
149
+
150
+ <li><a href="../Log4r/PatternFormatter.html">Log4r::PatternFormatter</a></li>
151
+
152
+ <li><a href="../Log4r/RemoteOutputter.html">Log4r::RemoteOutputter</a></li>
153
+
154
+ <li><a href="../Log4r/RollingFileOutputter.html">Log4r::RollingFileOutputter</a></li>
155
+
156
+ <li><a href="../Log4r/RootLogger.html">Log4r::RootLogger</a></li>
157
+
158
+ <li><a href="../Log4r/SimpleFormatter.html">Log4r::SimpleFormatter</a></li>
159
+
160
+ <li><a href="../Log4r/StderrOutputter.html">Log4r::StderrOutputter</a></li>
161
+
162
+ <li><a href="../Log4r/StdoutOutputter.html">Log4r::StdoutOutputter</a></li>
163
+
164
+ <li><a href="../Log4r/SyslogOutputter.html">Log4r::SyslogOutputter</a></li>
165
+
166
+ <li><a href="../Log4r/YamlConfigurator.html">Log4r::YamlConfigurator</a></li>
167
+
168
+ </ul>
169
+ <div id="no-class-search-results" style="display: none;">No matching classes.</div>
170
+ </div>
171
+
172
+
173
+ </div>
174
+ </div>
175
+
176
+ <div id="documentation">
177
+ <h1 class="class">Log4r::FileOutputter</h1>
178
+
179
+ <div id="description">
180
+ <p>
181
+ Convenience wrapper for File. Additional hash arguments are:
182
+ </p>
183
+ <dl>
184
+ <dt><tt>:filename</tt></dt><dd>Name of the file to log to.
185
+
186
+ </dd>
187
+ <dt><tt>:trunc</tt></dt><dd>Truncate the file?
188
+
189
+ </dd>
190
+ </dl>
191
+
192
+ </div>
193
+
194
+ <!-- Constants -->
195
+
196
+
197
+ <!-- Attributes -->
198
+
199
+ <div id="attribute-method-details" class="method-section section">
200
+ <h3 class="section-header">Attributes</h3>
201
+
202
+
203
+ <div id="trunc-attribute-method" class="method-detail">
204
+ <a name="trunc"></a>
205
+
206
+ <div class="method-heading attribute-method-heading">
207
+ <span class="method-name">trunc</span><span
208
+ class="attribute-access-type">[R]</span>
209
+ </div>
210
+
211
+ <div class="method-description">
212
+
213
+ <p class="missing-docs">(Not documented)</p>
214
+
215
+ </div>
216
+ </div>
217
+
218
+ <div id="filename-attribute-method" class="method-detail">
219
+ <a name="filename"></a>
220
+
221
+ <div class="method-heading attribute-method-heading">
222
+ <span class="method-name">filename</span><span
223
+ class="attribute-access-type">[R]</span>
224
+ </div>
225
+
226
+ <div class="method-description">
227
+
228
+ <p class="missing-docs">(Not documented)</p>
229
+
230
+ </div>
231
+ </div>
232
+
233
+ </div>
234
+
235
+
236
+ <!-- Methods -->
237
+
238
+ <div id="public-class-method-details" class="method-section section">
239
+ <h3 class="section-header">Public Class Methods</h3>
240
+
241
+
242
+ <div id="new-method" class="method-detail ">
243
+ <a name="M000070"></a>
244
+
245
+ <div class="method-heading">
246
+
247
+ <span class="method-name">new</span><span
248
+ class="method-args">(_name, hash={})</span>
249
+ <span class="method-click-advice">click to toggle source</span>
250
+
251
+ </div>
252
+
253
+ <div class="method-description">
254
+
255
+ <p class="missing-docs">(Not documented)</p>
256
+
257
+
258
+
259
+ <div class="method-source-code"
260
+ id="new-source">
261
+ <pre>
262
+ <span class="ruby-comment cmt"># File log4r/outputter/fileoutputter.rb, line 16</span>
263
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">_name</span>, <span class="ruby-identifier">hash</span>={})
264
+ <span class="ruby-keyword kw">super</span>(<span class="ruby-identifier">_name</span>, <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">hash</span>)
265
+
266
+ <span class="ruby-ivar">@trunc</span> = <span class="ruby-constant">Log4rTools</span>.<span class="ruby-identifier">decode_bool</span>(<span class="ruby-identifier">hash</span>, <span class="ruby-identifier">:trunc</span>, <span class="ruby-keyword kw">true</span>)
267
+ <span class="ruby-identifier">_filename</span> = (<span class="ruby-identifier">hash</span>[<span class="ruby-identifier">:filename</span>] <span class="ruby-keyword kw">or</span> <span class="ruby-identifier">hash</span>[<span class="ruby-value str">'filename'</span>])
268
+
269
+ <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">_filename</span>.<span class="ruby-identifier">class</span> <span class="ruby-operator">!=</span> <span class="ruby-constant">String</span>
270
+ <span class="ruby-identifier">raise</span> <span class="ruby-constant">TypeError</span>, <span class="ruby-value str">&quot;Argument 'filename' must be a String&quot;</span>, <span class="ruby-identifier">caller</span>
271
+ <span class="ruby-keyword kw">end</span>
272
+
273
+ <span class="ruby-comment cmt"># file validation</span>
274
+ <span class="ruby-keyword kw">if</span> <span class="ruby-constant">FileTest</span>.<span class="ruby-identifier">exist?</span>( <span class="ruby-identifier">_filename</span> )
275
+ <span class="ruby-keyword kw">if</span> <span class="ruby-keyword kw">not</span> <span class="ruby-constant">FileTest</span>.<span class="ruby-identifier">file?</span>( <span class="ruby-identifier">_filename</span> )
276
+ <span class="ruby-identifier">raise</span> <span class="ruby-constant">StandardError</span>, <span class="ruby-node">&quot;'#{_filename}' is not a regular file&quot;</span>, <span class="ruby-identifier">caller</span>
277
+ <span class="ruby-keyword kw">elsif</span> <span class="ruby-keyword kw">not</span> <span class="ruby-constant">FileTest</span>.<span class="ruby-identifier">writable?</span>( <span class="ruby-identifier">_filename</span> )
278
+ <span class="ruby-identifier">raise</span> <span class="ruby-constant">StandardError</span>, <span class="ruby-node">&quot;'#{_filename}' is not writable!&quot;</span>, <span class="ruby-identifier">caller</span>
279
+ <span class="ruby-keyword kw">end</span>
280
+ <span class="ruby-keyword kw">else</span> <span class="ruby-comment cmt"># ensure directory is writable</span>
281
+ <span class="ruby-identifier">dir</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">dirname</span>( <span class="ruby-identifier">_filename</span> )
282
+ <span class="ruby-keyword kw">if</span> <span class="ruby-keyword kw">not</span> <span class="ruby-constant">FileTest</span>.<span class="ruby-identifier">writable?</span>( <span class="ruby-identifier">dir</span> )
283
+ <span class="ruby-identifier">raise</span> <span class="ruby-constant">StandardError</span>, <span class="ruby-node">&quot;'#{dir}' is not writable!&quot;</span>
284
+ <span class="ruby-keyword kw">end</span>
285
+ <span class="ruby-keyword kw">end</span>
286
+
287
+ <span class="ruby-ivar">@filename</span> = <span class="ruby-identifier">_filename</span>
288
+ <span class="ruby-ivar">@out</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@filename</span>, (<span class="ruby-ivar">@trunc</span> <span class="ruby-operator">?</span> <span class="ruby-value str">&quot;w&quot;</span> <span class="ruby-operator">:</span> <span class="ruby-value str">&quot;a&quot;</span>))
289
+ <span class="ruby-constant">Logger</span>.<span class="ruby-identifier">log_internal</span> {
290
+ <span class="ruby-node">&quot;FileOutputter '#{@name}' writing to #{@filename}&quot;</span>
291
+ }
292
+ <span class="ruby-keyword kw">end</span></pre>
293
+ </div>
294
+
295
+ </div>
296
+
297
+
298
+ </div>
299
+
300
+
301
+ </div>
302
+
303
+
304
+ </div>
305
+
306
+
307
+ <div id="rdoc-debugging-section-dump" class="debugging-section">
308
+
309
+ <p>Disabled; run with --debug to generate this.</p>
310
+
311
+ </div>
312
+
313
+ <div id="validator-badges">
314
+ <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
315
+ <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
316
+ Rdoc Generator</a> 1.1.6</small>.</p>
317
+ </div>
318
+
319
+ </body>
320
+ </html>
321
+
data/src/doc/Log4r/Formatter.html ADDED
@@ -0,0 +1,291 @@
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::Formatter</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/formatter/formatter_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
32
+ class="thickbox" title="log4r/formatter/formatter.rb">log4r/formatter/formatter.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="#M000006">::new</a></li>
63
+
64
+ <li><a href="#M000007">#format</a></li>
65
+
66
+ </ul>
67
+ </div>
68
+
69
+
70
+ <!-- Included Modules -->
71
+
72
+ </div>
73
+
74
+ <div id="project-metadata">
75
+
76
+
77
+ <div id="fileindex-section" class="section project-section">
78
+ <h3 class="section-header">Files</h3>
79
+ <ul>
80
+
81
+ <li class="file"><a href="../log4r/rdoc/configurator.html">configurator</a></li>
82
+
83
+ <li class="file"><a href="../log4r/rdoc/emailoutputter.html">emailoutputter</a></li>
84
+
85
+ <li class="file"><a href="../log4r/rdoc/formatter.html">formatter</a></li>
86
+
87
+ <li class="file"><a href="../log4r/rdoc/log4r.html">log4r</a></li>
88
+
89
+ <li class="file"><a href="../log4r/rdoc/logger.html">logger</a></li>
90
+
91
+ <li class="file"><a href="../log4r/rdoc/logserver.html">logserver</a></li>
92
+
93
+ <li class="file"><a href="../log4r/rdoc/outputter.html">outputter</a></li>
94
+
95
+ <li class="file"><a href="../log4r/rdoc/patternformatter.html">patternformatter</a></li>
96
+
97
+ <li class="file"><a href="../log4r/rdoc/syslogoutputter.html">syslogoutputter</a></li>
98
+
99
+ <li class="file"><a href="../log4r/rdoc/yamlconfigurator.html">yamlconfigurator</a></li>
100
+
101
+ </ul>
102
+ </div>
103
+
104
+
105
+ <div id="classindex-section" class="section project-section">
106
+ <h3 class="section-header">Class Index
107
+ <span class="search-toggle"><img src="../images/find.png"
108
+ height="16" width="16" alt="[+]"
109
+ title="show/hide quicksearch" /></span></h3>
110
+ <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
111
+ <fieldset>
112
+ <legend>Quicksearch</legend>
113
+ <input type="text" name="quicksearch" value=""
114
+ class="quicksearch-field" />
115
+ </fieldset>
116
+ </form>
117
+
118
+ <ul class="link-list">
119
+
120
+ <li><a href="../Log4r.html">Log4r</a></li>
121
+
122
+ <li><a href="../Log4r/BasicFormatter.html">Log4r::BasicFormatter</a></li>
123
+
124
+ <li><a href="../Log4r/ConfigError.html">Log4r::ConfigError</a></li>
125
+
126
+ <li><a href="../Log4r/Configurator.html">Log4r::Configurator</a></li>
127
+
128
+ <li><a href="../Log4r/DateFileOutputter.html">Log4r::DateFileOutputter</a></li>
129
+
130
+ <li><a href="../Log4r/DefaultFormatter.html">Log4r::DefaultFormatter</a></li>
131
+
132
+ <li><a href="../Log4r/EmailOutputter.html">Log4r::EmailOutputter</a></li>
133
+
134
+ <li><a href="../Log4r/FileOutputter.html">Log4r::FileOutputter</a></li>
135
+
136
+ <li><a href="../Log4r/Formatter.html">Log4r::Formatter</a></li>
137
+
138
+ <li><a href="../Log4r/IOOutputter.html">Log4r::IOOutputter</a></li>
139
+
140
+ <li><a href="../Log4r/Log4rTools.html">Log4r::Log4rTools</a></li>
141
+
142
+ <li><a href="../Log4r/LogEvent.html">Log4r::LogEvent</a></li>
143
+
144
+ <li><a href="../Log4r/LogServer.html">Log4r::LogServer</a></li>
145
+
146
+ <li><a href="../Log4r/Logger.html">Log4r::Logger</a></li>
147
+
148
+ <li><a href="../Log4r/ObjectFormatter.html">Log4r::ObjectFormatter</a></li>
149
+
150
+ <li><a href="../Log4r/Outputter.html">Log4r::Outputter</a></li>
151
+
152
+ <li><a href="../Log4r/PatternFormatter.html">Log4r::PatternFormatter</a></li>
153
+
154
+ <li><a href="../Log4r/RemoteOutputter.html">Log4r::RemoteOutputter</a></li>
155
+
156
+ <li><a href="../Log4r/RollingFileOutputter.html">Log4r::RollingFileOutputter</a></li>
157
+
158
+ <li><a href="../Log4r/RootLogger.html">Log4r::RootLogger</a></li>
159
+
160
+ <li><a href="../Log4r/SimpleFormatter.html">Log4r::SimpleFormatter</a></li>
161
+
162
+ <li><a href="../Log4r/StderrOutputter.html">Log4r::StderrOutputter</a></li>
163
+
164
+ <li><a href="../Log4r/StdoutOutputter.html">Log4r::StdoutOutputter</a></li>
165
+
166
+ <li><a href="../Log4r/SyslogOutputter.html">Log4r::SyslogOutputter</a></li>
167
+
168
+ <li><a href="../Log4r/YamlConfigurator.html">Log4r::YamlConfigurator</a></li>
169
+
170
+ </ul>
171
+ <div id="no-class-search-results" style="display: none;">No matching classes.</div>
172
+ </div>
173
+
174
+
175
+ </div>
176
+ </div>
177
+
178
+ <div id="documentation">
179
+ <h1 class="class">Log4r::Formatter</h1>
180
+
181
+ <div id="description">
182
+ <p>
183
+ <a href="Formatter.html">Formatter</a> is an abstract class and a null
184
+ object
185
+ </p>
186
+
187
+ </div>
188
+
189
+ <!-- Constants -->
190
+
191
+
192
+ <!-- Attributes -->
193
+
194
+
195
+ <!-- Methods -->
196
+
197
+ <div id="public-class-method-details" class="method-section section">
198
+ <h3 class="section-header">Public Class Methods</h3>
199
+
200
+
201
+ <div id="new-method" class="method-detail ">
202
+ <a name="M000006"></a>
203
+
204
+ <div class="method-heading">
205
+
206
+ <span class="method-name">new</span><span
207
+ class="method-args">(hash={})</span>
208
+ <span class="method-click-advice">click to toggle source</span>
209
+
210
+ </div>
211
+
212
+ <div class="method-description">
213
+
214
+ <p class="missing-docs">(Not documented)</p>
215
+
216
+
217
+
218
+ <div class="method-source-code"
219
+ id="new-source">
220
+ <pre>
221
+ <span class="ruby-comment cmt"># File log4r/formatter/formatter.rb, line 13</span>
222
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">hash</span>={})
223
+ <span class="ruby-keyword kw">end</span></pre>
224
+ </div>
225
+
226
+ </div>
227
+
228
+
229
+ </div>
230
+
231
+
232
+ </div>
233
+
234
+ <div id="public-instance-method-details" class="method-section section">
235
+ <h3 class="section-header">Public Instance Methods</h3>
236
+
237
+
238
+ <div id="format-method" class="method-detail ">
239
+ <a name="M000007"></a>
240
+
241
+ <div class="method-heading">
242
+
243
+ <span class="method-name">format</span><span
244
+ class="method-args">(logevent)</span>
245
+ <span class="method-click-advice">click to toggle source</span>
246
+
247
+ </div>
248
+
249
+ <div class="method-description">
250
+
251
+ <p>
252
+ Define this method in a subclass to format data.
253
+ </p>
254
+
255
+
256
+
257
+ <div class="method-source-code"
258
+ id="format-source">
259
+ <pre>
260
+ <span class="ruby-comment cmt"># File log4r/formatter/formatter.rb, line 16</span>
261
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">format</span>(<span class="ruby-identifier">logevent</span>)
262
+ <span class="ruby-keyword kw">end</span></pre>
263
+ </div>
264
+
265
+ </div>
266
+
267
+
268
+ </div>
269
+
270
+
271
+ </div>
272
+
273
+
274
+ </div>
275
+
276
+
277
+ <div id="rdoc-debugging-section-dump" class="debugging-section">
278
+
279
+ <p>Disabled; run with --debug to generate this.</p>
280
+
281
+ </div>
282
+
283
+ <div id="validator-badges">
284
+ <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
285
+ <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
286
+ Rdoc Generator</a> 1.1.6</small>.</p>
287
+ </div>
288
+
289
+ </body>
290
+ </html>
291
+