1
0

Fixes for typos and speiling mistakes in the javadocs Contributed by Dennis Lundberg.

git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/logging/trunk@139007 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Robert Burrell Donkin
2004-02-28 17:54:14 +00:00
parent b8683537ac
commit c83a3e1b5a
11 changed files with 142 additions and 142 deletions

View File

@@ -1,7 +1,7 @@
/*
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//logging/src/java/org/apache/commons/logging/impl/AvalonLogger.java,v 1.6 2003/10/09 21:37:47 rdonkin Exp $
* $Revision: 1.6 $
* $Date: 2003/10/09 21:37:47 $
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//logging/src/java/org/apache/commons/logging/impl/AvalonLogger.java,v 1.7 2004/02/28 17:54:14 rdonkin Exp $
* $Revision: 1.7 $
* $Date: 2004/02/28 17:54:14 $
*
* ====================================================================
*
@@ -66,11 +66,11 @@ import org.apache.avalon.framework.logger.Logger;
import org.apache.commons.logging.Log;
/**
* Implementation of commons-logging Log interface that delegates all
* logging calls to Avalon logging abstraction: the Logger interface.
*
* Implementation of commons-logging Log interface that delegates all
* logging calls to the Avalon logging abstraction: the Logger interface.
*
* @author <a href="mailto:neeme@apache.org">Neeme Praks</a>
* @version $Revision: 1.6 $ $Date: 2003/10/09 21:37:47 $
* @version $Revision: 1.7 $ $Date: 2004/02/28 17:54:14 $
*/
public class AvalonLogger implements Log, Serializable {
@@ -79,7 +79,7 @@ public class AvalonLogger implements Log, Serializable {
private String name = null;
/**
* @param logger the avalon logger implementation to delegate to
* @param logger the avalon logger implementation to delegate to
*/
public AvalonLogger(Logger logger) {
this.name = name;
@@ -87,10 +87,10 @@ public class AvalonLogger implements Log, Serializable {
}
/**
* @param name the name of the avalon logger implementation to delegate to
* @param name the name of the avalon logger implementation to delegate to
*/
public AvalonLogger(String name) {
if (defaultLogger == null)
if (defaultLogger == null)
throw new NullPointerException("default logger has to be specified if this constructor is used!");
this.logger = getLogger();
}

View File

@@ -1,7 +1,7 @@
/*
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//logging/src/java/org/apache/commons/logging/impl/Jdk14Logger.java,v 1.10 2003/10/09 21:37:47 rdonkin Exp $
* $Revision: 1.10 $
* $Date: 2003/10/09 21:37:47 $
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//logging/src/java/org/apache/commons/logging/impl/Jdk14Logger.java,v 1.11 2004/02/28 17:54:14 rdonkin Exp $
* $Revision: 1.11 $
* $Date: 2004/02/28 17:54:14 $
*
* ====================================================================
*
@@ -78,7 +78,7 @@ import org.apache.commons.logging.Log;
* @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.10 $ $Date: 2003/10/09 21:37:47 $
* @version $Revision: 1.11 $ $Date: 2004/02/28 17:54:14 $
*/
public class Jdk14Logger implements Log, Serializable {
@@ -249,7 +249,7 @@ public class Jdk14Logger implements Log, Serializable {
/**
* Is tace logging currently enabled?
* Is trace logging currently enabled?
*/
public boolean isTraceEnabled() {
return (getLogger().isLoggable(Level.FINEST));
@@ -257,7 +257,7 @@ public class Jdk14Logger implements Log, Serializable {
/**
* Is warning logging currently enabled?
* Is warn logging currently enabled?
*/
public boolean isWarnEnabled() {
return (getLogger().isLoggable(Level.WARNING));

View File

@@ -1,7 +1,7 @@
/*
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//logging/src/java/org/apache/commons/logging/impl/Attic/Log4JCategoryLog.java,v 1.13 2003/10/09 21:37:47 rdonkin Exp $
* $Revision: 1.13 $
* $Date: 2003/10/09 21:37:47 $
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//logging/src/java/org/apache/commons/logging/impl/Attic/Log4JCategoryLog.java,v 1.14 2004/02/28 17:54:14 rdonkin Exp $
* $Revision: 1.14 $
* $Date: 2004/02/28 17:54:14 $
*
* ====================================================================
*
@@ -77,7 +77,7 @@ import org.apache.log4j.Priority;
* @author <a href="mailto:sanders@apache.org">Scott Sanders</a>
* @author Rod Waldhoff
* @author Robert Burrell Donkin
* @version $Id: Log4JCategoryLog.java,v 1.13 2003/10/09 21:37:47 rdonkin Exp $
* @version $Id: Log4JCategoryLog.java,v 1.14 2004/02/28 17:54:14 rdonkin Exp $
*/
public final class Log4JCategoryLog implements Log {
@@ -86,7 +86,7 @@ public final class Log4JCategoryLog implements Log {
/** The fully qualified name of the Log4JCategoryLog class. */
private static final String FQCN = Log4JCategoryLog.class.getName();
/** Log to this category */
private Category category = null;
@@ -98,13 +98,13 @@ public final class Log4JCategoryLog implements Log {
/**
* Base constructor
* Base constructor.
*/
public Log4JCategoryLog(String name) {
this.category=Category.getInstance(name);
}
/** For use with a log4j factory
/** For use with a log4j factory.
*/
public Log4JCategoryLog(Category category ) {
this.category=category;

View File

@@ -1,7 +1,7 @@
/*
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//logging/src/java/org/apache/commons/logging/impl/Log4JLogger.java,v 1.8 2003/10/09 21:37:47 rdonkin Exp $
* $Revision: 1.8 $
* $Date: 2003/10/09 21:37:47 $
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//logging/src/java/org/apache/commons/logging/impl/Log4JLogger.java,v 1.9 2004/02/28 17:54:14 rdonkin Exp $
* $Revision: 1.9 $
* $Date: 2004/02/28 17:54:14 $
*
* ====================================================================
*
@@ -76,7 +76,7 @@ import org.apache.log4j.Priority;
* @author <a href="mailto:sanders@apache.org">Scott Sanders</a>
* @author Rod Waldhoff
* @author Robert Burrell Donkin
* @version $Id: Log4JLogger.java,v 1.8 2003/10/09 21:37:47 rdonkin Exp $
* @version $Id: Log4JLogger.java,v 1.9 2004/02/28 17:54:14 rdonkin Exp $
*/
public class Log4JLogger implements Log, Serializable {
@@ -85,7 +85,7 @@ public class Log4JLogger implements Log, Serializable {
/** The fully qualified name of the Log4JLogger class. */
private static final String FQCN = Log4JLogger.class.getName();
/** Log to this logger */
private transient Logger logger = null;
@@ -100,14 +100,14 @@ public class Log4JLogger implements Log, Serializable {
/**
* Base constructor
* Base constructor.
*/
public Log4JLogger(String name) {
this.name = name;
this.logger = getLogger();
}
/** For use with a log4j factory
/** For use with a log4j factory.
*/
public Log4JLogger(Logger logger ) {
this.name = logger.getName();

View File

@@ -1,7 +1,7 @@
/*
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//logging/src/java/org/apache/commons/logging/impl/Log4jFactory.java,v 1.7 2003/10/09 21:37:47 rdonkin Exp $
* $Revision: 1.7 $
* $Date: 2003/10/09 21:37:47 $
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//logging/src/java/org/apache/commons/logging/impl/Log4jFactory.java,v 1.8 2004/02/28 17:54:14 rdonkin Exp $
* $Revision: 1.8 $
* $Date: 2004/02/28 17:54:14 $
*
* ====================================================================
*
@@ -92,7 +92,7 @@ public final class Log4jFactory extends LogFactory {
*/
private Hashtable attributes = new Hashtable();
// previously returned instances, to avoid creation of proxies
// Previously returned instances, to avoid creation of proxies
private Hashtable instances = new Hashtable();
// --------------------------------------------------------- Public Methods
@@ -164,7 +164,7 @@ public final class Log4jFactory extends LogFactory {
/**
* Release any internal references to previously created {@link Log}
* instances returned by this factory. This is useful environments
* instances returned by this factory. This is useful in environments
* like servlet containers, which implement application reloading by
* throwing away a ClassLoader. Dangling references to objects in that
* class loader would prevent garbage collection.
@@ -173,7 +173,7 @@ public final class Log4jFactory extends LogFactory {
instances.clear();
// what's the log4j mechanism to cleanup ???
// what's the log4j mechanism to cleanup ???
}

View File

@@ -1,7 +1,7 @@
/*
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//logging/src/java/org/apache/commons/logging/impl/LogFactoryImpl.java,v 1.28 2003/10/09 21:37:47 rdonkin Exp $
* $Revision: 1.28 $
* $Date: 2003/10/09 21:37:47 $
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//logging/src/java/org/apache/commons/logging/impl/LogFactoryImpl.java,v 1.29 2004/02/28 17:54:14 rdonkin Exp $
* $Revision: 1.29 $
* $Date: 2004/02/28 17:54:14 $
*
* ====================================================================
*
@@ -107,7 +107,7 @@ import org.apache.commons.logging.LogFactory;
* @author Rod Waldhoff
* @author Craig R. McClanahan
* @author Richard A. Sitze
* @version $Revision: 1.28 $ $Date: 2003/10/09 21:37:47 $
* @version $Revision: 1.29 $ $Date: 2004/02/28 17:54:14 $
*/
public class LogFactoryImpl extends LogFactory {
@@ -146,7 +146,7 @@ public class LogFactoryImpl extends LogFactory {
/**
* Configuration attributes
* Configuration attributes.
*/
protected Hashtable attributes = new Hashtable();
@@ -280,7 +280,7 @@ public class LogFactoryImpl extends LogFactory {
/**
* Release any internal references to previously created
* {@link org.apache.commons.logging.Log}
* instances returned by this factory. This is useful environments
* instances returned by this factory. This is useful in environments
* like servlet containers, which implement application reloading by
* throwing away a ClassLoader. Dangling references to objects in that
* class loader would prevent garbage collection.

View File

@@ -1,7 +1,7 @@
/*
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//logging/src/java/org/apache/commons/logging/impl/SimpleLog.java,v 1.14 2003/10/09 21:37:47 rdonkin Exp $
* $Revision: 1.14 $
* $Date: 2003/10/09 21:37:47 $
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//logging/src/java/org/apache/commons/logging/impl/SimpleLog.java,v 1.15 2004/02/28 17:54:14 rdonkin Exp $
* $Revision: 1.15 $
* $Date: 2004/02/28 17:54:14 $
*
* ====================================================================
*
@@ -93,7 +93,7 @@ import org.apache.commons.logging.LogConfigurationException;
* Set to <code>true</code> if you want the Log instance name to be
* included in output messages. Defaults to <code>false</code>.</li>
* <li><code>org.apache.commons.logging.simplelog.showShortLogname</code> -
* Set to <code>true</code> if you want the last componet of the name to be
* Set to <code>true</code> if you want the last component of the name to be
* included in output messages. Defaults to <code>true</code>.</li>
* <li><code>org.apache.commons.logging.simplelog.showdatetime</code> -
* Set to <code>true</code> if you want the current date and time
@@ -109,7 +109,7 @@ import org.apache.commons.logging.LogConfigurationException;
* @author Rod Waldhoff
* @author Robert Burrell Donkin
*
* @version $Id: SimpleLog.java,v 1.14 2003/10/09 21:37:47 rdonkin Exp $
* @version $Id: SimpleLog.java,v 1.15 2004/02/28 17:54:14 rdonkin Exp $
*/
public class SimpleLog implements Log, Serializable {
@@ -158,7 +158,7 @@ public class SimpleLog implements Log, Serializable {
public static final int LOG_LEVEL_OFF = (LOG_LEVEL_FATAL + 1);
// ------------------------------------------------------------ Initializer
private static String getStringProperty(String name) {
String prop = null;
try {
@@ -179,11 +179,11 @@ public class SimpleLog implements Log, Serializable {
return (prop == null) ? dephault : "true".equalsIgnoreCase(prop);
}
// initialize class attributes
// load properties file, if found.
// override with system properties.
// Initialize class attributes.
// Load properties file, if found.
// Override with system properties.
static {
// add props from the resource simplelog.properties
// Add props from the resource simplelog.properties
InputStream in = getResourceAsStream("simplelog.properties");
if(null != in) {
try {
@@ -228,12 +228,12 @@ public class SimpleLog implements Log, Serializable {
logName = name;
// set initial log level
// Set initial log level
// Used to be: set default log level to ERROR
// IMHO it should be lower, but at least info ( costin ).
setLevel(SimpleLog.LOG_LEVEL_INFO);
// set log level from properties
// Set log level from properties
String lvl = getStringProperty(systemPrefix + "log." + logName);
int i = String.valueOf(name).lastIndexOf(".");
while(null == lvl && i > -1) {
@@ -299,16 +299,16 @@ public class SimpleLog implements Log, Serializable {
* and then prints to <code>System.err</code>.</p>
*/
protected void log(int type, Object message, Throwable t) {
// use a string buffer for better performance
// Use a string buffer for better performance
StringBuffer buf = new StringBuffer();
// append date-time if so configured
// Append date-time if so configured
if(showDateTime) {
buf.append(dateFormatter.format(new Date()));
buf.append(" ");
}
// append a readable representation of the log leve
// Append a readable representation of the log level
switch(type) {
case SimpleLog.LOG_LEVEL_TRACE: buf.append("[TRACE] "); break;
case SimpleLog.LOG_LEVEL_DEBUG: buf.append("[DEBUG] "); break;
@@ -318,7 +318,7 @@ public class SimpleLog implements Log, Serializable {
case SimpleLog.LOG_LEVEL_FATAL: buf.append("[FATAL] "); break;
}
// append the name of the log instance if so configured
// Append the name of the log instance if so configured
if( showShortName) {
if( prefix==null ) {
// cut all but the last component of the name for both styles
@@ -330,23 +330,23 @@ public class SimpleLog implements Log, Serializable {
buf.append(String.valueOf(logName)).append(" - ");
}
// append the message
// Append the message
buf.append(String.valueOf(message));
// append stack trace if not null
// Append stack trace if not null
if(t != null) {
buf.append(" <");
buf.append(t.toString());
buf.append(">");
java.io.StringWriter sw= new java.io.StringWriter(1024);
java.io.PrintWriter pw= new java.io.PrintWriter(sw);
java.io.StringWriter sw= new java.io.StringWriter(1024);
java.io.PrintWriter pw= new java.io.PrintWriter(sw);
t.printStackTrace(pw);
pw.close();
buf.append(sw.toString());
}
// print to System.err
// Print to System.err
System.err.println(buf.toString());
}
@@ -389,7 +389,7 @@ public class SimpleLog implements Log, Serializable {
/**
* <p> Log a message with debug log level.</p>
* <p> Log a message with trace log level.</p>
*/
public final void trace(Object message) {
@@ -400,7 +400,7 @@ public class SimpleLog implements Log, Serializable {
/**
* <p> Log an error with debug log level.</p>
* <p> Log an error with trace log level.</p>
*/
public final void trace(Object message, Throwable t) {
@@ -579,7 +579,7 @@ public class SimpleLog implements Log, Serializable {
/**
* Return the thread context class loader if available.
* Otherwise return null.
*
*
* The thread context class loader is available for JDK 1.2
* or later, if certain security conditions are met.
*
@@ -594,7 +594,7 @@ public class SimpleLog implements Log, Serializable {
try {
// Are we running on a JDK 1.2 or later system?
Method method = Thread.class.getMethod("getContextClassLoader", null);
// Get the thread context class loader (if there is one)
try {
classLoader = (ClassLoader)method.invoke(Thread.currentThread(), null);
@@ -605,12 +605,12 @@ public class SimpleLog implements Log, Serializable {
* InvocationTargetException is thrown by 'invoke' when
* the method being invoked (getContextClassLoader) throws
* an exception.
*
*
* getContextClassLoader() throws SecurityException when
* the context class loader isn't an ancestor of the
* calling class's class loader, or if security
* permissions are restricted.
*
*
* In the first case (not related), we want to ignore and
* keep going. We cannot help but also ignore the second
* with the logic below, but other calls elsewhere (to
@@ -631,7 +631,7 @@ public class SimpleLog implements Log, Serializable {
; // ignore
}
}
if (classLoader == null) {
classLoader = SimpleLog.class.getClassLoader();
}
@@ -639,7 +639,7 @@ public class SimpleLog implements Log, Serializable {
// Return the selected class loader
return classLoader;
}
private static InputStream getResourceAsStream(final String name)
{
return (InputStream)AccessController.doPrivileged(