Siphalor/tweed5-commons-logging
1
0
Fork 0
Code Activity

Updated package documentation to reflect latest Log interface

Browse Source 
git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/logging/trunk@138840 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Robert Burrell Donkin
2002-01-22 22:10:45 +00:00
parent 97142db2c2
commit 6aa9386d49
1 changed files with 9 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
src/java/org/apache/commons/logging/package.html
View File

@@ -14,7 +14,7 @@ prebuilt support for the following:</p>
JDK Logging API</a>, included in JDK 1.4 or later systems. Each named JDK Logging API</a>, included in JDK 1.4 or later systems. Each named
<a href="Log.html">Log</a> instance is connected to a corresponding <a href="Log.html">Log</a> instance is connected to a corresponding
<code>java.util.logging.Logger</code> instance.</li> <code>java.util.logging.Logger</code> instance.</li>
<li><a href="http://jakarta.apache.org/jakarta-avalon/">LogKit</a> from Apache's <li><a href="http://jakarta.apache.org/avalon/">LogKit</a> from Apache's
Jakarta project. Each named <a href="Log.html">Log</a> instance is Jakarta project. Each named <a href="Log.html">Log</a> instance is
connected to a corresponding LogKit <code>Logger</code>.</li> connected to a corresponding LogKit <code>Logger</code>.</li>
<li><a href="NoOpLog.html">NoOpLog</a> implementation that simply swallows <li><a href="NoOpLog.html">NoOpLog</a> implementation that simply swallows
@@ -26,6 +26,8 @@ prebuilt support for the following:</p>
<h3>Configuring the Logging Package APIs</h3> <h3>Configuring the Logging Package APIs</h3>
<h4>Choosing A <code>Log</code> Implementation</h4>
<p>The Logging Package APIs are configured based on the values of system <p>The Logging Package APIs are configured based on the values of system
properties, which are normally set on the command line that started your properties, which are normally set on the command line that started your
application. The following system properties are global to all application. The following system properties are global to all
@@ -49,8 +51,13 @@ following algorithm is applied:</p>
throws away all logged output.</li> throws away all logged output.</li>
</ul> </ul>
<h4>Configuring the Underlying Logging System</h4>
<p>Additionally, each individual <a href="Log.html">Log</a> implementation may <p>The basic principle is that the user is totally responsible for the
configuration of the underlying logging system.
Commons-logging should not change the existing configuration.</p>
<p>Each individual <a href="Log.html">Log</a> implementation may
support its own configuration properties. These will be documented in the support its own configuration properties. These will be documented in the
class descriptions for the corresponding implementation class.</p> class descriptions for the corresponding implementation class.</p>
@@ -72,11 +79,6 @@ component, consists of the following steps:</p>
references to multiple loggers that are used for different references to multiple loggers that are used for different
purposes. A typical scenario for a server application is to have each purposes. A typical scenario for a server application is to have each
major component of the server use its own Log instance.</li> major component of the server use its own Log instance.</li>
<li>Optionally, you can dynamically change the logging detail level by
calling <a href="Log.html#setLevel(int)">Log.setLevel()</a> with
an appropriate constant from the <code>Log</code> interface. Note that,
in most cases, the underlying logging system configuration will have
been preconfigured by the system administrator.</li>
<li>Cause messages to be logged (if the corresponding detail level is enabled) <li>Cause messages to be logged (if the corresponding detail level is enabled)
by calling appropriate methods (<code>debug()</code>, <code>info()</code>, by calling appropriate methods (<code>debug()</code>, <code>info()</code>,
<code>warn()</code>, <code>error</code>, and <code>fatal()</code>).</li> <code>warn()</code>, <code>error</code>, and <code>fatal()</code>).</li>