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

Java doc improvements. Patch contributed by Dennis Lundberg.

Browse Source 
git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/logging/trunk@139042 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Robert Burrell Donkin
2004-06-06 21:16:04 +00:00
parent 5e61a0932e
commit c61bf4c76d
6 changed files with 20 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
src/java/org/apache/commons/logging/Log.java
View File

@@ -57,7 +57,7 @@ package org.apache.commons.logging;
*
* @author <a href="mailto:sanders@apache.org">Scott Sanders</a>
* @author Rod Waldhoff
* @version $Id: Log.java,v 1.18 2004/02/28 21:46:45 craigmcc Exp $
* @version $Id: Log.java,v 1.19 2004/06/06 21:16:04 rdonkin Exp $
*/
public interface Log {
@@ -116,7 +116,7 @@ public interface Log {
/**
* <p> Is warning logging currently enabled? </p>
* <p> Is warn logging currently enabled? </p>
*
* <p> Call this method to prevent having to perform expensive operations
* (for example, <code>String</code> concatenation)

7
src/java/org/apache/commons/logging/LogFactory.java
View File

@@ -42,7 +42,7 @@ import java.util.Properties;
* @author Craig R. McClanahan
* @author Costin Manolache
* @author Richard A. Sitze
* @version $Revision: 1.26 $ $Date: 2004/02/28 21:46:45 $
* @version $Revision: 1.27 $ $Date: 2004/06/06 21:15:12 $
*/
public abstract class LogFactory {
@@ -72,8 +72,9 @@ public abstract class LogFactory {
"commons-logging.properties";
/**
* JDK1.3+ 'Service Provider' specification
* ( http://java.sun.com/j2se/1.3/docs/guide/jar/jar.html )
* JDK1.3+ <a href="http://java.sun.com/j2se/1.3/docs/guide/jar/jar.html#Service%20Provider">
* 'Service Provider' specification</a>.
*
*/
protected static final String SERVICE_ID =
"META-INF/services/org.apache.commons.logging.LogFactory";

8
src/java/org/apache/commons/logging/impl/Jdk13LumberjackLogger.java
View File

@@ -31,14 +31,14 @@ import org.apache.commons.logging.Log;
/**
* <p>Implementation of the <code>org.apache.commons.logging.Log</code>
* interfaces that wraps the standard JDK logging mechanisms that are
* interface that wraps the standard JDK logging mechanisms that are
* available in SourceForge's Lumberjack for JDKs prior to 1.4.</p>
*
* @author <a href="mailto:sanders@apache.org">Scott Sanders</a>
* @author <a href="mailto:bloritsch@apache.org">Berin Loritsch</a>
* @author <a href="mailto:donaldp@apache.org">Peter Donald</a>
* @author <a href="mailto:vince256@comcast.net">Vince Eagen</a>
* @version $Revision: 1.5 $ $Date: 2004/02/28 21:46:45 $
* @version $Revision: 1.6 $ $Date: 2004/06/06 21:13:43 $
*/
public class Jdk13LumberjackLogger implements Log, Serializable {
@@ -233,7 +233,7 @@ public class Jdk13LumberjackLogger implements Log, Serializable {
/**
* Is tace logging currently enabled?
* Is trace logging currently enabled?
*/
public boolean isTraceEnabled() {
return (getLogger().isLoggable(Level.FINEST));
@@ -241,7 +241,7 @@ public class Jdk13LumberjackLogger implements Log, Serializable {
/**
* Is warning logging currently enabled?
* Is warn logging currently enabled?
*/
public boolean isWarnEnabled() {
return (getLogger().isLoggable(Level.WARNING));

4
src/java/org/apache/commons/logging/impl/Jdk14Logger.java
View File

@@ -27,13 +27,13 @@ import org.apache.commons.logging.Log;
/**
* <p>Implementation of the <code>org.apache.commons.logging.Log</code>
* interfaces that wraps the standard JDK logging mechanisms that were
* interface that wraps the standard JDK logging mechanisms that were
* introduced in the Merlin release (JDK 1.4).</p>
*
* @author <a href="mailto:sanders@apache.org">Scott Sanders</a>
* @author <a href="mailto:bloritsch@apache.org">Berin Loritsch</a>
* @author <a href="mailto:donaldp@apache.org">Peter Donald</a>
* @version $Revision: 1.12 $ $Date: 2004/02/28 21:46:45 $
* @version $Revision: 1.13 $ $Date: 2004/06/06 21:10:21 $
*/
public class Jdk14Logger implements Log, Serializable {

4
src/java/org/apache/commons/logging/impl/NoOpLog.java
View File

@@ -28,7 +28,7 @@ import org.apache.commons.logging.Log;
*
* @author <a href="mailto:sanders@apache.org">Scott Sanders</a>
* @author Rod Waldhoff
* @version $Id: NoOpLog.java,v 1.7 2004/02/28 23:05:01 craigmcc Exp $
* @version $Id: NoOpLog.java,v 1.8 2004/06/06 21:13:12 rdonkin Exp $
*/
public class NoOpLog implements Log, Serializable {
@@ -97,7 +97,7 @@ public class NoOpLog implements Log, Serializable {
public final boolean isTraceEnabled() { return false; }
/**
* Warning is never enabled.
* Warn is never enabled.
*
* @return false
*/

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

@@ -26,14 +26,14 @@
can be used around a variety of different logging implementations, including
prebuilt support for the following:</p>
<ul>
<li><a href="http://jakarta.apache.org/log4j/">Log4J</a> (version 1.2 or later)
<li><a href="http://logging.apache.org/log4j/">Log4J</a> (version 1.2 or later)
from Apache's Jakarta project. Each named <a href="Log.html">Log</a>
instance is connected to a corresponding Log4J Logger.</li>
<li><a href="http://java.sun.com/j2se/1.4/docs/guide/util/logging/index.html">
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
<code>java.util.logging.Logger</code> instance.</li>
<li><a href="http://avalong.apache.org/logkit/">LogKit</a> from Apache's
<li><a href="http://avalon.apache.org/logkit/">LogKit</a> from Apache's
Avalon project. Each named <a href="Log.html">Log</a> instance is
connected to a corresponding LogKit <code>Logger</code>.</li>
<li><a href="impl/NoOpLog.html">NoOpLog</a> implementation that simply swallows
@@ -137,7 +137,7 @@ implementation uses the following rules:</p>
parameter, will return the same <code>Log</code> instance.</li>
<li>When a new <code>Log</code> instance must be created, the default
<code>LogFactory</code> implementation uses the following discovery
process is used:
process:
<ul>
<li>Look for a configuration attribute of this factory named
<code>org.apache.commons.logging.Log</code> (for backwards
@@ -198,8 +198,9 @@ component, consists of the following steps:</p>
purposes. A typical scenario for a server application is to have each
major component of the server use its own Log instance.</li>
<li>Cause messages to be logged (if the corresponding detail level is enabled)
by calling appropriate methods (<code>debug()</code>, <code>info()</code>,
<code>warn()</code>, <code>error</code>, and <code>fatal()</code>).</li>
by calling appropriate methods (<code>trace()</code>, <code>debug()</code>,
<code>info()</code>, <code>warn()</code>, <code>error</code>, and
<code>fatal()</code>).</li>
</ol>
<p>For convenience, <code>LogFactory</code> also offers a static method