Gitiles
Code Review Sign In
gerrit.opencord.org / xos / e3bbcf622e692f93fcc62ff7be7f49a206249b6c / . / planetstack / core / static / log4javascript-1.4.6 / docs / manual_lite.html
blob: 74e5a7dac63bf28c9f96b5b6ea63eeeb675e017b [file] [log] [blame]
Siobhan Tullye18b3442014-02-23 14:23:34 -0500[diff] [blame]1<?xml version="1.0"?>
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
4 <head>
5 <title>log4javascript 1.4 Lite manual</title>
6 <meta http-equiv="content-type" content="text/html; charset=iso-8859-1" />
7 <meta name="author" content="Tim Down - tim@log4javascript.org" />
8 <meta name="description" content="log4javascript, a logging framework for JavaScript based on log4j" />
9 <meta name="robots" content="all" />
10 <link rel="stylesheet" type="text/css" media="screen,print" href="../main.css" title="Default" />
11 </head>
12 <body>
13 <div id="container" class="nonav">
14 <div id="header">
15 <h1><a href="index.html">log4javascript</a></h1>
16 </div>
17 <div id="content">
18 <div id="nav">
19 <a class="navitem" href="../index.html">home</a>
20 | <a class="navitem" href="http://sourceforge.net/projects/log4javascript" target="_blank" title="Download (opens in new window)">download</a>
21 | <a class="navitem" href="index.html">docs</a>
22 | <a class="navitem" href="quickstart.html">quick start</a>
23 | <a class="navitem" href="../demos/index.html">demos</a>
24 | <a class="navitem" href="http://log4javascript.org" target="_blank">website</a>
25 | <a class="navitem" href="http://www.timdown.co.uk" target="_blank">timdown.co.uk</a>
26 </div>
27 <h1>log4javascript 1.4 Lite manual</h1>
28 <h2>Contents</h2>
29 <ul>
30 <li><a href="#intro">Introduction</a></li>
31 <li><a href="#log4javascript">log4javascript static properties/methods</a></li>
32 <li><a href="#levels">Levels</a></li>
33 <li><a href="#loggers">Loggers</a></li>
34 <li><a href="#enabling">Enabling / disabling log4javascript Lite</a></li>
35 </ul>
36 <div id="intro">
37 <h2>Introduction</h2>
38 <p>
39 log4javascript Lite is designed to be a basic, lightweight, cross-browser logging tool. It
40 provides functions to log messages of different severity to a pop-up window using the exactly
41 the same syntax as log4javascript. It is designed for situations when the key requirement is just
42 to display logging messages without needing all the features of the standard version of
43 log4javascript.
44 </p>
45 <p>
46 Below is the complete list of functions and properties available in log4javascript Lite.
47 They make up a small subset of those provided by the standard version of
48 log4javascript. Each function is <strong>named and called identically to the equivalent
49 function in log4javascript</strong>. Please refer to the
50 <a href="manual.html">log4javascript manual</a> for a detailed explanation
51 of all the concepts alluded to in this document.
52 </p>
53 <p class="linktotop">
54 <a href="#container">Top</a>
55 </p>
56 </div>
57 <div id="log4javascript">
58 <h2>log4javascript static properties/methods</h2>
59 <h4>Properties</h4>
60 <ul class="propertieslist">
61 <li class="property">
62 <div class="name">version</div>
63 <div class="summary">
64 The version number of your copy of log4javascript.
65 </div>
66 </li>
67 <li class="property">
68 <div class="name">edition</div>
69 <div class="summary">
70 The edition of your copy of log4javascript ("log4javascript_lite" in this case").
71 </div>
72 </li>
73 </ul>
74 <h4>Methods</h4>
75 <ul class="propertieslist">
76 <li class="method">
77 <div class="name">getDefaultLogger</div>
78 <div class="methodsignature"><code>Logger <strong>getDefaultLogger</strong>()</code></div>
79 <div class="summary">
80 Returns the default and only logger (apart from the null logger). The default logger
81 logs to a simple pop-up window.
82 </div>
83 </li>
84 <li class="method">
85 <div class="name">getNullLogger</div>
86 <div class="methodsignature"><code>Logger <strong>getNullLogger</strong>()</code></div>
87 <div class="summary">
88 Returns an empty logger. Useful for disabling all logging.
89 </div>
90 </li>
91 <li class="method">
92 <div class="name">setEnabled</div>
93 <div class="methodsignature"><code>void <strong>setEnabled</strong>(Boolean <em>enabled</em>)</code></div>
94 <div class="paramsheading">Parameters:</div>
95 <ul class="params">
96 <li class="param">
97 <code class="paramname">enabled</code>
98 </li>
99 </ul>
100 <div class="summary">
101 Enables or disables all logging, depending on <code>enabled</code>.
102 </div>
103 </li>
104 <li class="method">
105 <div class="name">isEnabled</div>
106 <div class="methodsignature"><code>Boolean <strong>isEnabled</strong>()</code></div>
107 <div class="summary">
108 Returns true or false depending on whether logging is enabled.
109 </div>
110 </li>
111 <li class="method">
112 <div class="name">setShowStackTraces</div>
113 <div class="methodsignature"><code>void <strong>setShowStackTraces</strong>(Boolean <em>show</em>)</code></div>
114 <div class="paramsheading">Parameters:</div>
115 <ul class="params">
116 <li class="param">
117 <code class="paramname">show</code>
118 </li>
119 </ul>
120 <div class="summary">
121 Enables or disables displaying of error stack traces, depending on <code>show</code>.
122 By default, stack traces are not displayed. (Only works in Firefox)
123 </div>
124 </li>
125 </ul>
126 <p class="linktotop">
127 <a href="#container">Top</a>
128 </p>
129 </div>
130 <div id="levels">
131 <h2>Levels</h2>
132 <p>
133 Levels are available as static properties of the <code>log4javascript.Level</code>
134 object. In ascending order of severity:
135 </p>
136 <ol>
137 <li><code>log4javascript.Level.ALL</code></li>
138 <li><code>log4javascript.Level.TRACE</code></li>
139 <li><code>log4javascript.Level.DEBUG</code></li>
140 <li><code>log4javascript.Level.INFO</code></li>
141 <li><code>log4javascript.Level.WARN</code></li>
142 <li><code>log4javascript.Level.ERROR</code></li>
143 <li><code>log4javascript.Level.FATAL</code></li>
144 <li><code>log4javascript.Level.NONE</code></li>
145 </ol>
146 <p class="linktotop">
147 <a href="#container">Top</a>
148 </p>
149 </div>
150 <div id="loggers">
151 <h2>Loggers</h2>
152 <p>
153 There are only two loggers in log4javascript Lite: the default logger obtained
154 by calling <code>log4javascript.getDefaultLogger()</code> and the empty logger
155 returned by <code>log4javascript.getNullLogger()</code>.
156 </p>
157 <h4>Logger methods</h4>
158 <ul class="propertieslist">
159 <li class="method">
160 <div class="name">setLevel</div>
161 <div class="methodsignature"><code>void <strong>setLevel</strong>(Level <em>level</em>)</code></div>
162 <div class="paramsheading">Parameters:</div>
163 <ul class="params">
164 <li class="param">
165 <code class="paramname">level</code>
166 </li>
167 </ul>
168 <div class="summary">
169 Sets the level. Log messages of a lower level than <code>level</code> will not be logged.
170 Default value is <code>ALL</code> (unlike in log4javascript, where the default level is
171 <code>DEBUG</code>).
172 </div>
173 </li>
174 <li class="method">
175 <div class="name">getLevel</div>
176 <div class="methodsignature"><code>Level <strong>getLevel</strong>()</code></div>
177 <div class="summary">
178 Returns the level for this logger.
179 </div>
180 </li>
181 <li class="method">
182 <div class="name">trace</div>
183 <div class="methodsignature"><code>void <strong>trace</strong>(Object <em>message1</em>[, Object <em>message2</em>, ... ][, Error <em>exception</em>])</code></div>
184 <div class="paramsheading">Parameters:</div>
185 <ul class="params">
186 <li class="param">
187 <code class="paramname">message1[, message2...]</code>
188 </li>
189 <li class="param">
190 <code class="paramname">exception</code>
191 [<em>optional</em>]
192 </li>
193 </ul>
194 <div class="summary">
195 Logs one or more messages and optionally an error at level <code>TRACE</code>.
196 </div>
197 </li>
198 <li class="method">
199 <div class="name">debug</div>
200 <div class="methodsignature"><code>void <strong>debug</strong>(Object <em>message1</em>[, Object <em>message2</em>, ... ][, Error <em>exception</em>])</code></div>
201 <div class="paramsheading">Parameters:</div>
202 <ul class="params">
203 <li class="param">
204 <code class="paramname">message1[, message2...]</code>
205 </li>
206 <li class="param">
207 <code class="paramname">exception</code>
208 [<em>optional</em>]
209 </li>
210 </ul>
211 <div class="summary">
212 Logs one or more messages and optionally an error at level <code>DEBUG</code>.
213 </div>
214 </li>
215 <li class="method">
216 <div class="name">info</div>
217 <div class="methodsignature"><code>void <strong>info</strong>(Object <em>message1</em>[, Object <em>message2</em>, ... ][, Error <em>exception</em>])</code></div>
218 <div class="paramsheading">Parameters:</div>
219 <ul class="params">
220 <li class="param">
221 <code class="paramname">message1[, message2...]</code>
222 </li>
223 <li class="param">
224 <code class="paramname">exception</code>
225 [<em>optional</em>]
226 </li>
227 </ul>
228 <div class="summary">
229 Logs one or more messages and optionally an error at level <code>INFO</code>.
230 </div>
231 </li>
232 <li class="method">
233 <div class="name">warn</div>
234 <div class="methodsignature"><code>void <strong>warn</strong>(Object <em>message1</em>[, Object <em>message2</em>, ... ][, Error <em>exception</em>])</code></div>
235 <div class="paramsheading">Parameters:</div>
236 <ul class="params">
237 <li class="param">
238 <code class="paramname">message1[, message2...]</code>
239 </li>
240 <li class="param">
241 <code class="paramname">exception</code>
242 [<em>optional</em>]
243 </li>
244 </ul>
245 <div class="summary">
246 Logs one or more messages and optionally an error at level <code>WARN</code>.
247 </div>
248 </li>
249 <li class="method">
250 <div class="name">error</div>
251 <div class="methodsignature"><code>void <strong>error</strong>(Object <em>message1</em>[, Object <em>message2</em>, ... ][, Error <em>exception</em>])</code></div>
252 <div class="paramsheading">Parameters:</div>
253 <ul class="params">
254 <li class="param">
255 <code class="paramname">message1[, message2...]</code>
256 </li>
257 <li class="param">
258 <code class="paramname">exception</code>
259 [<em>optional</em>]
260 </li>
261 </ul>
262 <div class="summary">
263 Logs one or more messages and optionally an error at level <code>ERROR</code>.
264 </div>
265 </li>
266 <li class="method">
267 <div class="name">fatal</div>
268 <div class="methodsignature"><code>void <strong>fatal</strong>(Object <em>message1</em>[, Object <em>message2</em>, ... ][, Error <em>exception</em>])</code></div>
269 <div class="paramsheading">Parameters:</div>
270 <ul class="params">
271 <li class="param">
272 <code class="paramname">message1[, message2...]</code>
273 </li>
274 <li class="param">
275 <code class="paramname">exception</code>
276 [<em>optional</em>]
277 </li>
278 </ul>
279 <div class="summary">
280 Logs one or more messages and optionally an error at level <code>FATAL</code>.
281 </div>
282 </li>
283 <li class="method">
284 <div class="name">isEnabledFor</div>
285 <div class="methodsignature"><code>Boolean <strong>isEnabledFor</strong>(Level <em>level</em>, Error <em>exception</em>)</code></div>
286 <div class="paramsheading">Parameters:</div>
287 <ul class="params">
288 <li class="param">
289 <code class="paramname">level</code>
290 </li>
291 </ul>
292 <div class="summary">
293 Returns whether the logger is enabled for the specified level.
294 </div>
295 </li>
296 <li class="method">
297 <div class="name">isTraceEnabled</div>
298 <div class="methodsignature"><code>Boolean <strong>isTraceEnabled</strong>()</code></div>
299 <div class="summary">
300 Returns whether the logger is enabled for <code>TRACE</code> messages.
301 </div>
302 </li>
303 <li class="method">
304 <div class="name">isDebugEnabled</div>
305 <div class="methodsignature"><code>Boolean <strong>isDebugEnabled</strong>()</code></div>
306 <div class="summary">
307 Returns whether the logger is enabled for <code>DEBUG</code> messages.
308 </div>
309 </li>
310 <li class="method">
311 <div class="name">isInfoEnabled</div>
312 <div class="methodsignature"><code>Boolean <strong>isInfoEnabled</strong>()</code></div>
313 <div class="summary">
314 Returns whether the logger is enabled for <code>INFO</code> messages.
315 </div>
316 </li>
317 <li class="method">
318 <div class="name">isWarnEnabled</div>
319 <div class="methodsignature"><code>Boolean <strong>isWarnEnabled</strong>()</code></div>
320 <div class="summary">
321 Returns whether the logger is enabled for <code>WARN</code> messages.
322 </div>
323 </li>
324 <li class="method">
325 <div class="name">isErrorEnabled</div>
326 <div class="methodsignature"><code>Boolean <strong>isErrorEnabled</strong>()</code></div>
327 <div class="summary">
328 Returns whether the logger is enabled for <code>ERROR</code> messages.
329 </div>
330 </li>
331 <li class="method">
332 <div class="name">isFatalEnabled</div>
333 <div class="methodsignature"><code>Boolean <strong>isFatalEnabled</strong>()</code></div>
334 <div class="summary">
335 Returns whether the logger is enabled for <code>FATAL</code> messages.
336 </div>
337 </li>
338 </ul>
339 <p class="linktotop">
340 <a href="#container">Top</a>
341 </p>
342 </div>
343 <div id="enabling">
344 <h2>Enabling / disabling log4javascript Lite</h2>
345 <p>
346 All logging can be enabled or disabled in log4javascript Lite in a number of ways:
347 </p>
348 <ul>
349 <li>
350 At any time, you can call
351 <code>log4javascript.setEnabled(<em>enabled</em>)</code>. This will
352 enable or disable all logging, depending on whether <code>enabled</code>
353 is set to <code>true</code> or <code>false</code>.
354 </li>
355 <li>
356 Assign your logger object a value of <code>log4javascript.getNullLogger()</code>.
357 </li>
358 <li>
359 Replace your copy of log4javascript_lite.js with stubs/log4javascript_lite.js, provided in the
360 distribution. This file has a stub version of each of the functions and methods
361 in the log4javascript Lite API and can simply be dropped in in place of the main file.
362 </li>
363 </ul>
364 <p class="linktotop">
365 <a href="#container">Top</a>
366 </p>
367 </div>
368 </div>
369 <div id="footer">
370 <span class="externallinkinfo">
371 <strong>NB.</strong> All external links open in a new window.
372 </span>
373 Written by Tim Down. <a href="mailto:tim@log4javascript.org">tim@log4javascript.org</a>
374 <br />
375 log4javascript is distributed under the <a href="http://www.apache.org/licenses/LICENSE-2.0.html"
376 title="Apache License, Version 2.0 (opens in new window)" target="_blank">Apache License,
377 Version 2.0</a>
378
379 </div>
380 </div>
381
382 </body>
383</html>